From bdaca9bffcf4753637b55a71ad03f235f9cbbe87 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Fri, 7 May 2021 20:16:00 +0000 Subject: [PATCH] Docs: Miscellaneous docblock updates. See #52628 Built from https://develop.svn.wordpress.org/trunk@50828 git-svn-id: http://core.svn.wordpress.org/trunk@50437 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/class-automatic-upgrader-skin.php | 2 +- wp-includes/nav-menu.php | 10 +++++----- wp-includes/taxonomy.php | 2 +- wp-includes/version.php | 2 +- wp-signup.php | 8 ++++++-- 5 files changed, 14 insertions(+), 10 deletions(-) diff --git a/wp-admin/includes/class-automatic-upgrader-skin.php b/wp-admin/includes/class-automatic-upgrader-skin.php index 1835b3952c..686f95dd84 100644 --- a/wp-admin/includes/class-automatic-upgrader-skin.php +++ b/wp-admin/includes/class-automatic-upgrader-skin.php @@ -56,7 +56,7 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { * * @since 3.7.0 * - * @return array Messages during an upgrade. + * @return string[] Messages during an upgrade. */ public function get_upgrade_messages() { return $this->messages; diff --git a/wp-includes/nav-menu.php b/wp-includes/nav-menu.php index 50f43f955d..df10ffc45b 100644 --- a/wp-includes/nav-menu.php +++ b/wp-includes/nav-menu.php @@ -85,7 +85,7 @@ function is_nav_menu( $menu ) { * * @global array $_wp_registered_nav_menus * - * @param array $locations Associative array of menu location identifiers (like a slug) and descriptive text. + * @param string[] $locations Associative array of menu location identifiers (like a slug) and descriptive text. */ function register_nav_menus( $locations = array() ) { global $_wp_registered_nav_menus; @@ -143,7 +143,8 @@ function register_nav_menu( $location, $description ) { * * @global array $_wp_registered_nav_menus * - * @return array Registered navigation menu locations. If none are registered, an empty array. + * @return string[] Associative array of egistered navigation menu descriptions keyed + * by their location. If none are registered, an empty array. */ function get_registered_nav_menus() { global $_wp_registered_nav_menus; @@ -158,10 +159,9 @@ function get_registered_nav_menus() { * * @since 3.0.0 * - * @return array Registered navigation menu locations and the menus assigned them. - * If none are registered, an empty array. + * @return int[] Associative array of egistered navigation menu IDs keyed by their + * location name. If none are registered, an empty array. */ - function get_nav_menu_locations() { $locations = get_theme_mod( 'nav_menu_locations' ); return ( is_array( $locations ) ) ? $locations : array(); diff --git a/wp-includes/taxonomy.php b/wp-includes/taxonomy.php index 94d894e442..1de90cf877 100644 --- a/wp-includes/taxonomy.php +++ b/wp-includes/taxonomy.php @@ -2769,7 +2769,7 @@ function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) { * @since 2.8.0 * * @param int $object_id Object ID. - * @param array $terms An array of object terms. + * @param array $terms An array of object term IDs or slugs. * @param array $tt_ids An array of term taxonomy IDs. * @param string $taxonomy Taxonomy slug. * @param bool $append Whether to append new terms to the old terms. diff --git a/wp-includes/version.php b/wp-includes/version.php index 9c8c825fff..81bd030832 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.8-alpha-50827'; +$wp_version = '5.8-alpha-50828'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-signup.php b/wp-signup.php index 8e73e6aedd..cbc4ddb402 100644 --- a/wp-signup.php +++ b/wp-signup.php @@ -229,6 +229,7 @@ function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) { * @since MU (3.0.0) * * @return array Contains the new site data and error messages. + * See wpmu_validate_blog_signup() for details. */ function validate_blog_form() { $user = ''; @@ -292,6 +293,7 @@ function show_user_form( $user_name = '', $user_email = '', $errors = '' ) { * @since MU (3.0.0) * * @return array Contains username, email, and error messages. + * See wpmu_validate_user_signup() for details. */ function validate_user_form() { return wpmu_validate_user_signup( $_POST['user_name'], $_POST['user_email'] ); @@ -861,7 +863,8 @@ function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $use * * @see get_available_languages() * - * @return array List of available languages. + * @return string[] Array of available language codes. Language codes are formed by + * stripping the .mo extension from the language file names. */ function signup_get_available_languages() { /** @@ -874,7 +877,8 @@ function signup_get_available_languages() { * * @since 4.4.0 * - * @param array $available_languages Available languages. + * @param string[] $languages Array of available language codes. Language codes are formed by + * stripping the .mo extension from the language file names. */ $languages = (array) apply_filters( 'signup_get_available_languages', get_available_languages() );