current_user_can_for_site( int $site_id, string $capability, mixed $args ): bool
- Since
- 6.7.0
- Source
wp-includes/capabilities.php:939
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.
This function replaces the current_user_can_for_blog() function.
Example usage:
current_user_can_for_site( $site_id, 'edit_posts' );
current_user_can_for_site( $site_id, 'edit_post', $post->ID );
current_user_can_for_site( $site_id, 'edit_post_meta', $post->ID, $meta_key );Compatibility
- WordPress
- since 6.7.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.
Parameters
$site_idint- Site ID.
$capabilitystring- Capability name.
$argsmixed- Optional further parameters, typically starting with an object ID.
Return value
bool- Whether the user has the given capability.
Performance profile
How much work a call to current_user_can_for_site() 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
- Light
- Scaling
- Constant
- Instructions
- 16–22
- Plugin surface
- None
- Called by
- 1
Only touches the object cache, via wp_cache_switch_to_blog().
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 23.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below current_user_can_for_site() - cacheobject cache
wp_cache_switch_to_blog()one call below current_user_can_for_site()
Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost current_user_can_for_site() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_multisite() | 16 | is_multisite(), current_user_can() |
!is_multisite() | 18 | is_multisite(), current_user_can(), restore_current_blog() |
is_multisite() | 20 | is_multisite(), switch_to_blog(), current_user_can() |
is_multisite() | 22 | is_multisite(), switch_to_blog(), current_user_can(), restore_current_blog() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 22 | 16–21 | 2 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 23 | 16–22 | 2 | |
| 8.4 | 23 | 16–22 | 2 | |
| 8.3 | 23 | 16–22 | 2 | |
| 8.2 | 23 | 16–22 | 2 | |
| 8.1 | 23 | 16–22 | 2 | 1 more instruction than PHP 7.4 |
| 7.4 | 22 | 15–21 | 2 |
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 · 4
- is_multisite()Determines whether Multisite is enabled.
- switch_to_blog()Switches the current blog.
- current_user_can()Returns whether the current user has the specified capability.
- restore_current_blog()Restores the current blog, after calling switch_to_blog().
Used by · 1
- current_user_can_for_blog()Returns whether the current user has the specified capability for a given site.
Source code
function current_user_can_for_site( $site_id, $capability, ...$args ) { $switched = is_multisite() ? switch_to_blog( $site_id ) : false; $can = current_user_can( $capability, ...$args ); if ( $switched ) { restore_current_blog(); } return $can;}Changelog
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 7.1.0 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.