Add guideline that hooks should not begin with the word hook_

What text would you add do that page? Can we create a merge request? I think this makes sense to change, having hooks that start with hook should probably be reserved only for hook altering hooks. Would this change break anything in drupal core currently?

How does this fit with the existing section in core.api.php about naming a hook?

 * @section defining Defining a hook
 *
 * To define a hook:
 * - Choose a unique name for your hook. It should start with "hook_", followed
 *   by your module's short name.
 * - Provide documentation in a *.api.php file in your module's main
 *   directory. See the "implementing" section above for details of what this
 *   should contain (parameters, return value, and sample function body).
 * - Invoke the hook in your module's code.

I think #3 is wrong, it should NOT start with `hook_` but instead with the module short name?

Well, the dummy function you write for documenting the hook does start with hook_ and you then also call it hook_something() when referring to it in doc comments etc. It’s just that the machine name of the hook then does not include this hook_ prefix. Maybe that’s where the confusion comes from? It’s really not very consistent.

For instance:

I node.api.php:

/**
 * Inform the node access system what permissions the user has.
 *
 * …
 */
function hook_node_grants(AccountInterface $account, $operation): array {
  // …
}

In some other module’s Hook service:

  /**
   * Implements hook_node_grants().
   */
  #[Hook('node_grants')]
  public function nodeGrants($account, $operation): array {
    // …
  }

So, is the hook’s name hook_node_grants or node_grants? Completely open to interpretation, I’d say.

I think the current rule is already what we want: The “machine name” of the hook, i.e., the string that goes inside #[Hook('…')], should always start with the defining module’s short name. And for documenting the hook, the current standard is to prefix that machine name with the prefix hook_ and define a function by that name, so all hooks can be found by searching for functions starting with hook_ (or hook_MODULE_ for a specific module). When referring to the hook in comments, we also use that prefixed name so that you can quickly get to the definition.

We maybe just need to explain this distinction, and thereby the current standard, more clearly? What we of course do not want is for the string inside #[Hook('…')] to start with hook_ for any hooks not defined by Core.

If we add a coding standard for this, especially one enforced with Coder (etc.), it will definitely need an exemption for Core.

The documentation you see in *.api.php e.g. node.api.php is just documentation, those are not affected by the coder rule. I

@nicxvan, are you referring to a specific coder rule?

Can someone make an MR to discuss?

Thanks,, then core needs an issue to implement that sniff.