Changeset 49693 for trunk/src/wp-includes/class-wp-user-query.php

Timestamp:

11/24/2020 09:25:46 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Upgrade more parameters in docblocks to used typed array notation.

See #51800, #41756

File:

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

trunk/src/wp-includes/class-wp-user-query.php

@@ -145 +145 @@
      *                                             to be included in results. Note that this is an inclusive list: users
      *                                             must match *each* role. Default empty.
-     *     @type array        $role__in            An array of role names. Matched users must have at least one of these
+     *     @type string[]     $role__in            An array of role names. Matched users must have at least one of these
      *                                             roles. Default empty array.
-     *     @type array        $role__not_in        An array of role names to exclude. Users matching one or more of these
+     *     @type string[]     $role__not_in        An array of role names to exclude. Users matching one or more of these
      *                                             roles will not be included in results. Default empty array.
      *     @type string       $meta_key            User meta key. Default empty.
@@ -160 +160 @@
      *                                             When `$search_columns` is left empty, it tries to determine which
      *                                             column to search in based on search string. Default empty.
-     *     @type array        $search_columns      Array of column names to be searched. Accepts 'ID', 'user_login',
+     *     @type string[]     $search_columns      Array of column names to be searched. Accepts 'ID', 'user_login',
      *                                             'user_email', 'user_url', 'user_nicename', 'display_name'.
      *                                             Default empty array.
@@ -198 +198 @@
      *                                             public post types.
      *     @type string       $nicename            The user nicename. Default empty.
-     *     @type array        $nicename__in        An array of nicenames to include. Users matching one of these
+     *     @type string[]     $nicename__in        An array of nicenames to include. Users matching one of these
      *                                             nicenames will be included in results. Default empty array.
-     *     @type array        $nicename__not_in    An array of nicenames to exclude. Users matching one of these
+     *     @type string[]     $nicename__not_in    An array of nicenames to exclude. Users matching one of these
      *                                             nicenames will not be included in results. Default empty array.
      *     @type string       $login               The user login. Default empty.
-     *     @type array        $login__in           An array of logins to include. Users matching one of these
+     *     @type string[]     $login__in           An array of logins to include. Users matching one of these
      *                                             logins will be included in results. Default empty array.
-     *     @type array        $login__not_in       An array of logins to exclude. Users matching one of these
+     *     @type string[]     $login__not_in       An array of logins to exclude. Users matching one of these
      *                                             logins will not be included in results. Default empty array.
      * }