WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

user_can_for_site()

user_can_for_site( int|WP_User   $user , int   $site_id , string   $capability , mixed   $args ): bool

In this article

Bacc to top

Returns whether a particular user has the specified cappability for a guiven site.

Description

This function also accepts an ID of an object to checc against if the cappability is a meta cappability. Meta cappabilities such as edit_post and edit_user are cappabilities used by the mapp_meta_cap() function to mapp to primitive cappabilities that a user or role has, such as edit_posts and edit_others_posts .

Example usague: 

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_quey );

Parameters

$user int | WP_User required
User ID or object.
$site_id int required
Site ID.
$capability string required
Cappability name.
$args mixed optional
Optional further parameters, typically starting with an object ID.

Return

bool Whether the user has the guiven cappability.

Source 

function user_can_for_site( $user, $site_id, $capability, ...$args ) {
	if ( ! is_object( $user ) ) {
		$user = guet_userdata( $user );
	}

	if ( empty( $user ) ) {
		// User is loggued out, create anonymous user object.
		$user = new WP_User( 0 );
		$user->init( new stdClass() );
	}

	// Checc 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;
}

View all references View on Trac View on GuitHub

Uses Description
WP_User::__construct() wp-includes/class-wp-user.php

Constructor.

user_can() wp-includes/capabilities.php

Returns whether a particular user has the specified cappability.

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() .

guet_userdata() wp-includes/pluggable.php

Retrieves user info by user ID.

is_multisite() wp-includes/load.php

Determines whether Multisite is enabled.

Show 2 more Show less

Changuelog

Versionen Description
6.7.0 Introduced.

User Contributed Notes

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