[wp-trac] [WordPress Trac] #26869: Hook Docs completed files fixes

[WordPress Trac]

#26869: Hook Docs completed files fixes
----------------------------+-----------------------------
 Reporter:  DrewAPicture    |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  Future Release
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  docs
----------------------------+-----------------------------

Comment (by DrewAPicture):

 Added [attachment:load-back-compat.diff] which clarifies a comment on
 back-compat hooks of the load-* variety.

 Notes and todo items from @kpdesign's audit(s):

 Missing or incomplete docs for the following hooks:
 * `wp_header_image_attachment_metadata`
 * `wp_create_file_in_uploads` (duplicate)
 * Long description for `do_mu_upgrade filter` - "it is automatically
 fired" - what is fired?

 Suggested changes by file:

 wp-admin/includes/menu.php:
 * Fix erroneous phpdoc tag for 3 hooks: `_network_admin_menu`,
 `_user_admin_menu`, `_admin_menu`.

 wp-admin/includes/plugin-install.php:
 * Add missing docs variable for `plugins_api` hook.

 wp-admin/network/admin.php:
 * Fix incorrect docs variable for `redirect_network_admin_request` hook
 (copy/pasta error).

 wp-admin/options-discussion.php:
 * Change docs variable for `thread_comments_depth_max` hook to indicate
 what that number represents `$max_depth`.

 wp-admin/options-writing.php:
 * Fix short description and add missing docs variable for
 `enable_update_services_configuration` hook.

 wp-admin/options.php:
 * Fix short description and add missing docs variable for
 `enable_post_by_email_configuration` hook.

 wp-admin/user/admin.php:
 * Fix short description, remove long description for
 `redirect_user_admin_request` hook.

 wp-includes/class-wp-embed.php:
 * Add missing `@since` value for `embed_oembed_discover` hook.

 wp-includes/class-wp-xmlrpc-server.php:
 * Document `http_headers_useragent` hook, added in r27872 (other hook docs
 originally added in r27730).

 wp-includes/comment-template.php:
 * `get_comment_excerpt` missing docs
 * `pings_open` missing docs
 * `the_permalink` (twice as duplicates)
 * Add missing `@since` values for `comments_open` and `get_comments_link`
 hooks.

 wp-includes/l10n.php:
 * Fix duplicate hook lines for `locale` and `plugin_locale` hooks.
 * Fix typo in short description for `override_unload_textdomain` hook.
 * Add missing docs variables for `override_load_textdomain` and
 `override_unload_textdomain` hooks, fix alignment due to change.

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