From 6cf0577be8b612fbb5550c85aa7d8d497cbd4d19 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Mon, 30 Sep 2024 11:05:15 +0000 Subject: [PATCH] Role/Capability: Introduce the `user_can_for_blog()` function. This complements the existing user capability checking functions and enables checking a capability of any user on any site on a Multisite network. Props tmanoilov, rajinsharwar, n8finch, johnbillion Fixes #45197 Built from https://develop.svn.wordpress.org/trunk@59123 git-svn-id: http://core.svn.wordpress.org/trunk@58519 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/capabilities.php | 48 ++++++++++++++++++++++++++++++++++++ wp-includes/version.php | 2 +- 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/wp-includes/capabilities.php b/wp-includes/capabilities.php index dab0067f63..e0576c6153 100644 --- a/wp-includes/capabilities.php +++ b/wp-includes/capabilities.php @@ -1013,6 +1013,54 @@ function user_can( $user, $capability, ...$args ) { return $user->has_cap( $capability, ...$args ); } +/** + * Returns whether a particular user has the specified capability for a given site. + * + * 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_blog( $user->ID, $blog_id, 'edit_posts' ); + * user_can_for_blog( $user->ID, $blog_id, 'edit_post', $post->ID ); + * user_can_for_blog( $user->ID, $blog_id, 'edit_post_meta', $post->ID, $meta_key ); + * + * @since 6.7.0 + * + * @param int|WP_User $user User ID or object. + * @param int $blog_id Site ID. + * @param string $capability Capability name. + * @param mixed ...$args Optional further parameters, typically starting with an object ID. + * @return bool Whether the user has the given capability. + */ +function user_can_for_blog( $user, $blog_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( $blog_id ) || $blog_id <= 0 ) { + return false; + } + + $switched = is_multisite() ? switch_to_blog( $blog_id ) : false; + + $can = user_can( $user->ID, $capability, ...$args ); + + if ( $switched ) { + restore_current_blog(); + } + + return $can; +} + /** * Retrieves the global WP_Roles instance and instantiates it if necessary. * diff --git a/wp-includes/version.php b/wp-includes/version.php index c646cb0c47..20a527282e 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.7-alpha-59122'; +$wp_version = '6.7-alpha-59123'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.