[wp-trac] [WordPress Trac] #25443: Hook Docs: wp-admin/custom-header.php

[WordPress Trac]

#25443: Hook Docs: wp-admin/custom-header.php
--------------------------+------------------------------
 Reporter:  DrewAPicture  |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by DrewAPicture):

 * owner:   => DrewAPicture
 * status:  new => reviewing


Comment:

 Hi @gizburdt, thanks for the patch. Some notes on [attachment:25443
 -custom-header.diff]:
 Overall:
 * There should be a blank docblock line after the `@since` lines in all of
 thes docblocks.
 * All short descriptions and parameter descriptions should have ending
 periods.
 * Space out the the specific `do_action()` or `apply_filters()` lines per
 coding standards

 `custom_header_options` hook:
 * I think maybe focusing on the fact that this fires ''before'' the submit
 button rather than "at the end of the form" might be better

 `wp_create_file_in_uploads` hook:
 * "Fires just before step of of custom header is finished" is a little
 vague. Can you be more specific here?
 * The second instance of `wp_create_file_in_uploads` should be simple
 marked as `//duplicate_hook`
 * If there are multiple contexts of this filter being used, those contexts
 should be spelled out in a long (but not too long!) description in the
 main doc block.

 `wp_delete_file` hook:
 * Both instances should be marked `//duplicate_hook` (documented in a
 different file)

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