WP_User::get_role_caps(): bool[]

Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.

Contents

Description

All of the capabilities of the user’s roles are merged with the user’s individual capabilities. This means that the user can be denied specific capabilities that their role might have, but the user is specifically denied.

Top ↑

Return

bool[] Array of key/value pairs where keys represent a capability name and boolean values represent whether the user has that capability.

Top ↑

Source

File: wp-includes/class-wp-user.php. View all references 

public function get_role_caps() {
	$switch_site = false;
	if ( is_multisite() && get_current_blog_id() !== $this->site_id ) {
		$switch_site = true;

		switch_to_blog( $this->site_id );
	}

	$wp_roles = wp_roles();

	// Filter out caps that are not role names and assign to $this->roles.
	if ( is_array( $this->caps ) ) {
		$this->roles = array_filter( array_keys( $this->caps ), array( $wp_roles, 'is_role' ) );
	}

	// Build $allcaps from role caps, overlay user's $caps.
	$this->allcaps = array();
	foreach ( (array) $this->roles as $role ) {
		$the_role      = $wp_roles->get_role( $role );
		$this->allcaps = array_merge( (array) $this->allcaps, (array) $the_role->capabilities );
	}
	$this->allcaps = array_merge( (array) $this->allcaps, (array) $this->caps );

	if ( $switch_site ) {
		restore_current_blog();
	}

	return $this->allcaps;
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_roles() wp-includes/capabilities.php

Retrieves the global WP_Roles instance and instantiates it if necessary.
WP_Roles::get_role() wp-includes/class-wp-roles.php

Retrieves a role object by name.
switch_to_blog() wp-includes/ms-blogs.php

Switches the current blog.
restore_current_blog() wp-includes/ms-blogs.php

Restores the current blog, after calling switch_to_blog() .
is_multisite() wp-includes/load.php

Determines whether Multisite is enabled.
get_current_blog_id() wp-includes/load.php

Retrieves the current site ID.
Show 2 more uses Hide more uses

Top ↑

Used By

Used By
Used By Description
WP_User::for_site() wp-includes/class-wp-user.php

Sets the site to operate on. Defaults to the current site.
WP_User::add_cap() wp-includes/class-wp-user.php

Adds capability and grant or deny access to capability.
WP_User::remove_cap() wp-includes/class-wp-user.php

Removes capability from user.
WP_User::remove_all_caps() wp-includes/class-wp-user.php

Removes all of the capabilities of the user.
WP_User::_init_caps() wp-includes/class-wp-user.php

Sets up capability object properties.
WP_User::add_role() wp-includes/class-wp-user.php

Adds role to user.
WP_User::remove_role() wp-includes/class-wp-user.php

Removes role from user.
WP_User::set_role() wp-includes/class-wp-user.php

Sets the role of the user.
Show 3 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by arnoutpullen —

    Code sample

    // Define user ID
$user_id = 1;

// Get User
$user = new WP_User( $user_id );

// Get all user capabilities
$user_roles = $user->get_role_caps();

// Check if user has permission
if ($user_roles['manage_options']) {
    // Do stuff
}

    Response sample

    array(10) {
    ["switch_themes"] => bool(false)
    ["edit_themes"] => bool(true)
    ["activate_plugins"] => bool(true)
    ["edit_plugins"] => bool(true)
    ["edit_users"] => bool(true)
    ["edit_files"] => bool(false)
    ["manage_options"] => bool(true)
    ["moderate_comments"] => bool(true)
    ["manage_categories"] => bool(true)
    ["manage_links"] => bool(false)
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Md Masud —

    In your plugin you can define to filter certain role and cap to do certain staff.

    const WPDOCS_ALLOWED_ROLE_FILE_CREATIONS = array( 'administrator', 'edit_plugins', 'manage_options' );

    So Filter When Necessary 

    $allowed = self::WPDOCS_ALLOWED_ROLE_FILE_CREATIONS;
$roles_caps = wp_get_current_user()->get_role_caps();
foreach ( $roles_caps as $role => $val ) {
	if ( in_array( $role, $allowed ) ) {
		if ( $val ) {
			// user permitted here
		}
	}
}

You must log in before being able to contribute a note or feedback.