Update hook_pathauto_pattern_alter() documentation

Do we even invoke the hook at the moment? There's another issue about hooks not being invoked..

Thanks for your patch. I'll set it back to needs work. The updated example looks good at a first glance (didn't test it), but while you're at it, the DocBlock of the hook should also be updated. E.g. the $pattern parameter is no longer a string, but a \Drupal\pathauto\PathautoPatternInterface and there might as well be changes in the context variable.

> Do we even invoke the hook at the moment? There's another issue about hooks not being invoked..

It has been a few days, so it might have been fixed in the meantime. From looking at the source code, the hook is indeed invoked in \Drupal\pathauto\PathautoGenerator::createEntityAlias(), although there is a // @todo Is still hook still useful? directly above it.

I have updated the patch to mention PathautoPatternInterface usage.

The Pathauto pattern entity which need its patter to be modified using.

spelling mistake written patter instead of pattern

Here is the updated patch and interdiff.txt

Comment #3 says "Do we even invoke the hook at the moment? There's another issue about hooks not being invoked.."

Is there a link to this issue? Tanks.

#8 patch looks good to me.

On patch #8, if I'm not mistaken the type specifier in the @param annotation is generally the fully qualified class name with namespace.

1. +++ b/pathauto.api.php
   @@ -93,9 +94,9 @@ function hook_pathauto_is_alias_reserved($alias, $source, $langcode) {
   + * @param PathautoPatternInterface $pattern
   + *   The Pathauto pattern entity which need its pattern to be modified using
   + *   setPattern() method.
   

   Updated to the fully qualified namespace to match Drupal coding standards.

2. +++ b/pathauto.api.php
   @@ -107,10 +108,10 @@ function hook_pathauto_is_alias_reserved($alias, $source, $langcode) {
   +function hook_pathauto_pattern_alter(PathautoPatternInterface $pattern, array $context) {
   

   *.api.php files use fully qualified namespace arguments, see for example http://cgit.drupalcode.org/drupal/tree/core/modules/media/media.api.php

3. Closed #2904456: Wrong documentation in hook_pathauto_pattern_alter as a duplicate and updated suggested issue credit in the issue summary.

Thanks, committed.

PS: issue credit these days is mostly about the issue metadata not the commit message. Just list the users to be added additionally, then I can add them .