[wp-trac] [WordPress Trac] #25434: Hook Docs: wp-admin/edit-form-advanced.php

[WordPress Trac]

#25434: Hook Docs: wp-admin/edit-form-advanced.php
--------------------------+------------------------------
 Reporter:  ericlewis     |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by DrewAPicture):

 * keywords:  has-patch => needs-patch
 * type:  enhancement => defect (bug)


Comment:

 Notes on [attachment:25434.1.diff]:
 Overall:
 * Looks like you've got the parameter types and variables switched in
 almost all of these. It should go:
 {{{
 * @param type $variable Description.
 }}}


 `post_updated_messages` filter:
 * Since the array keys are indexes, unfortunately it won't really be ideal
 to document the array of messages in hash notation. However, I would like
 to document (in a basic way) each of the indexes in the messages array,
 perhaps in a long description.

 `dbx_post_advanced` hook:
 * The short description seems incorrect, especially since the hook fires
 in the middle of meta boxes being added. What's the history of this hook?
 And what's with the naming scheme?

 `add_meta_boxes_{$post_type}` hook:
 * The dynamic part of the hook name should be spelled out in a long
 description.
 * `$post_type` is part of the hook name, not a parameter

 `do_meta_boxes` hook:
 * s/After/Fires after
 * Since this hook is fired three times in a row, the various contexts
 should be spelled out in a long description.

 `edit_form_top` hook:
 * "Fires at the."

 `enter_title_here` filter:
 * Specify the default placeholder text at the end of the parameter
 description.

 `submitpage_box`, `submitpost_box` hooks:
 * Based on the naming of the hook, we should probably mention that this
 hook firing as something to do with the submitpage|post box.

 `edit_page_form`, `edit_form_advanced` hooks:
 * Why only specify "after" 'normal' context when it's also ''before''
 "advanced" context?

--
Ticket URL: <http://core.trac.wordpress.org/ticket/25434#comment:6>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software