WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#26052 closed defect (bug) (fixed)

Hook Docs: wp-admin/includes/class-wp-links-list-table.php

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

Description

Attached patch has docs for the manage_link_custom_column action in wp-admin/includes/class-wp-links-list-table.php

Attachments (3)

wp-admin_includes_class-wp-links-list-table-php.diff (1.5 KB) - added by JoshuaAbenazer 6 years ago.
wp-admin_includes_class-wp-links-list-table-php-2.diff (1.1 KB) - added by JoshuaAbenazer 6 years ago.
Updated patch as per review.
26052.diff (771 bytes) - added by DrewAPicture 6 years ago.
tweaks from kpdesign

Download all attachments as: .zip

Change History (10)

#1 @kpdesign
6 years ago

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

#2 @kpdesign
6 years ago

  • Keywords needs-patch added; has-patch removed

@JoshuaAbenazer: Thanks for the patch. :)

Just a few things:

  • Rather than breaking up the existing line, insert the docblock just above it.
default:
	[insert doc block here]
	?>
	<td <?php echo $attributes ?>><?php do_action( 'manage_link_custom_column', $column_name, $link->link_id ); ?></td>
  • Use tabs to indent each line from the left gutter, and spaces inside the doc block.
  • Short description should be "Fires for each registered custom link column."
  • @since should be 2.1.0 (use the 3-digit version number).
  • There should be a period after the description in both @param lines.
  • Use a docs-specific variable for the link ID, such as $link_id.
  • Make sure there is no extra whitespace at the end of each line in the block.

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

#3 @JoshuaAbenazer
6 years ago

@kpdesign - Thanks for the review. Will make the changes in sometime.

#4 @JoshuaAbenazer
6 years ago

  • Keywords needs-patch removed

#5 @JoshuaAbenazer
6 years ago

  • Keywords has-patch added

@DrewAPicture
6 years ago

tweaks from kpdesign

#6 @DrewAPicture
6 years ago

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

26052.diff should do it. Thanks guys.

#7 @DrewAPicture
6 years ago

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

In 26340:

Inline documentation for hooks in wp-admin/includes/class-wp-links-list-table.php.

Props JoshuaAbenazer, kpdesign.
Fixes #26052.

Note: See TracTickets for help on using tickets.