Changeset 54287

Timestamp:

09/22/2022 11:11:45 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Use typed array notation for the $locales parameter in plugin update filters.

The value comes from get_available_languages(), which returns an array of strings.

This affects:

• plugins_update_check_locales filter.
• update_plugins_{$hostname} filter.

Follow-up to [36630], [46660], [50921], [53933], [54284].

See #55646.

File:

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

trunk/src/wp-includes/update.php

@@ -401 +401 @@
      * @since 4.5.0 The default value of the `$locales` parameter changed to include all locales.
      *
-     * @param array $locales Plugin locales. Default is all available locales of the site.
+     * @param string[] $locales Plugin locales. Default is all available locales of the site.
      */
     $locales = apply_filters( 'plugins_update_check_locales', $locales );
@@ -507 +507 @@
          * @param array       $plugin_data      Plugin headers.
          * @param string      $plugin_file      Plugin filename.
-         * @param array       $locales          Installed locales to look up translations for.
+         * @param string[]    $locales          Installed locales to look up translations for.
          */
         $update = apply_filters( "update_plugins_{$hostname}", false, $plugin_data, $plugin_file, $locales );