Add filter to modify description in plugin card

[afragen]

I've found it desirable to be able to modify the description of the plugin card in the plugin install list table.

If possible I would like to add a filter for this variable.

Add a filter to the plugin install list table to allow for modification of the plugin description in the plugin card.

Trac ticket: https://core.trac.wordpress.org/ticket/55480

🤦🏻‍♂️ thanks for the assist 🙏🏼

[SergeyBiryukov]

In 53074:

Plugins: Introduce the plugin_install_description filter.

This allows for modification of the plugin card description on the Add Plugins screen.

Use cases include displaying a list of dependencies for the ​Plugin Dependencies feature project (​GitHub).

Props afragen, davidbaumwald, peterwilsoncc, SergeyBiryukov.
Fixes #55480.

Thanks for the PR! Merged in https://core.trac.wordpress.org/changeset/53074.

[milana_cap]

Marking for Dev note but really just needs mentioning in Field guide.

[afragen]

@SergeyBiryukov I believe the reference for the @param $plugin is a reference to the output of a call to plugins_api() and not to the plugin_row_meta filter.

Thanks @pbiron

[pbiron]

Replying to afragen:

@SergeyBiryukov I believe the reference for the @param $plugin is a reference to the output of a call to plugins_api() and not to the plugin_row_meta filter.

Thanks @pbiron

To expand on the above: this is in reference to the description of that param in the DocBlock. The param that is passed to ​plugin_row_meta contains a number of properties about the plugin that are only set in WP_Plugin_List_Table::single_row() and would never be set in the param that is passed to plugin_install_description.

The same discrepancy also applies to DocBlock of the ​plugin_install_action_links which was modified in the commit for this new filter.

[SergeyBiryukov]

Replying to pbiron:

Replying to afragen:

I believe the reference for the @param $plugin is a reference to the output of a call to plugins_api() and not to the plugin_row_meta filter.

Thanks @pbiron

To expand on the above: this is in reference to the description of that param in the DocBlock. The param that is passed to ​plugin_row_meta contains a number of properties about the plugin that are only set in WP_Plugin_List_Table::single_row() and would never be set in the param that is passed to plugin_install_description.

Thanks! I think I went with a reference to plugin_row_meta because the plugins_api() DocBlock does not actually describe the structure of the returned array (as it depends on the arguments passed), and plugin_row_meta was the closest thing I could find. It looks like we could better document the plugins_api() response and link to that instead.

[afragen]

Closest would likely be the plugins_api_result filter and that's also sorta documented in plugins_api().

[pbiron]

Replying to SergeyBiryukov:

Thanks! I think I went with a reference to plugin_row_meta because the plugins_api() DocBlock does not actually describe the structure of the returned array (as it depends on the arguments passed), and plugin_row_meta was the closest thing I could find. It looks like we could better document the plugins_api() response and link to that instead.

Yeah, plugins_api() isn't documented very well, especially since the description of the return value says to see the Code Reference for the plugins_api() function :-)

[costdev]

Patch updated to change the @see reference to plugins_api.

I have also opened a follow-up ticket to handle the improvements in documentation for plugins_api(): #55645.

[costdev]

Change @see reference to plugins_api().

[peterwilsoncc]

In 53328:

Plugins: Improve plugin_install_description filter's docs.

Refer developers to plugins_api() for array of plugin data.

Props afragen, pbiron, SergeyBiryukov, costdev.
Fixes #55480.

[SergeyBiryukov]

In 53330:

Docs: Improve plugin_install_action_links filter's docs.

Refer developers to plugins_api() for array of plugin data.

Follow-up to [53074], [53328].

Props afragen, pbiron.
See #55480.

[sabernhardt]

Dev note:
​https://make.wordpress.org/core/2022/05/03/miscellaneous-dev-notes-for-wordpress-6-0/

[afragen]

#55479 was marked as a duplicate.