Changeset 51733

Timestamp:

09/07/2021 12:53:35 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct documentation for the in_plugin_update_message-{$file} filter.

The $response parameter is an object, not an array.

This is a minor inconsistency with the corresponding in_theme_update_message-{$theme_key} action for themes, where the $response parameter is an array.

For backward compatibility, it is safer not to change the parameter type at this point, but to make sure the documentation is correct.

Follow-up to [11193], [16141], [26540].

Props davidmosterd, audrasjb, SergeyBiryukov.
See #40006.

File:

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

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

@@ -559 +559 @@
          * @since 2.8.0
          *
-         * @param array $plugin_data {
+         * @param array  $plugin_data {
          *     An array of plugin metadata.
          *
@@ -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.