[wp-trac] [WordPress Trac] #63648: Twenty Eleven to Twenty Fourteen: add PHPDoc blocks for footer action hooks (was: Missing PHPDoc block for the twentyfourteen_credits action hook in the Twenty Fourteen theme)

[WordPress Trac]

#63648: Twenty Eleven to Twenty Fourteen: add PHPDoc blocks for footer action hooks
---------------------------+------------------------------
 Reporter:  pmbaldha       |       Owner:  (none)
     Type:  defect (bug)   |      Status:  new
 Priority:  normal         |   Milestone:  Awaiting Review
Component:  Bundled Theme  |     Version:
 Severity:  normal         |  Resolution:
 Keywords:  has-patch      |     Focuses:  docs
---------------------------+------------------------------
Changes (by sabernhardt):

 * focuses:  coding-standards => docs


Old description:

> The Twenty Fourteen theme lacks a PHPDoc block for the
> twentyfourteen_credits action hook. For more information, refer to
> https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-
> content/themes/twentyfourteen/footer.php#L21.
>
> Please add the PHPDoc block for it as described on
> https://developer.wordpress.org/coding-standards/inline-documentation-
> standards/php/#4-hooks-actions-and-filters.

New description:

 Footer action hooks such as `twentyfourteen_credits` lack a PHPDoc block.

 - [https://github.com/WordPress/wordpress-develop/blob/6.8.1/src/wp-
 content/themes/twentyfourteen/footer.php#L21 twentyfourteen_credits]
 - [https://github.com/WordPress/wordpress-develop/blob/6.8.1/src/wp-
 content/themes/twentythirteen/footer.php#L18 twentythirteen_credits]
 - [https://github.com/WordPress/wordpress-develop/blob/6.8.1/src/wp-
 content/themes/twentytwelve/footer.php#L15 twentytwelve_credits]
 - [https://github.com/WordPress/wordpress-develop/blob/6.8.1/src/wp-
 content/themes/twentyeleven/footer.php#L28 twentyeleven_credits]

--

Comment:

 Pull requests [https://github.com/WordPress/wordpress-develop/pull/9172
 9172], [https://github.com/WordPress/wordpress-develop/pull/9173 9173],
 [https://github.com/WordPress/wordpress-develop/pull/9174 9174] and
 [https://github.com/WordPress/wordpress-develop/pull/9175 9175] follow the
 documentation example in Twenty Ten. However, that theme does not include
 a privacy link between the action and the credits.

 I think [https://github.com/WordPress/wordpress-develop/blob/6.8.1/src/wp-
 content/themes/twentyfifteen/footer.php#L17-L24 Twenty Fifteen] has a
 better example, both for the description and indentation.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/63648#comment:5>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform