When implementing a hook following the hook_foo_BAR_ID_bar() pattern, the following formats are allowed (at least for D7):
* Implements hook_foo_BAR_ID_bar() for xyz_bar().* Implements hook_foo_BAR_ID_bar() for xyz-bar.html.twig.* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.For some hooks I think this can look misleading as in the following examples:
/**
* Implements hook_ENTITY_TYPE_load() for node().
*/
/**
* Implements hook_feeds_PLUGIN_TYPE_config_defaults() for parser().
*/
The enforcement on ending the item reference with parentheses, implies that the referenced item is a function, which in the above two examples it is not.
While working on improving the coding standards for the D7 version of Feeds, I got warned about a coding standards violation for the following piece of code:
/**
* Implements hook_features_pipe_COMPONENT_alter() for 'feeds_importer'.
*
* Automatically adds dependencies when a Feed importer is selected in Features.
*/See https://www.drupal.org/pift-ci-job/824119 →
I therefore propose to also allow this format:
* Implements hook_foo_BAR_ID_bar() for 'xyz_bar'.
Its use however MUST be limited to items that are not a function nor a template.
I've been looking for existing issues to find out if there maybe is a specific reason for why the proposed format would not be allowed, but I couldn't find one so far. What I did find:
I saw that D8 core already uses this format and also similar formats.
/**
* Implements hook_ENTITY_TYPE_update() for 'field_storage_config'.
*
* Reset the field handler settings, when the storage target_type is changed on
* an entity reference field.
*//**
* Implements hook_ENTITY_TYPE_delete() for 'configurable_language'.
*
* Delete the potential block visibility settings of the deleted language.
*/Other formats used in core:
/**
* Implements hook_ENTITY_TYPE_delete() for menu entities.
*//**
* Implements hook_ENTITY_TYPE_predelete() for user entities.
*/Postponed: needs info
Coding Standards
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.
As the issue summary states the format proposed is allowed in Drupal 8+. Drupal core is using Drupal.Commenting.HookComment, so is there anything to do here or is this outdated?
It looks like that this issue applied to coding standards for D7 only, so I think that it is outdated.