Changeset 52227 for trunk/src/wp-admin/includes/plugin.php

Timestamp:

11/20/2021 02:21:15 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation for the $plugin_data parameter of various hooks:

• Document the structure of the $plugin_data array passed to the plugin_row_meta filter.
• Document some missing values returned by get_plugin_data():
  • PluginURI
  • AuthorName
• Link to get_plugin_data() and the plugin_row_meta filter as the canonical sources in other various filters and actions which receive the $plugin_data parameter:
  • network_admin_plugin_action_links
  • network_admin_plugin_action_links_{$plugin_file}
  • plugin_action_links
  • plugin_action_links_{$plugin_file}
  • plugin_auto_update_setting_html
  • manage_plugins_custom_column
  • after_plugin_row
  • after_plugin_row_{$plugin_file}
  • in_plugin_update_message-{$file}
• Update documentation for the $response parameter of the in_plugin_update_message-{$file} filter:
  • Correct type for the id value. It contains a string like w.org/plugins/[plugin-name], not a numeric ID.
  • Update $icons, $banners, and $banners_rtl values to use typed array notation.

Follow-up to [8367], [8402], [12976], [16758], [26540], [30544], [34818], [51733], [52212], [52224].

See #53399.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (2 diffs)

trunk/src/wp-admin/includes/plugin.php

@@ -55 +55 @@
  *
  *     @type string $Name        Name of the plugin. Should be unique.
- *     @type string $Title       Title of the plugin and link to the plugin's site (if set).
+ *     @type string $PluginURI   Plugin URI.
+ *     @type string $Version     Plugin version.
  *     @type string $Description Plugin description.
- *     @type string $Author      Author's name.
- *     @type string $AuthorURI   Author's website address (if set).
- *     @type string $Version     Plugin version.
+ *     @type string $Author      Plugin author's name.
+ *     @type string $AuthorURI   Plugin author's website address (if set).
  *     @type string $TextDomain  Plugin textdomain.
- *     @type string $DomainPath  Plugins relative directory path to .mo files.
+ *     @type string $DomainPath  Plugin's relative directory path to .mo files.
  *     @type bool   $Network     Whether the plugin can only be activated network-wide.
  *     @type string $RequiresWP  Minimum required version of WordPress.
  *     @type string $RequiresPHP Minimum required version of PHP.
  *     @type string $UpdateURI   ID of the plugin for update purposes, should be a URI.
+ *     @type string $Title       Title of the plugin and link to the plugin's site (if set).
+ *     @type string $AuthorName  Plugin author's name.
  * }
  */
@@ -130 +132 @@
  *                            Default true.
  * @param bool   $translate   Optional. If the returned data should be translated. Default true.
- * @return array {
- *     Plugin data. Values will be empty if not supplied by the plugin.
- *
- *     @type string $Name        Name of the plugin. Should be unique.
- *     @type string $Title       Title of the plugin and link to the plugin's site (if set).
- *     @type string $Description Plugin description.
- *     @type string $Author      Author's name.
- *     @type string $AuthorURI   Author's website address (if set).
- *     @type string $Version     Plugin version.
- *     @type string $TextDomain  Plugin textdomain.
- *     @type string $DomainPath  Plugins relative directory path to .mo files.
- *     @type bool   $Network     Whether the plugin can only be activated network-wide.
- * }
+ * @return array Plugin data. Values will be empty if not supplied by the plugin.
+ *               See get_plugin_data() for the list of possible values.
  */
 function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {