hook_ENTITY_TYPE_prepare_form() is not documented

Yes it is.

hook_ENTITY_TYPE_prepare_form()

If it's already documented on hook_ENTITY_TYPE_prepare_form(), do we need something else?

I could help.

I thought it was about the documentation of the hook_ENTITY_TYPE_prepare_form().

I fixed the documentation on the implementation of this hook.

Currently is only used on menu_ui and book module. The implementation on datetime module was removed on #2333353

To find the hook_node_prepare_form() I used (on the root of the drupal code):
fgrep -Hrn --color=always 'hook_node_prepare_form' .

But the one you suggest is useful also.

I can add that for all hook_ENTITY_TYPE_* hooks.

This hook found in book and menu_ui modules, not in datetime. Please review update patch that contains following doc.

+ * Implements hook_ENTITY_TYPE_prepare_form() for node entities.

I checked all the ENTITY_TYPE hook implementations and added the proper entity on the doc blocks.

Checked through all ENTITY_TYPE hook implementations and all appear correct. Marking RBTC.

Seems that the testbot tested the patch against a revision with many changes. I created another one and I tested just in case:

$ git reset --hard HEAD
$ git apply --check d8-fix-documentation-hook-entities-implementation-2331783-17.patch
$

It should apply the patch without problem.

I will test this

==> Sorry, but the patch doesn't work for me : it does not apply successfully on all modules :

 patch -p1<d8-fix-documentation-hook-entities-implementation-2331783-17.patch
patching file core/modules/block/block.module
Hunk #1 succeeded at 308 (offset -10 lines).
patching file core/modules/book/book.module
Hunk #1 succeeded at 294 (offset -15 lines).
patching file core/modules/comment/comment.module
Hunk #1 FAILED at 139.
Hunk #2 FAILED at 160.
Hunk #4 FAILED at 184.
3 out of 4 hunks FAILED -- saving rejects to file core/modules/comment/comment.module.rej
patching file core/modules/config/tests/config_entity_static_cache_test/config_entity_static_cache_test.module
patching file core/modules/config/tests/config_test/config_test.module
patching file core/modules/entity_reference/entity_reference.module
patching file core/modules/image/image.module
Hunk #1 succeeded at 367 (offset -14 lines).
Hunk #2 FAILED at 407.
Hunk #3 succeeded at 445 (offset -14 lines).
Hunk #4 FAILED at 461.
2 out of 4 hunks FAILED -- saving rejects to file core/modules/image/image.module.rej
patching file core/modules/language/language.module
Hunk #1 succeeded at 431 with fuzz 1 (offset -78 lines).
Hunk #2 succeeded at 445 (offset -78 lines).
patching file core/modules/locale/locale.module
Hunk #1 succeeded at 212 (offset -11 lines).
Hunk #2 succeeded at 223 (offset -11 lines).
Hunk #3 succeeded at 234 (offset -11 lines).
patching file core/modules/menu_ui/menu_ui.module
Hunk #1 succeeded at 155 (offset -11 lines).
Hunk #2 succeeded at 212 (offset -11 lines).
patching file core/modules/node/node.module
Hunk #1 succeeded at 1403 (offset -12 lines).
patching file core/modules/node/src/Tests/NodeEntityViewModeAlterTest.php
patching file core/modules/options/options.module
patching file core/modules/system/tests/modules/entity_test/entity_test.module
Hunk #1 succeeded at 306 (offset -14 lines).
Hunk #2 succeeded at 406 (offset -12 lines).
Hunk #3 succeeded at 482 (offset -8 lines).
Hunk #4 succeeded at 502 (offset -2 lines).
patching file core/modules/tour/tests/tour_test/tour_test.module
patching file core/modules/views/views.module
Hunk #1 FAILED at 476.
Hunk #2 FAILED at 484.
Hunk #3 FAILED at 492.
3 out of 3 hunks FAILED -- saving rejects to file core/modules/views/views.module.rej

Re-roll

Patch no longer applies.

+++ b/core/modules/config/tests/config_entity_static_cache_test/config_entity_static_cache_test.module
@@ -23,7 +23,7 @@ function config_entity_static_cache_test_config_test_load($entities) {
- * Implements hook_entity_type_alter().
+ * Implements hook_ENTITY_TYPE_load() for config_test entities.
  */
 function config_entity_static_cache_test_entity_type_alter(array &$entity_types) {

This looks like an incorrect change. hook_entity_type_alter() is a proper hook.

Also the scope of the patch and the issue summary / issue title are not aligned - please the issue summary and title.

Please review :)

+++ b/core/modules/config/tests/config_entity_static_cache_test/config_entity_static_cache_test.module
@@ -23,7 +23,7 @@ function config_entity_static_cache_test_config_test_load($entities) {
 /**
- * Implements hook_entity_type_alter().
+ * Implements hook_ENTITY_TYPE_alter() for config_test entities.
  */
 function config_entity_static_cache_test_entity_type_alter(array &$entity_types) {

The original documentation is correct. No change is necessary here.

I think #29 correctly addressed the comment from #27, but may have inadvertently included some other stuff in the patch file. I just re-rolled it, attached. I also read through all the changed comments and they look OK, and then I looked for missed places that might need changes with these commands:

grep -r hook_ENTITY_TYPE_ . | grep prepare_form

grep -r hook_ . | grep _prepare_form

I think this patch should pull everything above together.

#30 documents hook_node_prepare_form() in all places in the core.

The patch in #30 also does far more than documenting hook_node_prepare_form(). Either we should remove the out-of-scope changes or re-scope the issue summary and title.

Reroll

I looked at the patch in #33 and it seems to include some extraneous changes.

It also looks like some of the places that used to use hook_node_prepare_form() no longer do, for example in block and menu_ui. In fact it seems there is a single call left in code, in the book module. I am attaching a patch which addresses only that.

I have checked the code base and there is indeed only one implementation of hook_ENTITY_TYPE_prepare_form() in core and the patch from #35 fixes its docblock.

Thanks!

I think the correct documentation is Implements hook_ENTITY_TYPE_prepare_form() for node entities. as @andypost expressed in the IS.

#37 is correct.

Good!

+1

Changing the title to the right hook.

I noticed that it's also wrong for hook_ENTITY_TYPE_update in core/modules/ckeditor/ckeditor.module file. Is there a issue or should I open a follow-up?

New issue please, thanks! Maybe check to see if there are other spots?

Sorry, forgot to post the issue number here: #2472669: Complete documentation for every implementation of hook_ENTITY_TYPE_*

It's also RTBC ;)

Looks like Alex's feedback was addressed.

Committed and pushed to 8.0.x. Thanks!

oops.