Changeset 52645

Timestamp:

01/27/2022 09:13:09 PM (3 years ago)

Author:

audrasjb

Message:

Docs: Fix incorrect type in translations_api and translations_api_result docblocks.

Before this changeset, translation_api and translation_api_result filters were incorrectly marked as taking object as their first argument. The correct type is an array as json_decode() is asked to return an associative array.

Props volodymyrkolesnykov.
Fixes #54959.

File:

• trunk/src/wp-admin/includes/translation-install.php (modified) (3 diffs)

trunk/src/wp-admin/includes/translation-install.php

@@ -15 +15 @@
  * @param string       $type Type of translations. Accepts 'plugins', 'themes', 'core'.
  * @param array|object $args Translation API arguments. Optional.
- * @return object|WP_Error On success an object of translations, WP_Error on failure.
+ * @return array|WP_Error On success an associative array of translations, WP_Error on failure.
  */
 function translations_api( $type, $args = null ) {
@@ -30 +30 @@
      * @since 4.0.0
      *
-     * @param false|object $result The result object. Default false.
-     * @param string       $type   The type of translations being requested.
-     * @param object       $args   Translation API arguments.
+     * @param false|array $result The result array. Default false.
+     * @param string      $type   The type of translations being requested.
+     * @param object      $args   Translation API arguments.
      */
     $res = apply_filters( 'translations_api', false, $type, $args );
@@ -103 +103 @@
      * @since 4.0.0
      *
-     * @param object|WP_Error $res  Response object or WP_Error.
-     * @param string          $type The type of translations being requested.
-     * @param object          $args Translation API arguments.
+     * @param array|WP_Error $res  Response as an associative array or WP_Error.
+     * @param string         $type The type of translations being requested.
+     * @param object         $args Translation API arguments.
      */
     return apply_filters( 'translations_api_result', $res, $type, $args );