<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59123] trunk: Role/Capability: Introduce the `user_can_for_blog()` function.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59123">59123</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59123","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-30 11:03:51 +0000 (Mon, 30 Sep 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/45197">#45197</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescapabilitiesphp">trunk/src/wp-includes/capabilities.php</a></li>
<li><a href="#trunktestsphpunittestsusercapabilitiesphp">trunk/tests/phpunit/tests/user/capabilities.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescapabilitiesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/capabilities.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/capabilities.php 2024-09-30 06:47:20 UTC (rev 59122)
+++ trunk/src/wp-includes/capabilities.php 2024-09-30 11:03:51 UTC (rev 59123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1014,6 +1014,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the global WP_Roles instance and instantiates it if necessary.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0
</span></span></pre></div>
<a id="trunktestsphpunittestsusercapabilitiesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/user/capabilities.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/capabilities.php 2024-09-30 06:47:20 UTC (rev 59122)
+++ trunk/tests/phpunit/tests/user/capabilities.php 2024-09-30 11:03:51 UTC (rev 59123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1653,6 +1653,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 2, $add_user_role->get_call_count() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @group can_for_blog
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_current_user_can_for_blog() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1662,8 +1665,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( current_user_can_for_blog( get_current_blog_id(), 'edit_posts' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( current_user_can_for_blog( get_current_blog_id(), 'foo_the_bar' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_multisite() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( current_user_can_for_blog( 12345, 'edit_posts' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertFalse( current_user_can_for_blog( 12345, 'foo_the_bar' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1672,13 +1677,66 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->suppress_errors( $suppress );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create( array( 'user_id' => $user->ID ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->assertNotWPError( $blog_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( current_user_can_for_blog( $blog_id, 'edit_posts' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( current_user_can_for_blog( $blog_id, 'foo_the_bar' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $another_blog_id = self::factory()->blog->create( array( 'user_id' => self::$users['author']->ID ) );
+
+ $this->assertNotWPError( $another_blog_id );
+
+ // Verify the user doesn't have a capability
+ $this->assertFalse( current_user_can_for_blog( $another_blog_id, 'edit_posts' ) );
+
+ // Add the current user to the site
+ add_user_to_blog( $another_blog_id, $user->ID, 'author' );
+
+ // Verify they now have the capability
+ $this->assertTrue( current_user_can_for_blog( $another_blog_id, 'edit_posts' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $old_uid );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group can_for_blog
+ */
+ public function test_user_can_for_blog() {
+ $user = self::$users['editor'];
+
+ $this->assertTrue( user_can_for_blog( $user->ID, get_current_blog_id(), 'edit_posts' ) );
+ $this->assertFalse( user_can_for_blog( $user->ID, get_current_blog_id(), 'foo_the_bar' ) );
+
+ if ( ! is_multisite() ) {
+ $this->assertTrue( user_can_for_blog( $user->ID, 12345, 'edit_posts' ) );
+ $this->assertFalse( user_can_for_blog( $user->ID, 12345, 'foo_the_bar' ) );
+ return;
+ }
+
+ $blog_id = self::factory()->blog->create( array( 'user_id' => $user->ID ) );
+
+ $this->assertNotWPError( $blog_id );
+ $this->assertTrue( user_can_for_blog( $user->ID, $blog_id, 'edit_posts' ) );
+ $this->assertFalse( user_can_for_blog( $user->ID, $blog_id, 'foo_the_bar' ) );
+
+ $author = self::$users['author'];
+
+ // Verify another user doesn't have a capability
+ $this->assertFalse( is_user_member_of_blog( $author->ID, $blog_id ) );
+ $this->assertFalse( user_can_for_blog( $author->ID, $blog_id, 'edit_posts' ) );
+
+ // Add the author to the site
+ add_user_to_blog( $blog_id, $author->ID, 'author' );
+
+ // Verify they now have the capability
+ $this->assertTrue( is_user_member_of_blog( $author->ID, $blog_id ) );
+ $this->assertTrue( user_can_for_blog( $author->ID, $blog_id, 'edit_posts' ) );
+
+ // Verify the user doesn't have a capability for a non-existent site
+ $this->assertFalse( user_can_for_blog( $user->ID, -1, 'edit_posts' ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group ms-required
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_borked_current_user_can_for_blog() {
</span></span></pre>
</div>
</div>
</body>
</html>