WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#25447 closed defect (bug) (fixed)

Hook Docs: wp-admin/edit-link-form.php

Reported by: Japh Owned by: kpdesign
Milestone: 3.8 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch commit
Focuses: Cc:

Description

Patch forthcoming.

Attachments (6)

25447.diff (2.4 KB) - added by raamdev 7 years ago.
25447.2.diff (1.2 KB) - added by raamdev 7 years ago.
25447.3.diff (1.2 KB) - added by raamdev 7 years ago.
Recreated the patch from the root directory
25447.4.diff (2.1 KB) - added by raamdev 7 years ago.
Updated patch with requested changes
25447.5.diff (1.8 KB) - added by raamdev 7 years ago.
Recreating patch as standalone patch
25447.6.diff (1.8 KB) - added by raamdev 7 years ago.

Download all attachments as: .zip

Change History (22)

#1 @kpdesign
7 years ago

  • Cc Japh added

Are you still working on this file?

#2 @DrewAPicture
7 years ago

Marking this file as available on the master list

@raamdev
7 years ago

#3 @raamdev
7 years ago

I'll take this. I've added a patch that includes inline docs for all do_action() hooks.

#4 @raamdev
7 years ago

  • Keywords has-patch added; needs-patch removed

#5 @raamdev
7 years ago

  • Cc raam@… added

@raamdev
7 years ago

@raamdev
7 years ago

Recreated the patch from the root directory

#6 @raamdev
7 years ago

I read in a comment in #25662 about the correct notation to use when documenting duplicate hooks. I've updated the patch to correctly point to wp-admin/edit-form-advanced.php where several hooks are duplicated (and already documented). I also updated the patch to use the --no-prefix option when running git diff. Let me know if anything else needs changing.

#7 @kpdesign
7 years ago

  • Cc Japh removed
  • Owner set to kpdesign
  • Status changed from new to reviewing

#8 @kpdesign
7 years ago

  • Keywords needs-patch added; has-patch removed

@raamdev: Thanks for the patch. :)

Just a few changes needed:

add_meta_boxes:

  • Remove the docblock and replace with: /** This action is documented in wp-admin/edit-form-advanced.php */
  • Space out the do_action line per the coding standards:
    do_action( 'add_meta_boxes', 'link', $link );
    

add_meta_boxes_link:

  • Change short description to: "Fires when link-specific meta boxes are added."
  • Only one blank space between object, $link, and the short description in @param line.
  • Change short description in @param line to "Link object."
  • Space out the do_action line per the coding standards.

do_meta_boxes:

  • Space out the do_action line per the coding standards in all 3 instances.

submitlink_box:

  • Change short description to: "Fires before the Save meta box in the sidebar."
  • Space out the do_action line per the coding standards.

Could you make these changes and submit a new patch please?

@raamdev
7 years ago

Updated patch with requested changes

#9 @raamdev
7 years ago

  • Keywords has-patch added; needs-patch removed

Added patch with requested changes. Thanks!

#10 @SergeyBiryukov
7 years ago

Looks like 25447.4.diff requires 25447.3.diff to be applied first. Could you re-create it as a standalone patch?

@raamdev
7 years ago

Recreating patch as standalone patch

#11 @raamdev
7 years ago

@SergeyBiryukov Whoops. I didn't realize that. I recreated 25447.5.diff from trunk.

#12 @raamdev
7 years ago

@SergeyBiryukov Ugh, scratch that. That patch is bad too. Give me a minute to fix that and upload a new one.

@raamdev
7 years ago

#13 @raamdev
7 years ago

@SergeyBiryukov OK, 25447.6.diff should be good.

#14 @SergeyBiryukov
7 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 3.8

#15 @kpdesign
7 years ago

@raamdev: Thanks for making the changes. :)

25447.6.diff looks good. +1 for commit.

#16 @SergeyBiryukov
7 years ago

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

In 26080:

Inline documentation for hooks in wp-admin/edit-link-form.php.

props raamdev.
fixes #25447.

Note: See TracTickets for help on using tickets.