get_editable_roles(): array[]

Description

Return

array[]

Array of arrays containing role information.

Hooks fired · 1

One hook fires while get_editable_roles() runs, in this order:

1. 1
   apply_filters( editable_roles )filterline 284 (+10 into the body)

   Filters the list of editable roles.

Uses · 2

• wp_roles()Retrieves the global WP_Roles instance and instantiates it if necessary.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• WP_REST_Users_Controller::check_role_update()Determines if the current user is allowed to make the desired roles change.
• admin_created_user_email()
• edit_user()Edit user settings based on contents of $_POST
• wp_dropdown_roles()Prints out option HTML elements for role selectors.
• wp_ensure_editable_role()Stop execution if the role can not be assigned by the current user.

Source

View on Trac ↗View on GitHub ↗

274function get_editable_roles() {275	$all_roles = wp_roles()->roles;276 277	/**278	 * Filters the list of editable roles.279	 *280	 * @since 2.8.0281	 *282	 * @param array[] $all_roles Array of arrays containing role information.283	 */284	$editable_roles = apply_filters( 'editable_roles', $all_roles );285 286	return $editable_roles;287}

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.