<!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>[BuddyPress][12450] trunk: Anticipate the deprecation in WordPress 5.3 of update_user_status()</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="http://buddypress.trac.wordpress.org/changeset/12450">12450</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12450","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-08-24 14:53:10 +0000 (Sat, 24 Aug 2019)</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'>Anticipate the deprecation in WordPress 5.3 of update_user_status()
Introduce `bp_core_update_member_status()` in order to wrap `wp_update_user()` with needed argument to spam a user on multisite configurations.
Props espellcaste
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8123">#8123</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersfunctionsphp">trunk/src/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesblogsfunctionsphp">trunk/tests/phpunit/testcases/blogs/functions.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpuserqueryphp">trunk/tests/phpunit/testcases/core/class-bp-user-query.php</a></li>
<li><a href="#trunktestsphpunittestcasesmembersfunctionsphp">trunk/tests/phpunit/testcases/members/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-functions.php 2019-08-22 22:03:17 UTC (rev 12449)
+++ trunk/src/bp-members/bp-members-functions.php 2019-08-24 14:53:10 UTC (rev 12450)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -610,6 +610,42 @@
</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">+ * Update the spam status of the member on multisite configs.
+ *
+ * @since 5.0.0
+ *
+ * @param int $user_id The user ID to spam or ham.
+ * @param int $value 0 to mark the user as `ham`, 1 to mark as `spam`.
+ * @return bool True if the spam status of the member changed.
+ * False otherwise.
+ */
+function bp_core_update_member_status( $user_id = 0, $value = 0 ) {
+ if ( ! is_multisite() || ! $user_id ) {
+ return false;
+ }
+
+ /**
+ * The `update_user_status()` function is deprecated since WordPress 5.3.0.
+ * Continue to use it if WordPress current major version is lower than 5.3.
+ */
+ if ( bp_get_major_wp_version() < 5.3 ) {
+ return update_user_status( $user_id, 'spam', $value );
+ }
+
+ // Otherwise use the replacement function.
+ $user = wp_update_user( array(
+ 'ID' => $user_id,
+ 'spam' => $value,
+ ) );
+
+ if ( is_wp_error( $user ) ) {
+ return false;
+ }
+
+ return true;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Process a spammed or unspammed user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This function is called from three places:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -671,9 +707,7 @@
</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"> // Finally, mark this user as a spammer.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() ) {
- update_user_status( $user_id, 'spam', $is_spam );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_update_member_status( $user_id, $is_spam );
</ins><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"> // Update the user status.
</span></span></pre></div>
<a id="trunktestsphpunittestcasesblogsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/blogs/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/blogs/functions.php 2019-08-22 22:03:17 UTC (rev 12449)
+++ trunk/tests/phpunit/testcases/blogs/functions.php 2019-08-24 14:53:10 UTC (rev 12450)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -291,10 +291,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->setExpectedDeprecated( 'wpmu_new_blog' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Create a regular member
</span><span class="cx" style="display: block; padding: 0 10px"> $u = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasescoreclassbpuserqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/class-bp-user-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/class-bp-user-query.php 2019-08-22 22:03:17 UTC (rev 12449)
+++ trunk/tests/phpunit/testcases/core/class-bp-user-query.php 2019-08-24 14:53:10 UTC (rev 12450)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -389,10 +389,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group spam
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_user_query_type_alphabetical_spam_xprofileoff() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $u2 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmembersfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/members/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/functions.php 2019-08-22 22:03:17 UTC (rev 12449)
+++ trunk/tests/phpunit/testcases/members/functions.php 2019-08-24 14:53:10 UTC (rev 12450)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -378,10 +378,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->markTestSkipped();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="cx" style="display: block; padding: 0 10px"> $displayed_user = $bp->displayed_user;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -389,7 +385,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp->displayed_user->id = $u1;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bulk spam in network admin uses update_user_status
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_user_status( $u1, 'spam', '1' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_update_member_status( $u1, '1' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( bp_is_user_spammer( $u1 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,10 +406,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->markTestSkipped();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="cx" style="display: block; padding: 0 10px"> $displayed_user = $bp->displayed_user;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -426,7 +418,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( bp_is_user_spammer( $u1 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bulk unspam in network admin uses update_user_status
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_user_status( $u1, 'spam', '0' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_update_member_status( $u1, '0' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( bp_is_user_spammer( $u1 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -438,10 +430,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group bp_core_process_spammer_status
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_core_process_spammer_status_make_spam_user_filter() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'make_spam_user', array( $this, 'notification_filter_callback' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -454,14 +442,12 @@
</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"> public function test_bp_core_process_spammer_status_make_ham_user_filter() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $u1 = self::factory()->user->create();
+ $s = bp_core_process_spammer_status( $u1, 'spam' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'make_ham_user', array( $this, 'notification_filter_callback' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $u1 = self::factory()->user->create();
- $n = bp_core_process_spammer_status( $u1, 'ham' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $h = bp_core_process_spammer_status( $u1, 'ham' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'make_ham_user', array( $this, 'notification_filter_callback' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -470,10 +456,6 @@
</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"> public function test_bp_core_process_spammer_status_bp_make_spam_user_filter() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_make_spam_user', array( $this, 'notification_filter_callback' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -486,10 +468,6 @@
</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"> public function test_bp_core_process_spammer_status_bp_make_ham_user_filter() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && function_exists( 'wp_get_registered_image_subsizes' ) ) {
- $this->setExpectedDeprecated( 'update_user_status' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_make_ham_user', array( $this, 'notification_filter_callback' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span></span></pre>
</div>
</div>
</body>
</html>