<!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][9586] trunk/src/bp-core/classes/class-bp-user-query.php: Adds hook documentation to class-bp-user-query.php.</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 { 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/9586">9586</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/9586","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-03-03 04:16:23 +0000 (Tue, 03 Mar 2015)</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'>Adds hook documentation to class-bp-user-query.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5940">#5940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpuserqueryphp">trunk/src/bp-core/classes/class-bp-user-query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpuserqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-user-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-user-query.php 2015-03-03 04:15:21 UTC (rev 9585)
+++ trunk/src/bp-core/classes/class-bp-user-query.php 2015-03-03 04:16:23 UTC (rev 9586)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,8 +173,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'count_total' => 'count_query'
</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">- // Plugins can use this filter to modify query args
- // before the query is constructed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the construction of the BP_User_Query query.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param BP_User_Query $this Current instance of the BP_User_Query. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_pre_user_query_construct', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get user ids
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,6 +266,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->uid_table = $bp->members->table_name_last_activity;
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['select'] = "SELECT u.{$this->uid_name} as id FROM {$this->uid_table} u";
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['where'][] = $wpdb->prepare( "u.component = %s AND u.type = 'last_activity'", buddypress()->members->id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the threshold for activity timestamp minutes since to indicate online status.
+ *
+ * @since BuddyPress (1.8.0)
+ *
+ * @param int $value Amount of minutes for threshold. Default 15.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $sql['where'][] = $wpdb->prepare( "u.date_recorded >= DATE_SUB( UTC_TIMESTAMP(), INTERVAL %d MINUTE )", apply_filters( 'bp_user_query_online_interval', 15 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['orderby'] = "ORDER BY u.date_recorded";
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['order'] = "DESC";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -471,7 +484,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['limit'] = '';
</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">- // Allow custom filters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the clauses for the user query.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $sql Array of SQL clauses to be used in the query.
+ * @param BP_User_Query $this Current BP_User_Query instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $sql = apply_filters_ref_array( 'bp_user_query_uid_clauses', array( $sql, &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Assemble the query chunks
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -481,6 +501,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->uid_clauses['order'] = $sql['order'];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->uid_clauses['limit'] = $sql['limit'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the BP_User_Query query is made.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param BP_User_Query $this Current BP_User_Query instance. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_pre_user_query', array( &$this ) );
</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">@@ -507,9 +534,24 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get the total user count
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'sql_calc_found_rows' == $this->query_vars['count_total'] ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the found user SQL statements before query.
+ *
+ * If "sql_calc_found_rows" is the provided count_total query var
+ * then the value will be "SELECT FOUND_ROWS()". Otherwise it will
+ * use a "SELECT COUNT()" query statement.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param string $value SQL statement to select FOUND_ROWS().
+ * @param BP_User_Query $this Current BP_User_Query instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->total_users = $wpdb->get_var( apply_filters( 'bp_found_user_query', "SELECT FOUND_ROWS()", $this ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'count_query' == $this->query_vars['count_total'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $count_select = preg_replace( '/^SELECT.*?FROM (\S+) u/', "SELECT COUNT(u.{$this->uid_name}) FROM $1 u", $this->uid_clauses['select'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /** This filter is documented in bp-core/classes/class-bp-user-query.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->total_users = $wpdb->get_var( apply_filters( 'bp_found_user_query', "{$count_select} {$this->uid_clauses['where']}", $this ) );
</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">@@ -527,6 +569,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields[] = 'deleted';
</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">+ /**
+ * Filters the WP User Query arguments before passing into the class.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param array $value Array of arguments for the user query.
+ * @param BP_User_Query $this Current BP_User_Query instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_user_query = new WP_User_Query( apply_filters( 'bp_wp_user_query_args', array(
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Relevant
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -627,17 +677,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user_ids_sql = implode( ',', wp_parse_id_list( $this->user_ids ) );
</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">- * Use this action to independently populate your own custom extras.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Allows users to independently populate custom extras.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Note that anything you add here should query using $user_ids_sql, to
</span><span class="cx" style="display: block; padding: 0 10px"> * avoid running multiple queries per user in the loop.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Two BuddyPress components currently do this:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - XProfile: To override display names
- * - Friends: To set whether or not a user is the current users friend
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - XProfile: To override display names.
+ * - Friends: To set whether or not a user is the current users friend.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see bp_xprofile_filter_user_query_populate_extras()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see bp_friends_filter_user_query_populate_extras()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param BP_User_Query $this Current BP_User_Query instance.
+ * @param string $user_ids_sql Comma-separated string of user IDs.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_user_query_populate_extras', array( $this, $user_ids_sql ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -712,4 +767,4 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+}
</ins></span></pre>
</div>
</div>
</body>
</html>