WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 8 years ago

#26957 closed defect (bug) (fixed)

Hook Docs(9): wp-admin/includes/class-wp-plugins-list-table.php

Reported by: nicolealleyinteractivecom Owned by: DrewAPicture
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Plugins Keywords: has-patch commit
Focuses: docs Cc:

Description

Filter hooks:

  • all_plugins
  • show_advanced_plugins (x2)
  • $prefix_plugin_action_links
  • $prefix_plugin_action_links_$plugin_file
  • plugin_row_meta

Action hooks:

  • manage_plugins_custom_column
  • after_plugin_row
  • after_plugin_row_$plugin_file

Attachments (4)

class-wp-plugins-list-table.diff (6.1 KB) - added by nicole@… 8 years ago.
class-wp-plugins-list-table.2.diff (6.3 KB) - added by nicole@… 8 years ago.
26957.3.diff (7.4 KB) - added by kpdesign 8 years ago.
Third pass
26957.diff (7.3 KB) - added by DrewAPicture 8 years ago.
Final pass.

Download all attachments as: .zip

Change History (11)

#1 @nicole@…
8 years ago

  • Keywords has-patch added

#2 @DrewAPicture
8 years ago

  • Keywords needs-patch added; has-patch removed
  • Owner set to kpdesign
  • Reporter changed from nicole@… to nicolealleyinteractivecom
  • Status changed from new to reviewing

Hi, thanks for the patch. Here are some notes for a second round:

Overall:

  • All descriptions should end with periods.
  • Try to think of and document hooks as if they are being viewed independently of their surrounding code. This means that for each of the hooks in this file, we need to mention that they are fired or evaluate in the plugin list table and specifically where in the table, e.g. every row, after every row, for every custom column, etc.
  • Double check all @since versions for accuracy.

all_plugins filter:

  • Pretty sure the @since version is actually 3.0.0
  • Can probably just refer to them as "plugins" here, and the description needs to be more specific, see the overall notes.
  • The second line of the parameter description should be be aligned with the first letter of the description on the first line

show_advanced_plugins filter:

  • The description on the boolean parameter is missing.

plugin_action_links filter:

  • Description needs a period.
  • Remove the underscore in plugin_data in the $plugin_data description.

$prefix . "plugin_action_links_$plugin_file filter:

  • The long description should be two sentences -- the first about the $prefix portion of the hook name, the second about the $plugin_file portion.

plugin_row_meta filter:

  • Description needs a period.
  • Remove underscore in plugin_data in $plugin_data description

manage_plugins_custom_column hook:

  • Remove the underscore in plugin_data.

#3 @nicole@…
8 years ago

For the @since, the inline docs posts says the "recommended tool to use when searching for the version something was added to WordPress is svn blame."

The svn blame page states "To find out when a piece of code was released, look at the associated revision number and find the next highest revision number on the WordPress tags browser."

Svn blame for trunk/src/wp-admin/includes/class-wp-plugins-list-table.php shows a revision number of 15491 for line 44. This revision number places it in the 3.0.2 version according to the tags browser.

If this is incorrect, please provide correct instructions for determining the @since version.

#4 @nicole@…
8 years ago

  • Keywords has-patch added; needs-patch removed

@kpdesign
8 years ago

Third pass

#5 @kpdesign
8 years ago

  • Owner changed from kpdesign to DrewAPicture

26957.3.diff contains changes to descriptions/etc. for consistency, fixes some @since values.

This needs a final review and a recommendation.

@DrewAPicture
8 years ago

Final pass.

#6 @DrewAPicture
8 years ago

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

26957.diff should do it.

#7 @DrewAPicture
8 years ago

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

In 27356:

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

Props nicolealleyinteractivecom, kpdesign.
Fixes #26957.

Note: See TracTickets for help on using tickets.