[wp-trac] [WordPress Trac] #30558: Inline Docs: Fix mismatched hook docs

WordPress Trac noreply at wordpress.org
Sun Nov 30 21:29:58 UTC 2014


#30558: Inline Docs: Fix mismatched hook docs
--------------------------+-----------------------
 Reporter:  DrewAPicture  |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  4.1
Component:  General       |    Version:
 Severity:  normal        |   Keywords:  has-patch
  Focuses:  docs          |
--------------------------+-----------------------
 Background: Since phpDocumentor does not support parsing hook docs out of
 the box, the rule of thumb is that any DocBlock accompanying a hook must
 directly precede it with nothing in between. For some time now there have
 been several "problem hooks" showing incorrect docs in the Code Reference.

 For example, the docs being displayed for
 [https://developer.wordpress.org/reference/hooks/user_new_form_tag/
 user_new_form_tag] actually match the next hook in the file,
 [https://developer.wordpress.org/reference/hooks/user_new_form/
 user_new_form].

 Attached patch addresses the problem for the following hooks:

 * `admin_post_class`
 * `enter_title_here`
 * `manage_link_custom_column
 * `manage_media_custom_column
 * `the_title_rss`
 * `admin_xml_ns`
 * `user_edit_form_tag`
 * `admin_color_scheme_picker`
 * `user_new_form_tag`
 * `rss_update_period`
 * `rss_update_frequency`
 * `comment_form`

--
Ticket URL: <https://core.trac.wordpress.org/ticket/30558>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list