Changeset 52224 for trunk/src/wp-admin/includes/update.php

Timestamp:

11/19/2021 10:15:26 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Restore [51733], accidentally reverted in [52212].

Document some more $response values in the in_plugin_update_message-{$file} filter:

• banners_rtl
• requires_php

Follow-up to [51733], [52212].

Fixes #40006.

File:

• trunk/src/wp-admin/includes/update.php (modified) (1 diff)

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

@@ -575 +575 @@
                  *     @type bool   $update      Whether there's an available update. Default null.
                  * }
-                 * @param array $response {
-                 *     An array of metadata about the available plugin update.
+                 * @param object $response {
+                 *     An object of metadata about the available plugin update.
                  *
-                 *     @type int    $id          Plugin ID.
-                 *     @type string $slug        Plugin slug.
-                 *     @type string $plugin      Plugin basename.
-                 *     @type string $url         Plugin URL.
-                 *     @type string $package     Plugin update package URL.
-                 *     @type array  $icons       An array of icon URLs.
-                 *     @type array  $banners     An array of banner URLs.
-                 *     @type string $requires    Specify the minimum required WordPress version.
-                 *     @type string $tested      Specify the latest version of WordPress that the plugin has been tested with.
-                 *     @type string $new_version Specify the new version of the plugin.
+                 *     @type int    $id           Plugin ID.
+                 *     @type string $slug         Plugin slug.
+                 *     @type string $plugin       Plugin basename.
+                 *     @type string $new_version  New plugin version.
+                 *     @type string $url          Plugin URL.
+                 *     @type string $package      Plugin update package URL.
+                 *     @type array  $icons        An array of plugin icon URLs.
+                 *     @type array  $banners      An array of plugin banner URLs.
+                 *     @type array  $banners_rtl  An array of plugin RTL banner URLs.
+                 *     @type string $requires     The version of WordPress which the plugin requires.
+                 *     @type string $tested       The version of WordPress the plugin is tested against.
+                 *     @type string $requires_php The version of PHP which the plugin requires.
                  * }
                  */