<!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][9977] trunk/src: Docblock formatting and codestyling after [9976].</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/9977">9977</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/9977","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-29 15:06:53 +0000 (Mon, 29 Jun 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'>Docblock formatting and codestyling after <a href="http://buddypress.trac.wordpress.org/changeset/9976">[9976]</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpuserqueryphp">trunk/src/bp-core/classes/class-bp-user-query.php</a></li>
<li><a href="#trunksrcbpmembersbpmembersfunctionsphp">trunk/src/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunksrcbpmembersbpmemberstemplatephp">trunk/src/bp-members/bp-members-template.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-06-29 14:58:47 UTC (rev 9976)
+++ trunk/src/bp-core/classes/class-bp-user-query.php 2015-06-29 15:06:53 UTC (rev 9977)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,42 +19,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $query {
</span><span class="cx" style="display: block; padding: 0 10px"> * Query arguments. All items are optional.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $type Determines sort order. Select from 'newest', 'active', 'online',
- * 'random', 'popular', 'alphabetical'. Default: 'newest'.
- * @type int $per_page Number of results to return. Default: 0 (no limit).
- * @type int $page Page offset (together with $per_page). Default: 1.
- * @type int $user_id ID of a user. If present, and if the friends component is activated,
- * results will be limited to the friends of that user. Default: 0.
- * @type string|bool $search_terms Terms to search by. Search happens across xprofile fields. Requires
- * XProfile component. Default: false.
- * @type string $search_wildcard When searching with $search_terms, set where wildcards around the term
- * should be positioned. Accepts 'both', 'left', 'right'. Default: 'both'.
- * @type array|string|bool $include An array or comma-separated list of user IDs to which query should
- * be limited. Default: false.
- * @type array|string|bool $exclude An array or comma-separated list of user IDs that will be excluded from
- * query results. Default: false.
- * @type array|string|bool $user_ids An array or comma-separated list of IDs corresponding to the users
- * that should be returned. When this parameter is passed, it will
- * override all others; BP User objects will be constructed using these
- * IDs only. Default: false.
- * @type array|string $member_type Array or comma-separated list of member types to limit results to.
- * @type array|string $member_type__in Array or comma-separated list of member types to limit results to.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $type Determines sort order. Select from 'newest', 'active', 'online',
+ * 'random', 'popular', 'alphabetical'. Default: 'newest'.
+ * @type int $per_page Number of results to return. Default: 0 (no limit).
+ * @type int $page Page offset (together with $per_page). Default: 1.
+ * @type int $user_id ID of a user. If present, and if the friends component is activated,
+ * results will be limited to the friends of that user. Default: 0.
+ * @type string|bool $search_terms Terms to search by. Search happens across xprofile fields. Requires
+ * XProfile component. Default: false.
+ * @type string $search_wildcard When searching with $search_terms, set where wildcards around the
+ * term should be positioned. Accepts 'both', 'left', 'right'.
+ * Default: 'both'.
+ * @type array|string|bool $include An array or comma-separated list of user IDs to which query should
+ * be limited. Default: false.
+ * @type array|string|bool $exclude An array or comma-separated list of user IDs that will be excluded
+ * from query results. Default: false.
+ * @type array|string|bool $user_ids An array or comma-separated list of IDs corresponding to the users
+ * that should be returned. When this parameter is passed, it will
+ * override all others; BP User objects will be constructed using these
+ * IDs only. Default: false.
+ * @type array|string $member_type Array or comma-separated list of member types to limit results to.
+ * @type array|string $member_type__in Array or comma-separated list of member types to limit results to.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $member_type__not_in Array or comma-separated list of member types that will be
</span><span class="cx" style="display: block; padding: 0 10px"> * excluded from results.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string|bool $meta_key Limit results to users that have usermeta associated with this meta_key.
- * Usually used with $meta_value. Default: false.
- * @type string|bool $meta_value When used with $meta_key, limits results to users whose usermeta value
- * associated with $meta_key matches $meta_value. Default: false.
- * @type array $xprofile_query Filter results by xprofile data. Requires the xprofile component. See
- * {@see BP_XProfile_Query} for details.
- * @type bool $populate_extras True if you want to fetch extra metadata
- * about returned users, such as total group and friend counts.
- * @type string $count_total Determines how BP_User_Query will do a count of total users matching
- * the other filter criteria. Default value is 'count_query', which does
- * a separate SELECT COUNT query to determine the total.
- * 'sql_count_found_rows' uses SQL_COUNT_FOUND_ROWS and
- * SELECT FOUND_ROWS(). Pass an empty string to skip the total user
- * count query.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string|bool $meta_key Limit results to users that have usermeta associated with this meta_key.
+ * Usually used with $meta_value. Default: false.
+ * @type string|bool $meta_value When used with $meta_key, limits results to users whose usermeta value
+ * associated with $meta_key matches $meta_value. Default: false.
+ * @type array $xprofile_query Filter results by xprofile data. Requires the xprofile component.
+ * See {@see BP_XProfile_Query} for details.
+ * @type bool $populate_extras True if you want to fetch extra metadata
+ * about returned users, such as total group and friend counts.
+ * @type string $count_total Determines how BP_User_Query will do a count of total users matching
+ * the other filter criteria. Default value is 'count_query', which
+ * does a separate SELECT COUNT query to determine the total.
+ * 'sql_count_found_rows' uses SQL_COUNT_FOUND_ROWS and
+ * SELECT FOUND_ROWS(). Pass an empty string to skip the total user
+ * count query.
</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"> class BP_User_Query {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,23 +160,23 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $this->query_vars_raw ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->query_vars = wp_parse_args( $this->query_vars_raw, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'newest',
- 'per_page' => 0,
- 'page' => 1,
- 'user_id' => 0,
- 'search_terms' => false,
- 'search_wildcard' => 'both',
- 'include' => false,
- 'exclude' => false,
- 'user_ids' => false,
- 'member_type' => '',
- 'member_type__in' => '',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'newest',
+ 'per_page' => 0,
+ 'page' => 1,
+ 'user_id' => 0,
+ 'search_terms' => false,
+ 'search_wildcard' => 'both',
+ 'include' => false,
+ 'exclude' => false,
+ 'user_ids' => false,
+ 'member_type' => '',
+ 'member_type__in' => '',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'member_type__not_in' => '',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'meta_key' => false,
- 'meta_value' => false,
- 'xprofile_query' => false,
- 'populate_extras' => true,
- 'count_total' => 'count_query'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meta_key' => false,
+ 'meta_value' => false,
+ 'xprofile_query' => false,
+ 'populate_extras' => true,
+ 'count_total' => 'count_query'
</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"> /**
</span></span></pre></div>
<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 2015-06-29 14:58:47 UTC (rev 9976)
+++ trunk/src/bp-members/bp-members-functions.php 2015-06-29 15:06:53 UTC (rev 9977)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,21 +78,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of arguments. All are optional. See {@link BP_User_Query} for
</span><span class="cx" style="display: block; padding: 0 10px"> * a more complete description of arguments.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $type Sort order. Default: 'active'.
- * @type int $user_id Limit results to friends of a user. Default: false.
- * @type mixed $exclude IDs to exclude from results. Default: false.
- * @type string $search_terms Limit to users matching search terms. Default: false.
- * @type string $meta_key Limit to users with a meta_key. Default: false.
- * @type string $meta_value Limit to users with a meta_value (with meta_key). Default: false.
- * @type array|string $member_type Array or comma-separated string of member types.
- * @type array|string $member_type__in Array or comma-separated string of member types.
- * `$member_type` takes precedence over this parameter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $type Sort order. Default: 'active'.
+ * @type int $user_id Limit results to friends of a user. Default: false.
+ * @type mixed $exclude IDs to exclude from results. Default: false.
+ * @type string $search_terms Limit to users matching search terms. Default: false.
+ * @type string $meta_key Limit to users with a meta_key. Default: false.
+ * @type string $meta_value Limit to users with a meta_value (with meta_key). Default: false.
+ * @type array|string $member_type Array or comma-separated string of member types.
+ * @type array|string $member_type__in Array or comma-separated string of member types.
+ * `$member_type` takes precedence over this parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $member_type__not_in Array or comma-separated string of member types to be excluded.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type mixed $include Limit results by user IDs. Default: false.
- * @type int $per_page Results per page. Default: 20.
- * @type int $page Page of results. Default: 1.
- * @type bool $populate_extras Fetch optional extras. Default: true.
- * @type string|bool $count_total How to do total user count. Default: 'count_query'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type mixed $include Limit results by user IDs. Default: false.
+ * @type int $per_page Results per page. Default: 20.
+ * @type int $page Page of results. Default: 1.
+ * @type bool $populate_extras Fetch optional extras. Default: true.
+ * @type string|bool $count_total How to do total user count. Default: 'count_query'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,20 +100,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Parse the user query arguments
</span><span class="cx" style="display: block; padding: 0 10px"> $r = bp_parse_args( $args, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'active', // active, newest, alphabetical, random or popular
- 'user_id' => false, // Pass a user_id to limit to only friend connections for this user
- 'exclude' => false, // Users to exclude from results
- 'search_terms' => false, // Limit to users that match these search terms
- 'meta_key' => false, // Limit to users who have this piece of usermeta
- 'meta_value' => false, // With meta_key, limit to users where usermeta matches this value
- 'member_type' => '',
- 'member_type__in' => '',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'active', // active, newest, alphabetical, random or popular
+ 'user_id' => false, // Pass a user_id to limit to only friend connections for this user
+ 'exclude' => false, // Users to exclude from results
+ 'search_terms' => false, // Limit to users that match these search terms
+ 'meta_key' => false, // Limit to users who have this piece of usermeta
+ 'meta_value' => false, // With meta_key, limit to users where usermeta matches this value
+ 'member_type' => '',
+ 'member_type__in' => '',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'member_type__not_in' => '',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'include' => false, // Pass comma separated list of user_ids to limit to only these users
- 'per_page' => 20, // The number of results to return per page
- 'page' => 1, // The page to return if limiting per page
- 'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update
- 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'include' => false, // Pass comma separated list of user_ids to limit to only these users
+ 'per_page' => 20, // The number of results to return per page
+ 'page' => 1, // The page to return if limiting per page
+ 'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update
+ 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false
</ins><span class="cx" style="display: block; padding: 0 10px"> ), 'core_get_users' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // For legacy users. Use of BP_Core_User::get_users() is deprecated.
</span></span></pre></div>
<a id="trunksrcbpmembersbpmemberstemplatephp"></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-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-template.php 2015-06-29 14:58:47 UTC (rev 9976)
+++ trunk/src/bp-members/bp-members-template.php 2015-06-29 15:06:53 UTC (rev 9977)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,22 +304,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see BP_User_Query for an in-depth description of parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $type Sort order.
- * @param int $page_number Page of results.
- * @param int $per_page Number of results per page.
- * @param int $max Max number of results to return.
- * @param int $user_id Limit to friends of a user.
- * @param string $search_terms Limit to users matching search terms.
- * @param array $include Limit results by these user IDs.
- * @param bool $populate_extras Fetch optional extras.
- * @param array $exclude Exclude these IDs from results.
- * @param array $meta_key Limit to users with a meta_key.
- * @param array $meta_value Limit to users with a meta_value (with meta_key).
- * @param string $page_arg Optional. The string used as a query parameter in pagination links.
- * Default: 'upage'.
- * @param array|string $member_type Array or comma-separated string of member types to limit results to.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $type Sort order.
+ * @param int $page_number Page of results.
+ * @param int $per_page Number of results per page.
+ * @param int $max Max number of results to return.
+ * @param int $user_id Limit to friends of a user.
+ * @param string $search_terms Limit to users matching search terms.
+ * @param array $include Limit results by these user IDs.
+ * @param bool $populate_extras Fetch optional extras.
+ * @param array $exclude Exclude these IDs from results.
+ * @param array $meta_key Limit to users with a meta_key.
+ * @param array $meta_value Limit to users with a meta_value (with meta_key).
+ * @param string $page_arg Optional. The string used as a query parameter in pagination links.
+ * Default: 'upage'.
+ * @param array|string $member_type Array or comma-separated string of member types to limit results to.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $member_type__in Array or comma-separated string of member types to limit results to.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array|string $member_type__not_in Array or comma-separated string of member types to exclude from results.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array|string $member_type__not_in Array or comma-separated string of member types to exclude
+ * from results.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function __construct( $type, $page_number, $per_page, $max, $user_id, $search_terms, $include, $populate_extras, $exclude, $meta_key, $meta_value, $page_arg = 'upage', $member_type = '', $member_type__in = '', $member_type__not_in = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -507,33 +508,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Arguments can be passed as an associative array, or as a URL query
</span><span class="cx" style="display: block; padding: 0 10px"> * string (eg, 'user_id=4&per_page=3').
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type int $type Sort order. Accepts 'active', 'random', 'newest', 'popular',
- * 'online', 'alphabetical'. Default: 'active'.
- * @type int|bool $page Page of results to display. Default: 1.
- * @type int|bool $per_page Number of results per page. Default: 20.
- * @type int|bool $max Maximum number of results to return. Default: false (unlimited).
- * @type string $page_arg The string used as a query parameter in pagination links.
- * Default: 'bpage'.
- * @type array|int|string|bool $include Limit results by a list of user IDs. Accepts an array, a
- * single integer, a comma-separated list of IDs, or false (to
- * disable this limiting). Accepts 'active', 'alphabetical',
- * 'newest', or 'random'. Default: false.
- * @type array|int|string|bool $exclude Exclude users from results by ID. Accepts an array, a single
- * integer, a comma-separated list of IDs, or false (to disable
- * this limiting). Default: false.
- * @type int $user_id If provided, results are limited to the friends of the specified
- * user. When on a user's Friends page, defaults to the ID of the
- * displayed user. Otherwise defaults to 0.
- * @type string|array $member_type Array or comma-separated list of member types to limit results to.
- * @type string|array $member_type__in Array or comma-separated list of member types to limit results to.
- * @type string|array $member_type__not_in Array or comma-separated list of member types to exclude from results.
- * @type string $search_terms Limit results by a search term. Default: null.
- * @type string $meta_key Limit results by the presence of a usermeta key.
- * Default: false.
- * @type mixed $meta_value When used with meta_key, limits results by the
- * a matching usermeta value. Default: false.
- * @type bool $populate_extras Whether to fetch optional data, such as
- * friend counts. Default: true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int $type Sort order. Accepts 'active', 'random', 'newest', 'popular',
+ * 'online', 'alphabetical'. Default: 'active'.
+ * @type int|bool $page Page of results to display. Default: 1.
+ * @type int|bool $per_page Number of results per page. Default: 20.
+ * @type int|bool $max Maximum number of results to return. Default: false (unlimited).
+ * @type string $page_arg The string used as a query parameter in pagination links.
+ * Default: 'bpage'.
+ * @type array|int|string|bool $include Limit results by a list of user IDs. Accepts an array, a
+ * single integer, a comma-separated list of IDs, or false (to
+ * disable this limiting). Accepts 'active', 'alphabetical',
+ * 'newest', or 'random'. Default: false.
+ * @type array|int|string|bool $exclude Exclude users from results by ID. Accepts an array, a single
+ * integer, a comma-separated list of IDs, or false (to disable
+ * this limiting). Default: false.
+ * @type int $user_id If provided, results are limited to the friends of the specified
+ * user. When on a user's Friends page, defaults to the ID of the
+ * displayed user. Otherwise defaults to 0.
+ * @type string|array $member_type Array or comma-separated list of member types to limit
+ * results to.
+ * @type string|array $member_type__in Array or comma-separated list of member types to limit
+ * results to.
+ * @type string|array $member_type__not_in Array or comma-separated list of member types to exclude
+ * from results.
+ * @type string $search_terms Limit results by a search term. Default: null.
+ * @type string $meta_key Limit results by the presence of a usermeta key.
+ * Default: false.
+ * @type mixed $meta_value When used with meta_key, limits results by the a matching
+ * usermeta value. Default: false.
+ * @type bool $populate_extras Whether to fetch optional data, such as friend counts.
+ * Default: true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Returns true when blogs are found, otherwise false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -560,26 +564,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // type: active ( default ) | random | newest | popular | online | alphabetical
</span><span class="cx" style="display: block; padding: 0 10px"> $r = bp_parse_args( $args, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'active',
- 'page' => 1,
- 'per_page' => 20,
- 'max' => false,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'active',
+ 'page' => 1,
+ 'per_page' => 20,
+ 'max' => false,
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'page_arg' => 'upage', // See https://buddypress.trac.wordpress.org/ticket/3679
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'page_arg' => 'upage', // See https://buddypress.trac.wordpress.org/ticket/3679
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'include' => false, // Pass a user_id or a list (comma-separated or array) of user_ids to only show these users
- 'exclude' => false, // Pass a user_id or a list (comma-separated or array) of user_ids to exclude these users
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'include' => false, // Pass a user_id or a list (comma-separated or array) of user_ids to only show these users
+ 'exclude' => false, // Pass a user_id or a list (comma-separated or array) of user_ids to exclude these users
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user_id' => $user_id, // Pass a user_id to only show friends of this user
- 'member_type' => $member_type,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_id' => $user_id, // Pass a user_id to only show friends of this user
+ 'member_type' => $member_type,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'member_type__in' => '',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'member_type__not_in' => '',
- 'search_terms' => null, // Pass search_terms to filter users by their profile data
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'member_type__not_in' => '',
+ 'search_terms' => null, // Pass search_terms to filter users by their profile data
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'meta_key' => false, // Only return users with this usermeta
- 'meta_value' => false, // Only return users where the usermeta value matches. Requires meta_key
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meta_key' => false, // Only return users with this usermeta
+ 'meta_value' => false, // Only return users where the usermeta value matches. Requires meta_key
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'populate_extras' => true // Fetch usermeta? Friend count, last active etc.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'populate_extras' => true // Fetch usermeta? Friend count, last active etc.
</ins><span class="cx" style="display: block; padding: 0 10px"> ), 'has_members' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Pass a filter if ?s= is set.
</span></span></pre>
</div>
</div>
</body>
</html>