Returns whether a particular user has the specified capability for a given site.
Description
This function also accepts an ID of an object to check against if the capability is a meta capability. Meta capabilities such as edit_post and edit_user are capabilities used by the map_meta_cap() function to map to primitive capabilities that a user or role has, such as edit_posts and edit_others_posts.
Example usage:
user_can_for_site( $user->ID, $site_id, 'edit_posts' );
user_can_for_site( $user->ID, $site_id, 'edit_post', $post->ID );
user_can_for_site( $user->ID, $site_id, 'edit_post_meta', $post->ID, $meta_key );Parameters
$userint|WP_Userrequired- User ID or object.
$site_idintrequired- Site ID.
$capabilitystringrequired- Capability name.
$argsmixedoptional- Optional further parameters, typically starting with an object ID.
Source
function user_can_for_site( $user, $site_id, $capability, ...$args ) {
if ( ! is_object( $user ) ) {
$user = get_userdata( $user );
}
if ( empty( $user ) ) {
// User is logged out, create anonymous user object.
$user = new WP_User( 0 );
$user->init( new stdClass() );
}
// Check if the blog ID is valid.
if ( ! is_numeric( $site_id ) || $site_id <= 0 ) {
return false;
}
$switched = is_multisite() ? switch_to_blog( $site_id ) : false;
$can = user_can( $user->ID, $capability, ...$args );
if ( $switched ) {
restore_current_blog();
}
return $can;
}
Changelog
| Version | Description |
|---|---|
| 6.7.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.