Make WordPress Core


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/update.php

    r50921 r51733  
    559559         * @since 2.8.0
    560560         *
    561          * @param array $plugin_data {
     561         * @param array  $plugin_data {
    562562         *     An array of plugin metadata.
    563563         *
     
    575575         *     @type bool   $update      Whether there's an available update. Default null.
    576576         * }
    577          * @param array $response {
    578          *     An array of metadata about the available plugin update.
     577         * @param object $response {
     578         *     An object of metadata about the available plugin update.
    579579         *
    580580         *     @type int    $id          Plugin ID.
Note: See TracChangeset for help on using the changeset viewer.