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

[naomicbush]

Attached patch has docs for the filters

install_plugins_tabs
install_plugins_nonmenu_tabs
install_plugins_table_api_args_$tab
plugin_install_action_links

and actions

install_plugins_table_header

in wp-admin/includes/class-wp-plugin-install-list-table.php.

[DrewAPicture]

@naomicbush: It looks like you maybe forgot to attach your patch.

[naomicbush]

Sorry about that — I thought I needed to create the ticket first. Patch attached.

[naomicbush]

Using the correct patch naming convention

[DrewAPicture]

Hi Naomi, thanks for the patch :)

Some notes on 25357.diff​:

• install_plugins_tabs filter: "Filter the tabs that are shown on the page." needs to be more specific. It's best to document hooks as if they are independent of each other. So maybe, "Filter the tabs that are shown on the Plugin Install screen." For the @param description, maybe "An array of tabs used on the Plugin Install screen." or something
• install_plugins_nonmenu_tabs filter: "Filter the $nonmenu_tabs." isn't very helpful information. Perhaps something like "Filter tabs not associated with a menu item." Same for the @param description. I know it's copied from the function, but it's kind of vague and unhelpful. Try to be clear and direct.
• install_plugins_table_api_args_$tabs filter: "Plugin API" should be "Plugin Installer API", "the $tab." should be "each tab."
• install_plugins_table_header action: Again, think of all hooks as independent of each other, so you need to provide context in the description. "Fires before table header" should be "Fires before Plugin Install table header"
• plugin_install_action_links filter: "the plugin." should be generalized to "a plugin."

[naomicbush]

Revisions per DrewAPicture

[naomicbush]

Thanks, DrewAPicture, for the clarification :-) Patch revised.

[kpdesign]

Naomi, the patch looks good. :) Recommend commit.

[DrewAPicture]

In 25630:

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

Props naomicbush.
Fixes #25357.