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_User
User ID or object.
$site_idint
Site ID.
$capabilitystring
Capability name.
$argsmixed
Optional further parameters, typically starting with an object ID.
1042functionuser_can_for_site($user,$site_id,$capability,...$args){1043if(!is_object($user)){1044$user=get_userdata($user);1045}10461047if(empty($user)){1048// User is logged out, create anonymous user object.1049$user=newWP_User(0);1050$user->init(newstdClass());1051}10521053// Check if the blog ID is valid.1054if(!is_numeric($site_id)||$site_id<=0){1055returnfalse;1056}10571058$switched=is_multisite()?switch_to_blog($site_id):false;10591060$can=user_can($user->ID,$capability,...$args);10611062if($switched){1063restore_current_blog();1064}10651066return$can;1067}
History
Introduced in 6.7.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.8.8 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.