Changeset 52332 for trunk/src/wp-admin/includes/class-wp-users-list-table.php

Timestamp:

12/07/2021 12:18:50 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various inline documentation corrections and improvements.

See #53399

File:

• trunk/src/wp-admin/includes/class-wp-users-list-table.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-users-list-table.php

@@ -616 +616 @@
 
     /**
-     * Returns an array of user roles for a given user object.
+     * Returns an array of translated user role names for a given user object.
      *
      * @since 4.4.0
      *
      * @param WP_User $user_object The WP_User object.
-     * @return string[] An array of user roles.
+     * @return string[] An array of user role names keyed by role.
      */
     protected function get_role_list( $user_object ) {
@@ -639 +639 @@
 
         /**
-         * Filters the returned array of roles for a user.
+         * Filters the returned array of translated role names for a user.
          *
          * @since 4.4.0
          *
-         * @param string[] $role_list   An array of user roles.
+         * @param string[] $role_list   An array of translated user role names keyed by role.
          * @param WP_User  $user_object A WP_User object.
          */