WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#25443 closed defect (bug) (fixed)

Hook Docs: wp-admin/custom-header.php

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: 3.7 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch commit
Focuses: Cc:

Description

Patch forthcoming.

Attachments (2)

25443-custom-header.diff (2.5 KB) - added by gizburdt 7 years ago.
custom-header.php inline docs
25443.diff (2.6 KB) - added by DrewAPicture 7 years ago.

Download all attachments as: .zip

Change History (5)

@gizburdt
7 years ago

custom-header.php inline docs

#1 @DrewAPicture
7 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

Hi @gizburdt, thanks for the patch. Some notes on 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)

@DrewAPicture
7 years ago

#2 @DrewAPicture
7 years ago

  • Keywords has-patch commit added; needs-patch removed
  • Milestone changed from Awaiting Review to 3.7

#3 @DrewAPicture
7 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 25821:

Inline documentation for hooks in wp-admin/custom-header.php.

Props gizburdt for the initial patch.
Fixes #25443.

Note: See TracTickets for help on using tickets.