Changeset 49183 for trunk/src/wp-includes/user.php

Timestamp:

10/17/2020 04:03:58 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Fix and upgrade various object docblock notations.

See #50768

File:

• trunk/src/wp-includes/user.php (modified) (3 diffs)

trunk/src/wp-includes/user.php

@@ -763 +763 @@
  * @param bool $all     Whether to retrieve all sites, or only sites that are not
  *                      marked as deleted, archived, or spam.
- * @return array A list of the user's sites. An empty array if the user doesn't exist
- *               or belongs to no sites.
+ * @return object[] A list of the user's sites. An empty array if the user doesn't exist
+ *                  or belongs to no sites.
  */
 function get_blogs_of_user( $user_id, $all = false ) {
@@ -784 +784 @@
          * @since 4.6.0
          *
-         * @param null|array $sites   An array of site objects of which the user is a member.
-         * @param int        $user_id User ID.
-         * @param bool       $all     Whether the returned array should contain all sites, including
-         *                            those marked 'deleted', 'archived', or 'spam'. Default false.
+         * @param null|object[] $sites   An array of site objects of which the user is a member.
+         * @param int           $user_id User ID.
+         * @param bool          $all     Whether the returned array should contain all sites, including
+         *                               those marked 'deleted', 'archived', or 'spam'. Default false.
          */
         $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
@@ -876 +876 @@
          * @since MU (3.0.0)
          *
-         * @param array $sites   An array of site objects belonging to the user.
-         * @param int   $user_id User ID.
-         * @param bool  $all     Whether the returned sites array should contain all sites, including
-         *                       those marked 'deleted', 'archived', or 'spam'. Default false.
+         * @param object[] $sites   An array of site objects belonging to the user.
+         * @param int      $user_id User ID.
+         * @param bool     $all     Whether the returned sites array should contain all sites, including
+         *                          those marked 'deleted', 'archived', or 'spam'. Default false.
          */
         return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );