Docs: Various inline documentation corrections and improvements.

See #53399


git-svn-id: https://develop.svn.wordpress.org/trunk@52332 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2021-12-07 12:18:50 +00:00
parent bccb23ca03
commit ba518c2d86
38 changed files with 146 additions and 113 deletions
@@ -615,12 +615,12 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* 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 ) {
$wp_roles = wp_roles();
@@ -638,11 +638,11 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* 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.
*/
return apply_filters( 'get_role_list', $role_list, $user_object );