<!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][13337] trunk: Activity introduce 2 new parameters to `BP_Activity_Activity::get()``</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/13337">13337</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/13337","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>2022-10-06 22:31:49 +0000 (Thu, 06 Oct 2022)</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'>Activity introduce 2 new parameters to `BP_Activity_Activity::get()``
- The `user_id__in` parameter makes it possible to retrieve activities for
a list of user IDs.
- The `user_id__not_in` parameter makes it possible to exclude activity
posted by a list of user IDs from retrieved activities.
Props username_, slaFFik, boonebgorges
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/4184">#4184</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityfunctionsphp">trunk/src/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunksrcbpactivityclassesclassbpactivityactivityphp">trunk/src/bp-activity/classes/class-bp-activity-activity.php</a></li>
<li><a href="#trunktestsphpunittestcasesactivityclassBP_Activity_Activityphp">trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-functions.php 2022-10-06 22:14:05 UTC (rev 13336)
+++ trunk/src/bp-activity/bp-activity-functions.php 2022-10-06 22:31:49 UTC (rev 13337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1847,6 +1847,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => false, // Filter by activity meta. See WP_Meta_Query for format.
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query' => false, // Filter by date. See first parameter of WP_Date_Query for format.
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter_query' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_id__in' => array(), // Array of user ids to include.
+ 'user_id__not_in' => array(), // Array of user ids to excluce.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => false, // Show activity items that are hidden site-wide?
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false, // Comma-separated list of activity IDs to exclude.
</span><span class="cx" style="display: block; padding: 0 10px"> 'in' => false, // Comma-separated list or array of activity IDs to which you want to limit the query.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1882,6 +1884,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query' => $r['date_query'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter_query' => $r['filter_query'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter' => $r['filter'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_id__in' => $r['user_id__in'],
+ 'user_id__not_in' => $r['user_id__not_in'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'scope' => $r['scope'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'display_comments' => $r['display_comments'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => $r['show_hidden'],
</span></span></pre></div>
<a id="trunksrcbpactivityclassesclassbpactivityactivityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/classes/class-bp-activity-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/classes/class-bp-activity-activity.php 2022-10-06 22:14:05 UTC (rev 13336)
+++ trunk/src/bp-activity/classes/class-bp-activity-activity.php 2022-10-06 22:31:49 UTC (rev 13337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -342,6 +342,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.4.0 Introduced the `$fields` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0 Introduced the `$order_by` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 10.0.0 Introduced the `$count_total_only` parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 11.0.0 Introduced the `$user_id__in` and `$user_id__not_in` parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see BP_Activity_Activity::get_filter_sql() for a description of the
</span><span class="cx" style="display: block; padding: 0 10px"> * 'filter' parameter.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -366,6 +367,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $filter_query Array of advanced query conditions. See BP_Activity_Query::__construct().
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|array $scope Pre-determined set of activity arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $filter See BP_Activity_Activity::get_filter_sql().
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $user_id__in An array of user ids to include. Activity posted by users matching one of these
+ * user ids will be included in results. Default empty array.
+ * @type array $user_id__not_in An array of user ids to exclude. Activity posted by users matching one of these
+ * user ids will not be included in results. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $search_terms Limit results by a search term. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $display_comments Whether to include activity comments. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $show_hidden Whether to show items marked hide_sitewide. Default: false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -430,6 +435,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => false, // Filter by activitymeta.
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query' => false, // Filter by date.
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter_query' => false, // Advanced filtering - see BP_Activity_Query.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_id__in' => array(), // Array of user ids to include.
+ 'user_id__not_in' => array(), // Array of user ids to excluce.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'filter' => false, // See self::get_filter_sql().
</span><span class="cx" style="display: block; padding: 0 10px"> 'scope' => false, // Preset activity arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => false, // Terms to search by.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -483,6 +490,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['filter_sql'] = $filter_sql;
</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">+ // User IDs filtering.
+ $user_ids_clause = array();
+ $user_ids_filters = array_filter(
+ array_intersect_key(
+ $r,
+ array(
+ 'user_id__in' => true,
+ 'user_id__not_in' => true,
+ )
+ )
+ );
+
+ foreach ( $user_ids_filters as $user_ids_filter_key => $user_ids_filter ) {
+ $user_ids_operator = 'IN';
+ if ( 'user_id__not_in' === $user_ids_filter_key ) {
+ $user_ids_operator = 'NOT IN';
+ }
+
+ if ( $user_ids_clause ) {
+ $user_ids_clause[] = array(
+ 'column' => 'user_id',
+ 'compare' => $user_ids_operator,
+ 'value' => (array) $user_ids_filter,
+ );
+ } else {
+ $user_ids_clause = array(
+ 'relation' => 'AND',
+ array(
+ 'column' => 'user_id',
+ 'compare' => $user_ids_operator,
+ 'value' => (array) $user_ids_filter,
+ ),
+ );
+ }
+ }
+
+ if ( $user_ids_clause ) {
+ $user_ids_query = new BP_Activity_Query( $user_ids_clause );
+ $user_ids_sql = $user_ids_query->get_sql();
+ if ( ! empty( $user_ids_sql ) ) {
+ $where_conditions['user_ids_query_sql'] = $user_ids_sql;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Spam.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'ham_only' == $r['spam'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['spam_sql'] = 'a.is_spam = 0';
</span></span></pre></div>
<a id="trunktestsphpunittestcasesactivityclassBP_Activity_Activityphp"></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/activity/class.BP_Activity_Activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php 2022-10-06 22:14:05 UTC (rev 13336)
+++ trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php 2022-10-06 22:31:49 UTC (rev 13337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -412,6 +412,70 @@
</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"> * @group get
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ */
+ public function test_get_with_user_id__in() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $u3 = self::factory()->user->create();
+ $a1 = self::factory()->activity->create( array( 'user_id' => $u1 ) );
+ $a2 = self::factory()->activity->create( array( 'user_id' => $u2 ) );
+ $a3 = self::factory()->activity->create( array( 'user_id' => $u3 ) );
+
+ $activities = BP_Activity_Activity::get( array(
+ 'user_id__in' => array( $u1, $u2 ),
+ ) );
+
+ $ids = wp_list_pluck( $activities['activities'], 'id' );
+ sort( $ids );
+ $this->assertEquals( array( $a1, $a2 ), $ids );
+ }
+
+ /**
+ * @group get
+ */
+ public function test_get_with_user_id__not_in() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $u3 = self::factory()->user->create();
+ $a1 = self::factory()->activity->create( array( 'user_id' => $u1 ) );
+ $a2 = self::factory()->activity->create( array( 'user_id' => $u2 ) );
+ $a3 = self::factory()->activity->create( array( 'user_id' => $u3 ) );
+
+ $activities = BP_Activity_Activity::get( array(
+ 'user_id__not_in' => array( $u2, $u3 ),
+ ) );
+
+ $ids = wp_list_pluck( $activities['activities'], 'id' );
+ $this->assertEquals( array( $a1 ), $ids );
+ }
+
+ /**
+ * @group get
+ */
+ public function test_get_with_user_id__in_andnot_in() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $u3 = self::factory()->user->create();
+ $u4 = self::factory()->user->create();
+ $u5 = self::factory()->user->create();
+ $a1 = self::factory()->activity->create( array( 'user_id' => $u1 ) );
+ $a2 = self::factory()->activity->create( array( 'user_id' => $u2 ) );
+ $a3 = self::factory()->activity->create( array( 'user_id' => $u3 ) );
+ $a4 = self::factory()->activity->create( array( 'user_id' => $u4 ) );
+ $a5 = self::factory()->activity->create( array( 'user_id' => $u5 ) );
+
+ $activities = BP_Activity_Activity::get( array(
+ 'user_id__in' => array( $u1, $u2, $u4, $u5 ),
+ 'user_id__not_in' => array( $u4, $u5 ),
+ ) );
+
+ $ids = wp_list_pluck( $activities['activities'], 'id' );
+ sort( $ids );
+ $this->assertEquals( array( $a1, $a2 ), $ids );
+ }
+
+ /**
+ * @group get
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group count_total
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_with_count_total() {
</span></span></pre>
</div>
</div>
</body>
</html>