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
This commit is contained in:
John Blackbourn 2021-05-07 20:16:00 +00:00
parent 03dc655612
commit bdaca9bffc
5 changed files with 14 additions and 10 deletions

View File

@ -56,7 +56,7 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
* *
* @since 3.7.0 * @since 3.7.0
* *
* @return array Messages during an upgrade. * @return string[] Messages during an upgrade.
*/ */
public function get_upgrade_messages() { public function get_upgrade_messages() {
return $this->messages; return $this->messages;

View File

@ -85,7 +85,7 @@ function is_nav_menu( $menu ) {
* *
* @global array $_wp_registered_nav_menus * @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() ) { function register_nav_menus( $locations = array() ) {
global $_wp_registered_nav_menus; global $_wp_registered_nav_menus;
@ -143,7 +143,8 @@ function register_nav_menu( $location, $description ) {
* *
* @global array $_wp_registered_nav_menus * @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() { function get_registered_nav_menus() {
global $_wp_registered_nav_menus; global $_wp_registered_nav_menus;
@ -158,10 +159,9 @@ function get_registered_nav_menus() {
* *
* @since 3.0.0 * @since 3.0.0
* *
* @return array Registered navigation menu locations and the menus assigned them. * @return int[] Associative array of egistered navigation menu IDs keyed by their
* If none are registered, an empty array. * location name. If none are registered, an empty array.
*/ */
function get_nav_menu_locations() { function get_nav_menu_locations() {
$locations = get_theme_mod( 'nav_menu_locations' ); $locations = get_theme_mod( 'nav_menu_locations' );
return ( is_array( $locations ) ) ? $locations : array(); return ( is_array( $locations ) ) ? $locations : array();

View File

@ -2769,7 +2769,7 @@ function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
* @since 2.8.0 * @since 2.8.0
* *
* @param int $object_id Object ID. * @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 array $tt_ids An array of term taxonomy IDs.
* @param string $taxonomy Taxonomy slug. * @param string $taxonomy Taxonomy slug.
* @param bool $append Whether to append new terms to the old terms. * @param bool $append Whether to append new terms to the old terms.

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @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. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -229,6 +229,7 @@ function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) {
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @return array Contains the new site data and error messages. * @return array Contains the new site data and error messages.
* See wpmu_validate_blog_signup() for details.
*/ */
function validate_blog_form() { function validate_blog_form() {
$user = ''; $user = '';
@ -292,6 +293,7 @@ function show_user_form( $user_name = '', $user_email = '', $errors = '' ) {
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @return array Contains username, email, and error messages. * @return array Contains username, email, and error messages.
* See wpmu_validate_user_signup() for details.
*/ */
function validate_user_form() { function validate_user_form() {
return wpmu_validate_user_signup( $_POST['user_name'], $_POST['user_email'] ); 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() * @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() { function signup_get_available_languages() {
/** /**
@ -874,7 +877,8 @@ function signup_get_available_languages() {
* *
* @since 4.4.0 * @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() ); $languages = (array) apply_filters( 'signup_get_available_languages', get_available_languages() );