<!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][9183] trunk/src/bp-messages: Prefetch message meta when in a message loop.</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/9183">9183</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/9183","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-26 06:08:23 +0000 (Wed, 26 Nov 2014)</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'>Prefetch message meta when in a message loop.
This reduces overhead when querying for message meta in the context of a
bp_thread_has_messages() loop.
Also introduces an 'update_meta_cache' parameter to the bp_has_thread_messages()
stack, so the message meta cache prefetch can be disabled by developers.
See <a href="http://buddypress.trac.wordpress.org/ticket/3083">#3083</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagesclassesphp">trunk/src/bp-messages/bp-messages-classes.php</a></li>
<li><a href="#trunksrcbpmessagesbpmessagestemplatephp">trunk/src/bp-messages/bp-messages-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagesclassesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-classes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-classes.php 2014-11-26 06:08:03 UTC (rev 9182)
+++ trunk/src/bp-messages/bp-messages-classes.php 2014-11-26 06:08:23 UTC (rev 9183)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,12 +109,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.0.0)
</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 bool|int $thread_id The message thread ID.
- * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see BP_Messages_Thread::populate() for full description of parameters
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function __construct( $thread_id = false, $order = 'ASC' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function __construct( $thread_id = false, $order = 'ASC', $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $thread_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->populate( $thread_id, $order );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->populate( $thread_id, $order, $args );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,15 +126,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $thread_id The message thread ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * Array of arguments.
+ * @type bool $update_meta_cache Whether to pre-fetch metadata for
+ * queried message items. Default: true.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool False on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function populate( $thread_id, $order ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function populate( $thread_id = 0, $order = 'ASC', $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb, $bp;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if( 'ASC' != $order && 'DESC' != $order ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $order= 'ASC';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $order = 'ASC';
</ins><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">+ // merge $args with our defaults
+ $r = wp_parse_args( $args, array(
+ 'update_meta_cache' => true
+ ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->messages_order = $order;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->thread_id = $thread_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -155,6 +164,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->unread_count = $this->recipients[bp_loggedin_user_id()]->unread_count;
</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">+ // Grab all message meta
+ if ( true === (bool) $r['update_meta_cache'] ) {
+ bp_messages_update_meta_cache( wp_list_pluck( $this->messages, 'id' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires after a BP_Messages_Thread object has been populated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,7 +339,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $threads = false;
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $sorted_threads as $thread_id => $date_sent ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $threads[] = new BP_Messages_Thread( $thread_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $threads[] = new BP_Messages_Thread( $thread_id, 'ASC', array(
+ 'update_meta_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"> /**
</span></span></pre></div>
<a id="trunksrcbpmessagesbpmessagestemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-template.php 2014-11-26 06:08:03 UTC (rev 9182)
+++ trunk/src/bp-messages/bp-messages-template.php 2014-11-26 06:08:23 UTC (rev 9183)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1467,11 +1467,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Constructor method.
</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 int $thread_id ID of the message thread.
- * @param string $order 'ASC' or 'DESC'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see BP_Messages_Thread::populate() for full parameter info
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function __construct( $thread_id, $order ) {
- $this->thread = new BP_Messages_Thread( $thread_id, $order );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function __construct( $thread_id, $order, $args ) {
+ $this->thread = new BP_Messages_Thread( $thread_id, $order, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->message_count = count( $this->thread->messages );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $last_message_index = $this->message_count - 1;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1572,6 +1571,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: if viewing a thread, the thread ID will be parsed from
</span><span class="cx" style="display: block; padding: 0 10px"> * the URL (bp_action_variable( 0 )).
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $order 'ASC' or 'DESC'. Default: 'ASC'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $update_meta_cache Whether to pre-fetch metadata for
+ * queried message items. Default: true.
</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 messages to display, otherwise false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1579,16 +1580,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $thread_template;
</span><span class="cx" style="display: block; padding: 0 10px">
</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">- 'thread_id' => false,
- 'order' => 'ASC'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'thread_id' => false,
+ 'order' => 'ASC',
+ 'update_meta_cache' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> ), 'thread_has_messages' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['thread_id'] ) && bp_is_messages_component() && bp_is_current_action( 'view' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r['thread_id'] = (int) bp_action_variable( 0 );
</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">- $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set up extra args
+ $extra_args = $r;
+ unset( $extra_args['thread_id'], $extra_args['order'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'], $extra_args );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $thread_template->has_messages();
</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>