wp_roles(): WP_Roles
- Since
- 4.3.0
- Source
wp-includes/capabilities.php:1078
Compatibility
- WordPress
- since 4.3.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
WP_Roles- WP_Roles global instance if not already instantiated.
Performance profile
How much work a call to wp_roles() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 4–7
- Plugin surface
- None
- Called by
- 14
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 7.
Nothing here hands control to plugin code.
14 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_roles() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 4–7 | none |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 7 instructions, 4–7 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- WP_Roles::__construct()Constructor.
Used by · 14
- WP_Role::add_cap()Assign role a capability.
- WP_Role::remove_cap()Removes a capability from a role.
- WP_User::get_role_caps()Retrieves all of the capabilities of the user's roles, and merges them with individual user capabilities.
- WP_Users_List_Table::get_role_list()Returns an array of translated user role names for a given user object.
- WP_Users_List_Table::get_views()Returns an associative array listing all the views that can be used with this table.
- add_role()Adds a role, if it does not exist.
- count_users()Counts number of users who have each of the user roles.
- edit_user()Edit user settings based on contents of $_POST
- get_editable_roles()Fetch a filtered list of user roles that the current user is allowed to edit.
- get_role()Retrieves role object.
- remove_role()Removes a role, if it exists.
- upgrade_440()Executes changes made in WordPress 4.4.0.
Show all 14
- wp_get_users_with_no_role()Gets the user IDs of all users with no role on this site.
- wp_switch_roles_and_user()Switches the initialized roles and current user capabilities to another site.
Source code
function wp_roles() { global $wp_roles; if ( ! isset( $wp_roles ) ) { $wp_roles = new WP_Roles(); } return $wp_roles;}Changelog
Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/capabilities.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.