From 1356b77f56785cc537862aa338afbf9fac60542c Mon Sep 17 00:00:00 2001 From: Jb Audras Date: Thu, 27 Jan 2022 21:13:09 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@52645 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/translation-install.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/wp-admin/includes/translation-install.php b/src/wp-admin/includes/translation-install.php index 74681fb314..dc7cb89a05 100644 --- a/src/wp-admin/includes/translation-install.php +++ b/src/wp-admin/includes/translation-install.php @@ -14,7 +14,7 @@ * * @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 ) { // Include an unmodified $wp_version. @@ -29,9 +29,9 @@ function translations_api( $type, $args = null ) { * * @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 ); @@ -102,9 +102,9 @@ function translations_api( $type, $args = null ) { * * @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 ); }