<!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][11086] trunk/src/bp-groups: Groups: Prime group administrator cache in group loops.</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/11086">11086</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/11086","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>2016-09-13 02:59:45 +0000 (Tue, 13 Sep 2016)</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'>Groups: Prime group administrator cache in group loops.
This saves a database query for each group of which the logged-in user
is a member.
Props r-a-y.
See <a href="http://buddypress.trac.wordpress.org/ticket/5451">#5451</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunksrcbpgroupsbpgroupstemplatephp">trunk/src/bp-groups/bp-groups-template.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsmemberphp">trunk/src/bp-groups/classes/class-bp-groups-member.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupstemplatephp">trunk/src/bp-groups/classes/class-bp-groups-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2016-09-11 14:34:03 UTC (rev 11085)
+++ trunk/src/bp-groups/bp-groups-functions.php 2016-09-13 02:59:45 UTC (rev 11086)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -684,6 +684,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.7.0 Added `$update_admin_cache` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</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. Supports all arguments of
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -713,6 +714,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => 1, // The page to return if limiting per page.
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => true, // Fetch meta such as is_banned and is_member.
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true, // Pre-fetch groupmeta for queried groups.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => false,
</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"> $r = wp_parse_args( $args, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -732,6 +734,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => $r['page'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => $r['populate_extras'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => $r['update_meta_cache'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => $r['update_admin_cache'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'order' => $r['order'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'orderby' => $r['orderby'],
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span></span></pre></div>
<a id="trunksrcbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-template.php 2016-09-11 14:34:03 UTC (rev 11085)
+++ trunk/src/bp-groups/bp-groups-template.php 2016-09-13 02:59:45 UTC (rev 11086)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,6 +103,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.7.0 Added `$update_admin_cache` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</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 parameters. All items are optional.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,6 +139,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $exclude Array or comma-separated list of group IDs. Results will exclude
</span><span class="cx" style="display: block; padding: 0 10px"> * the listed groups. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_meta_cache Whether to fetch groupmeta for queried groups. Default: true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $update_admin_cache Whether to pre-fetch group admins for queried groups.
+ * Defaults to true when on a group directory, where this
+ * information is needed in the loop. Otherwise false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if there are groups to display that match the params
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,6 +204,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => bp_is_groups_directory() || bp_is_user_groups(),
</ins><span class="cx" style="display: block; padding: 0 10px"> ), 'has_groups' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Setup the Groups template global.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -223,6 +228,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => $r['exclude'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => (bool) $r['populate_extras'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => (bool) $r['update_meta_cache'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => (bool) $r['update_admin_cache'],
</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="trunksrcbpgroupsclassesclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-group.php 2016-09-11 14:34:03 UTC (rev 11085)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2016-09-13 02:59:45 UTC (rev 11086)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -728,6 +728,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.7.0 Added `$update_admin_cache` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of parameters. All items are optional.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -760,6 +761,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Results will exclude the listed groups. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_meta_cache Whether to pre-fetch groupmeta for the returned groups.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $update_admin_cache Whether to pre-fetch administrator IDs for the returned
+ * groups. Default: false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $show_hidden Whether to include hidden groups in results. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -807,6 +810,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'include' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1023,6 +1027,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_groups_update_meta_cache( $group_ids );
</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">+ // Prefetch all administrator IDs, if requested.
+ if ( $r['update_admin_cache'] ) {
+ BP_Groups_Member::prime_group_administrator_ids_cache( $group_ids );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Set up integer properties needing casting.
</span><span class="cx" style="display: block; padding: 0 10px"> $int_props = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id', 'creator_id', 'enable_forum'
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupsmemberphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-member.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-member.php 2016-09-11 14:34:03 UTC (rev 11085)
+++ trunk/src/bp-groups/classes/class-bp-groups-member.php 2016-09-13 02:59:45 UTC (rev 11086)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1043,10 +1043,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $group_admins = wp_cache_get( $group_id, 'bp_group_admins' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $group_admins ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bp = buddypress();
- $group_admins = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_admin = 1 AND is_banned = 0", $group_id ) );
-
- wp_cache_set( $group_id, $group_admins, 'bp_group_admins' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::prime_group_administrator_ids_cache( array( $group_id ) );
+ $group_admins = wp_cache_get( $group_id, 'bp_group_admins' );
</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"> // Integer casting.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1058,6 +1056,40 @@
</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">+ * Prime the bp_group_admins cache for one or more groups.
+ *
+ * @since 2.7.0
+ *
+ * @param array $group_ids IDs of the groups.
+ * @return bool True on success.
+ */
+ public static function prime_group_administrator_ids_cache( $group_ids ) {
+ global $wpdb;
+
+ $uncached = bp_get_non_cached_ids( $group_ids, 'bp_group_admins' );
+
+ if ( $uncached ) {
+ $bp = buddypress();
+ $uncached_sql = implode( ',', array_map( 'intval', $uncached ) );
+ $group_admins = $wpdb->get_results( "SELECT user_id, group_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id IN ({$uncached_sql}) AND is_admin = 1 AND is_banned = 0" );
+
+ $groups = array();
+ if ( $group_admins ) {
+ foreach ( $group_admins as $group_admin ) {
+ $admin_obj = new stdClass();
+ $admin_obj->user_id = $group_admin->user_id;
+ $admin_obj->date_modified = $group_admin->date_modified;
+ $groups[ $group_admin->group_id ][] = $admin_obj;
+ }
+
+ foreach ( $groups as $this_group_id => $this_group_admins ) {
+ wp_cache_set( $this_group_id, $this_group_admins, 'bp_group_admins' );
+ }
+ }
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get a list of all a given group's moderators.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.6.0
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-template.php 2016-09-11 14:34:03 UTC (rev 11085)
+++ trunk/src/bp-groups/classes/class-bp-groups-template.php 2016-09-13 02:59:45 UTC (rev 11086)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -172,6 +172,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => false,
</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"> $r = wp_parse_args( $args, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -228,6 +229,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => $exclude,
</span><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => $populate_extras,
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => $update_meta_cache,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'update_admin_cache' => $update_admin_cache,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => $show_hidden,
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>