Changeset 50828

Timestamp:

05/07/2021 08:14:22 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock updates.

See #52628

Location:

trunk/src

Files:

• wp-admin/includes/class-automatic-upgrader-skin.php (modified) (1 diff)
• wp-includes/nav-menu.php (modified) (3 diffs)
• wp-includes/taxonomy.php (modified) (1 diff)
• wp-signup.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php

@@ -57 +57 @@
      * @since 3.7.0
      *
-     * @return array Messages during an upgrade.
+     * @return string[] Messages during an upgrade.
      */
     public function get_upgrade_messages() {

trunk/src/wp-includes/nav-menu.php

@@ -86 +86 @@
  * @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() ) {
@@ -144 +144 @@
  * @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() {
@@ -159 +160 @@
  * @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' );

trunk/src/wp-includes/taxonomy.php

@@ -2770 +2770 @@
      *
      * @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.

trunk/src/wp-signup.php

@@ -230 +230 @@
  *
  * @return array Contains the new site data and error messages.
+ *               See wpmu_validate_blog_signup() for details.
  */
 function validate_blog_form() {
@@ -293 +294 @@
  *
  * @return array Contains username, email, and error messages.
+ *               See wpmu_validate_user_signup() for details.
  */
 function validate_user_form() {
@@ -862 +864 @@
  * @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() {
@@ -875 +878 @@
      * @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() );