Edit File by line

* @since 2.0.0

[500] Fix | Delete

[501] Fix | Delete

* @return bool[] Array of key/value pairs where keys represent a capability name

[502] Fix | Delete

* and boolean values represent whether the user has that capability.

[503] Fix | Delete

[504] Fix | Delete

public function get_role_caps() {

[505] Fix | Delete

$switch_site = false;

[506] Fix | Delete

if ( is_multisite() && get_current_blog_id() !== $this->site_id ) {

[507] Fix | Delete

$switch_site = true;

[508] Fix | Delete

[509] Fix | Delete

switch_to_blog( $this->site_id );

[510] Fix | Delete

}

[511] Fix | Delete

[512] Fix | Delete

$wp_roles = wp_roles();

[513] Fix | Delete

[514] Fix | Delete

// Filter out caps that are not role names and assign to $this->roles.

[515] Fix | Delete

if ( is_array( $this->caps ) ) {

[516] Fix | Delete

$this->roles = array_filter( array_keys( $this->caps ), array( $wp_roles, 'is_role' ) );

[517] Fix | Delete

}

[518] Fix | Delete

[519] Fix | Delete

// Build $allcaps from role caps, overlay user's $caps.

[520] Fix | Delete

$this->allcaps = array();

[521] Fix | Delete

foreach ( (array) $this->roles as $role ) {

[522] Fix | Delete

$the_role = $wp_roles->get_role( $role );

[523] Fix | Delete

$this->allcaps = array_merge( (array) $this->allcaps, (array) $the_role->capabilities );

[524] Fix | Delete

}

[525] Fix | Delete

$this->allcaps = array_merge( (array) $this->allcaps, (array) $this->caps );

[526] Fix | Delete

[527] Fix | Delete

if ( $switch_site ) {

[528] Fix | Delete

restore_current_blog();

[529] Fix | Delete

}

[530] Fix | Delete

[531] Fix | Delete

return $this->allcaps;

[532] Fix | Delete

}

[533] Fix | Delete

[534] Fix | Delete

/**

[535] Fix | Delete

* Adds role to user.

[536] Fix | Delete

[537] Fix | Delete

* Updates the user's meta data option with capabilities and roles.

[538] Fix | Delete

[539] Fix | Delete

* @since 2.0.0

[540] Fix | Delete

[541] Fix | Delete

* @param string $role Role name.

[542] Fix | Delete

[543] Fix | Delete

public function add_role( $role ) {

[544] Fix | Delete

if ( empty( $role ) ) {

[545] Fix | Delete

return;

[546] Fix | Delete

}

[547] Fix | Delete

[548] Fix | Delete

if ( in_array( $role, $this->roles, true ) ) {

[549] Fix | Delete

return;

[550] Fix | Delete

}

[551] Fix | Delete

[552] Fix | Delete

$this->caps[ $role ] = true;

[553] Fix | Delete

update_user_meta( $this->ID, $this->cap_key, $this->caps );

[554] Fix | Delete

$this->get_role_caps();

[555] Fix | Delete

$this->update_user_level_from_caps();

[556] Fix | Delete

[557] Fix | Delete

/**

[558] Fix | Delete

* Fires immediately after the user has been given a new role.

[559] Fix | Delete

[560] Fix | Delete

* @since 4.3.0

[561] Fix | Delete

[562] Fix | Delete

* @param int $user_id The user ID.

[563] Fix | Delete

* @param string $role The new role.

[564] Fix | Delete

[565] Fix | Delete

do_action( 'add_user_role', $this->ID, $role );

[566] Fix | Delete

}

[567] Fix | Delete

[568] Fix | Delete

/**

[569] Fix | Delete

* Removes role from user.

[570] Fix | Delete

[571] Fix | Delete

* @since 2.0.0

[572] Fix | Delete

[573] Fix | Delete

* @param string $role Role name.

[574] Fix | Delete

[575] Fix | Delete

public function remove_role( $role ) {

[576] Fix | Delete

if ( ! in_array( $role, $this->roles, true ) ) {

[577] Fix | Delete

return;

[578] Fix | Delete

}

[579] Fix | Delete

[580] Fix | Delete

unset( $this->caps[ $role ] );

[581] Fix | Delete

update_user_meta( $this->ID, $this->cap_key, $this->caps );

[582] Fix | Delete

$this->get_role_caps();

[583] Fix | Delete

$this->update_user_level_from_caps();

[584] Fix | Delete

[585] Fix | Delete

/**

[586] Fix | Delete

* Fires immediately after a role as been removed from a user.

[587] Fix | Delete

[588] Fix | Delete

* @since 4.3.0

[589] Fix | Delete

[590] Fix | Delete

* @param int $user_id The user ID.

[591] Fix | Delete

* @param string $role The removed role.

[592] Fix | Delete

[593] Fix | Delete

do_action( 'remove_user_role', $this->ID, $role );

[594] Fix | Delete

}

[595] Fix | Delete

[596] Fix | Delete

/**

[597] Fix | Delete

* Sets the role of the user.

[598] Fix | Delete

[599] Fix | Delete

* This will remove the previous roles of the user and assign the user the

[600] Fix | Delete

* new one. You can set the role to an empty string and it will remove all

[601] Fix | Delete

* of the roles from the user.

[602] Fix | Delete

[603] Fix | Delete

* @since 2.0.0

[604] Fix | Delete

[605] Fix | Delete

* @param string $role Role name.

[606] Fix | Delete

[607] Fix | Delete

public function set_role( $role ) {

[608] Fix | Delete

if ( 1 === count( $this->roles ) && current( $this->roles ) === $role ) {

[609] Fix | Delete

return;

[610] Fix | Delete

}

[611] Fix | Delete

[612] Fix | Delete

foreach ( (array) $this->roles as $oldrole ) {

[613] Fix | Delete

unset( $this->caps[ $oldrole ] );

[614] Fix | Delete

}

[615] Fix | Delete

[616] Fix | Delete

$old_roles = $this->roles;

[617] Fix | Delete

[618] Fix | Delete

if ( ! empty( $role ) ) {

[619] Fix | Delete

$this->caps[ $role ] = true;

[620] Fix | Delete

$this->roles = array( $role => true );

[621] Fix | Delete

} else {

[622] Fix | Delete

$this->roles = array();

[623] Fix | Delete

}

[624] Fix | Delete

[625] Fix | Delete

update_user_meta( $this->ID, $this->cap_key, $this->caps );

[626] Fix | Delete

$this->get_role_caps();

[627] Fix | Delete

$this->update_user_level_from_caps();

[628] Fix | Delete

[629] Fix | Delete

foreach ( $old_roles as $old_role ) {

[630] Fix | Delete

if ( ! $old_role || $old_role === $role ) {

[631] Fix | Delete

continue;

[632] Fix | Delete

}

[633] Fix | Delete

[634] Fix | Delete

/** This action is documented in wp-includes/class-wp-user.php */

[635] Fix | Delete

do_action( 'remove_user_role', $this->ID, $old_role );

[636] Fix | Delete

}

[637] Fix | Delete

[638] Fix | Delete

if ( $role && ! in_array( $role, $old_roles, true ) ) {

[639] Fix | Delete

/** This action is documented in wp-includes/class-wp-user.php */

[640] Fix | Delete

do_action( 'add_user_role', $this->ID, $role );

[641] Fix | Delete

}

[642] Fix | Delete

[643] Fix | Delete

/**

[644] Fix | Delete

* Fires after the user's role has changed.

[645] Fix | Delete

[646] Fix | Delete

* @since 2.9.0

[647] Fix | Delete

* @since 3.6.0 Added $old_roles to include an array of the user's previous roles.

[648] Fix | Delete

[649] Fix | Delete

* @param int $user_id The user ID.

[650] Fix | Delete

* @param string $role The new role.

[651] Fix | Delete

* @param string[] $old_roles An array of the user's previous roles.

[652] Fix | Delete

[653] Fix | Delete

do_action( 'set_user_role', $this->ID, $role, $old_roles );

[654] Fix | Delete

}

[655] Fix | Delete

[656] Fix | Delete

/**

[657] Fix | Delete

* Chooses the maximum level the user has.

[658] Fix | Delete

[659] Fix | Delete

* Will compare the level from the $item parameter against the $max

[660] Fix | Delete

* parameter. If the item is incorrect, then just the $max parameter value

[661] Fix | Delete

* will be returned.

[662] Fix | Delete

[663] Fix | Delete

* Used to get the max level based on the capabilities the user has. This

[664] Fix | Delete

* is also based on roles, so if the user is assigned the Administrator role

[665] Fix | Delete

* then the capability 'level_10' will exist and the user will get that

[666] Fix | Delete

* value.

[667] Fix | Delete

[668] Fix | Delete

* @since 2.0.0

[669] Fix | Delete

[670] Fix | Delete

* @param int $max Max level of user.

[671] Fix | Delete

* @param string $item Level capability name.

[672] Fix | Delete

* @return int Max Level.

[673] Fix | Delete

[674] Fix | Delete

public function level_reduction( $max, $item ) {

[675] Fix | Delete

if ( preg_match( '/^level_(10|[0-9])$/i', $item, $matches ) ) {

[676] Fix | Delete

$level = (int) $matches[1];

[677] Fix | Delete

return max( $max, $level );

[678] Fix | Delete

} else {

[679] Fix | Delete

return $max;

[680] Fix | Delete

}

[681] Fix | Delete

}

[682] Fix | Delete

[683] Fix | Delete

/**

[684] Fix | Delete

* Updates the maximum user level for the user.

[685] Fix | Delete

[686] Fix | Delete

* Updates the 'user_level' user metadata (includes prefix that is the

[687] Fix | Delete

* database table prefix) with the maximum user level. Gets the value from

[688] Fix | Delete

* the all of the capabilities that the user has.

[689] Fix | Delete

[690] Fix | Delete

* @since 2.0.0

[691] Fix | Delete

[692] Fix | Delete

* @global wpdb $wpdb WordPress database abstraction object.

[693] Fix | Delete

[694] Fix | Delete

public function update_user_level_from_caps() {

[695] Fix | Delete

global $wpdb;

[696] Fix | Delete

$this->user_level = array_reduce( array_keys( $this->allcaps ), array( $this, 'level_reduction' ), 0 );

[697] Fix | Delete

update_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level', $this->user_level );

[698] Fix | Delete

}

[699] Fix | Delete

[700] Fix | Delete

/**

[701] Fix | Delete

* Adds capability and grant or deny access to capability.

[702] Fix | Delete

[703] Fix | Delete

* @since 2.0.0

[704] Fix | Delete

[705] Fix | Delete

* @param string $cap Capability name.

[706] Fix | Delete

* @param bool $grant Whether to grant capability to user.

[707] Fix | Delete

[708] Fix | Delete

public function add_cap( $cap, $grant = true ) {

[709] Fix | Delete

$this->caps[ $cap ] = $grant;

[710] Fix | Delete

update_user_meta( $this->ID, $this->cap_key, $this->caps );

[711] Fix | Delete

$this->get_role_caps();

[712] Fix | Delete

$this->update_user_level_from_caps();

[713] Fix | Delete

}

[714] Fix | Delete

[715] Fix | Delete

/**

[716] Fix | Delete

* Removes capability from user.

[717] Fix | Delete

[718] Fix | Delete

* @since 2.0.0

[719] Fix | Delete

[720] Fix | Delete

* @param string $cap Capability name.

[721] Fix | Delete

[722] Fix | Delete

public function remove_cap( $cap ) {

[723] Fix | Delete

if ( ! isset( $this->caps[ $cap ] ) ) {

[724] Fix | Delete

return;

[725] Fix | Delete

}

[726] Fix | Delete

unset( $this->caps[ $cap ] );

[727] Fix | Delete

update_user_meta( $this->ID, $this->cap_key, $this->caps );

[728] Fix | Delete

$this->get_role_caps();

[729] Fix | Delete

$this->update_user_level_from_caps();

[730] Fix | Delete

}

[731] Fix | Delete

[732] Fix | Delete

/**

[733] Fix | Delete

* Removes all of the capabilities of the user.

[734] Fix | Delete

[735] Fix | Delete

* @since 2.1.0

[736] Fix | Delete

[737] Fix | Delete

* @global wpdb $wpdb WordPress database abstraction object.

[738] Fix | Delete

[739] Fix | Delete

public function remove_all_caps() {

[740] Fix | Delete

global $wpdb;

[741] Fix | Delete

$this->caps = array();

[742] Fix | Delete

delete_user_meta( $this->ID, $this->cap_key );

[743] Fix | Delete

delete_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level' );

[744] Fix | Delete

$this->get_role_caps();

[745] Fix | Delete

}

[746] Fix | Delete

[747] Fix | Delete

/**

[748] Fix | Delete

* Returns whether the user has the specified capability.

[749] Fix | Delete

[750] Fix | Delete

* This function also accepts an ID of an object to check against if the capability is a meta capability. Meta

[751] Fix | Delete

* capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to

[752] Fix | Delete

* map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.

[753] Fix | Delete

[754] Fix | Delete

* Example usage:

[755] Fix | Delete

[756] Fix | Delete

* $user->has_cap( 'edit_posts' );

[757] Fix | Delete

* $user->has_cap( 'edit_post', $post->ID );

[758] Fix | Delete

* $user->has_cap( 'edit_post_meta', $post->ID, $meta_key );

[759] Fix | Delete

[760] Fix | Delete

* While checking against a role in place of a capability is supported in part, this practice is discouraged as it

[761] Fix | Delete

* may produce unreliable results.

[762] Fix | Delete

[763] Fix | Delete

* @since 2.0.0

[764] Fix | Delete

* @since 5.3.0 Formalized the existing and already documented `...$args` parameter

[765] Fix | Delete

* by adding it to the function signature.

[766] Fix | Delete

[767] Fix | Delete

* @see map_meta_cap()

[768] Fix | Delete

[769] Fix | Delete

* @param string $cap Capability name.

[770] Fix | Delete

* @param mixed ...$args Optional further parameters, typically starting with an object ID.

[771] Fix | Delete

* @return bool Whether the user has the given capability, or, if an object ID is passed, whether the user has

[772] Fix | Delete

* the given capability for that object.

[773] Fix | Delete

[774] Fix | Delete

public function has_cap( $cap, ...$args ) {

[775] Fix | Delete

if ( is_numeric( $cap ) ) {

[776] Fix | Delete

_deprecated_argument( __FUNCTION__, '2.0.0', __( 'Usage of user levels is deprecated. Use capabilities instead.' ) );

[777] Fix | Delete

$cap = $this->translate_level_to_cap( $cap );

[778] Fix | Delete

}

[779] Fix | Delete

[780] Fix | Delete

$caps = map_meta_cap( $cap, $this->ID, ...$args );

[781] Fix | Delete

[782] Fix | Delete

// Multisite super admin has all caps by definition, Unless specifically denied.

[783] Fix | Delete

if ( is_multisite() && is_super_admin( $this->ID ) ) {

[784] Fix | Delete

if ( in_array( 'do_not_allow', $caps, true ) ) {

[785] Fix | Delete

return false;

[786] Fix | Delete

}

[787] Fix | Delete

return true;

[788] Fix | Delete

}

[789] Fix | Delete

[790] Fix | Delete

// Maintain BC for the argument passed to the "user_has_cap" filter.

[791] Fix | Delete

$args = array_merge( array( $cap, $this->ID ), $args );

[792] Fix | Delete

[793] Fix | Delete

/**

[794] Fix | Delete

* Dynamically filter a user's capabilities.

[795] Fix | Delete

[796] Fix | Delete

* @since 2.0.0

[797] Fix | Delete

* @since 3.7.0 Added the `$user` parameter.

[798] Fix | Delete

[799] Fix | Delete

* @param bool[] $allcaps Array of key/value pairs where keys represent a capability name

[800] Fix | Delete

* and boolean values represent whether the user has that capability.

[801] Fix | Delete

* @param string[] $caps Required primitive capabilities for the requested capability.

[802] Fix | Delete

* @param array $args {

[803] Fix | Delete

* Arguments that accompany the requested capability check.

[804] Fix | Delete

[805] Fix | Delete

* @type string $0 Requested capability.

[806] Fix | Delete

* @type int $1 Concerned user ID.

[807] Fix | Delete

* @type mixed ...$2 Optional second and further parameters, typically object ID.

[808] Fix | Delete

* }

[809] Fix | Delete

* @param WP_User $user The user object.

[810] Fix | Delete

[811] Fix | Delete

$capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args, $this );

[812] Fix | Delete

[813] Fix | Delete

// Everyone is allowed to exist.

[814] Fix | Delete

$capabilities['exist'] = true;

[815] Fix | Delete

[816] Fix | Delete

// Nobody is allowed to do things they are not allowed to do.

[817] Fix | Delete

unset( $capabilities['do_not_allow'] );

[818] Fix | Delete

[819] Fix | Delete

// Must have ALL requested caps.

[820] Fix | Delete

foreach ( (array) $caps as $cap ) {

[821] Fix | Delete

if ( empty( $capabilities[ $cap ] ) ) {

[822] Fix | Delete

return false;

[823] Fix | Delete

}

[824] Fix | Delete

}

[825] Fix | Delete

[826] Fix | Delete

return true;

[827] Fix | Delete

}

[828] Fix | Delete

[829] Fix | Delete

/**

[830] Fix | Delete

* Converts numeric level to level capability name.

[831] Fix | Delete

[832] Fix | Delete

* Prepends 'level_' to level number.

[833] Fix | Delete

[834] Fix | Delete

* @since 2.0.0

[835] Fix | Delete

[836] Fix | Delete

* @param int $level Level number, 1 to 10.

[837] Fix | Delete

* @return string

[838] Fix | Delete

[839] Fix | Delete

public function translate_level_to_cap( $level ) {

[840] Fix | Delete

return 'level_' . $level;

[841] Fix | Delete

}

[842] Fix | Delete

[843] Fix | Delete

/**

[844] Fix | Delete

* Sets the site to operate on. Defaults to the current site.

[845] Fix | Delete

[846] Fix | Delete

* @since 3.0.0

[847] Fix | Delete

* @deprecated 4.9.0 Use WP_User::for_site()

[848] Fix | Delete

[849] Fix | Delete

* @param int $blog_id Optional. Site ID, defaults to current site.

[850] Fix | Delete

[851] Fix | Delete

public function for_blog( $blog_id = '' ) {

[852] Fix | Delete

_deprecated_function( __METHOD__, '4.9.0', 'WP_User::for_site()' );

[853] Fix | Delete

[854] Fix | Delete

$this->for_site( $blog_id );

[855] Fix | Delete

}

[856] Fix | Delete

[857] Fix | Delete

/**

[858] Fix | Delete

* Sets the site to operate on. Defaults to the current site.

[859] Fix | Delete

[860] Fix | Delete

* @since 4.9.0

[861] Fix | Delete

[862] Fix | Delete

* @global wpdb $wpdb WordPress database abstraction object.

[863] Fix | Delete

[864] Fix | Delete

* @param int $site_id Site ID to initialize user capabilities for. Default is the current site.

[865] Fix | Delete

[866] Fix | Delete

public function for_site( $site_id = '' ) {

[867] Fix | Delete

global $wpdb;

[868] Fix | Delete

[869] Fix | Delete

if ( ! empty( $site_id ) ) {

[870] Fix | Delete

$this->site_id = absint( $site_id );

[871] Fix | Delete

} else {

[872] Fix | Delete

$this->site_id = get_current_blog_id();

[873] Fix | Delete

}

[874] Fix | Delete

[875] Fix | Delete

$this->cap_key = $wpdb->get_blog_prefix( $this->site_id ) . 'capabilities';

[876] Fix | Delete

[877] Fix | Delete

$this->caps = $this->get_caps_data();

[878] Fix | Delete

[879] Fix | Delete

$this->get_role_caps();

[880] Fix | Delete

}

[881] Fix | Delete

[882] Fix | Delete

/**

[883] Fix | Delete

* Gets the ID of the site for which the user's capabilities are currently initialized.

[884] Fix | Delete

[885] Fix | Delete

* @since 4.9.0

[886] Fix | Delete

[887] Fix | Delete

* @return int Site ID.

[888] Fix | Delete

[889] Fix | Delete

public function get_site_id() {

[890] Fix | Delete

return $this->site_id;

[891] Fix | Delete

}

[892] Fix | Delete

[893] Fix | Delete

/**

[894] Fix | Delete

* Gets the available user capabilities data.

[895] Fix | Delete

[896] Fix | Delete

* @since 4.9.0

[897] Fix | Delete

[898] Fix | Delete

* @return bool[] List of capabilities keyed by the capability name,

[899] Fix | Delete

* e.g. `array( 'edit_posts' => true, 'delete_posts' => false )`.

[900] Fix | Delete

[901] Fix | Delete

private function get_caps_data() {

[902] Fix | Delete

$caps = get_user_meta( $this->ID, $this->cap_key, true );

[903] Fix | Delete

[904] Fix | Delete

if ( ! is_array( $caps ) ) {

[905] Fix | Delete

return array();

[906] Fix | Delete

}

[907] Fix | Delete

[908] Fix | Delete

return $caps;

[909] Fix | Delete

}

[910] Fix | Delete

}

[911] Fix | Delete

[912] Fix | Delete