Changeset 7918

Timestamp:

02/18/2014 12:50:11 PM (11 years ago)

Author:

boonebgorges

Message:

Pre-fetch blogmeta when in blog loops

This reduces overhead when querying for blog meta in the context of a
bp_has_blogs() template loop. Mirrors similar functionality in the activity,
groups, and xprofile components.

Also introduces an update_meta_cache parameter to the bp_has_blogs() stack, so
that plugin/theme authors can disable this pre-fetching.

Fixes #5398

Location:

trunk

Files:

• bp-blogs/bp-blogs-cache.php (modified) (1 diff)
• bp-blogs/bp-blogs-classes.php (modified) (2 diffs)
• bp-blogs/bp-blogs-functions.php (modified) (3 diffs)
• bp-blogs/bp-blogs-template.php (modified) (4 diffs)
• tests/testcases/blogs/cache.php (added)

trunk/bp-blogs/bp-blogs-cache.php

@@ -14 +14 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Slurp up blogmeta for a specified set of blogs.
+ *
+ * It grabs all blogmeta associated with all of the blogs passed
+ * in $blog_ids and adds it to the WP cache. This improves efficiency when
+ * using querying blogmeta inline.
+ *
+ * @param int|str|array $blog_ids Accepts a single blog ID, or a comma-
+ *        separated list or array of blog IDs.
+ */
+function bp_blogs_update_meta_cache( $blog_ids = false ) {
+    $cache_args = array(
+        'object_ids'       => $blog_ids,
+        'object_type'      => buddypress()->blogs->id,
+        'object_column'    => 'blog_id',
+        'cache_group'      => 'blog_meta',
+        'meta_table'       => buddypress()->blogs->table_name_blogmeta,
+    );
+
+    bp_update_meta_cache( $cache_args );
+}
 /**
  * Clear the blog object cache.

trunk/bp-blogs/bp-blogs-classes.php

@@ -115 +115 @@
      * @param string|bool $search_terms Optional. Search by text stored in
      *        blogmeta (such as the blog name). Default: false.
+     * @param bool $update_meta_cache Whether to pre-fetch metadata for
+     *        blogs. Default: true.
      * @return array Multidimensional results array, structured as follows:
      *           'blogs' - Array of located blog objects
      *           'total' - A count of the total blogs matching the filter params
      */
-    public static function get( $type, $limit = false, $page = false, $user_id = 0, $search_terms = false ) {
+    public static function get( $type, $limit = false, $page = false, $user_id = 0, $search_terms = false, $update_meta_cache = true ) {
         global $bp, $wpdb;
 
@@ -162 +164 @@
         $paged_blogs = BP_Blogs_Blog::get_blog_extras( $paged_blogs, $blog_ids, $type );
 
+        if ( $update_meta_cache ) {
+            bp_blogs_update_meta_cache( $blog_ids );
+        }
+
         return array( 'blogs' => $paged_blogs, 'total' => $total_blogs );
     }

trunk/bp-blogs/bp-blogs-functions.php

@@ -38 +38 @@
  *     @type int $per_page Default: 20.
  *     @type int $page Default: 1.
+ *     @type bool $update_meta_cache Whether to pre-fetch blogmeta. Default: true.
  * }
  * @return array See {@link BP_Blogs_Blog::get()}.
@@ -49 +50 @@
         'per_page'     => 20,       // The number of results to return per page
         'page'         => 1,        // The page to return if limiting per page
+        'update_meta_cache' => true,
     );
 
@@ -54 +56 @@
     extract( $params, EXTR_SKIP );
 
-    return apply_filters( 'bp_blogs_get_blogs', BP_Blogs_Blog::get( $type, $per_page, $page, $user_id, $search_terms ), $params );
+    return apply_filters( 'bp_blogs_get_blogs', BP_Blogs_Blog::get( $type, $per_page, $page, $user_id, $search_terms, $update_meta_cache ), $params );
 }
 

trunk/bp-blogs/bp-blogs-template.php

@@ -170 +170 @@
      * @param string $page_arg The string used as a query parameter in
      *        pagination links. Default: 'bpage'.
-     */
-    function __construct( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage' ) {
+     * @param bool $update_meta_cache Whether to pre-fetch metadata for
+     *        queried blogs.
+     */
+    function __construct( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage', $update_meta_cache = true ) {
 
         $this->pag_page = isset( $_REQUEST[$page_arg] ) ? intval( $_REQUEST[$page_arg] ) : $page;
@@ -179 +181 @@
             $this->blogs = BP_Blogs_Blog::get_by_letter( $_REQUEST['letter'], $this->pag_num, $this->pag_page );
         else
-            $this->blogs = bp_blogs_get_blogs( array( 'type' => $type, 'per_page' => $this->pag_num, 'page' => $this->pag_page, 'user_id' => $user_id, 'search_terms' => $search_terms ) );
+            $this->blogs = bp_blogs_get_blogs( array( 'type' => $type, 'per_page' => $this->pag_num, 'page' => $this->pag_page, 'user_id' => $user_id, 'search_terms' => $search_terms, 'update_meta_cache' => $update_meta_cache, ) );
 
         if ( !$max || $max >= (int) $this->blogs['total'] )
@@ -360 +362 @@
 
         'user_id'      => $user_id,       // Pass a user_id to limit to only blogs this user has higher than subscriber access to
-        'search_terms' => $search_terms   // Pass search terms to filter on the blog title or description.
+        'search_terms' => $search_terms,  // Pass search terms to filter on the blog title or description.
+        'update_meta_cache' => true,
     );
 
@@ -379 +382 @@
     }
 
-    $blogs_template = new BP_Blogs_Template( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg );
+    $blogs_template = new BP_Blogs_Template( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg, $update_meta_cache );
     return apply_filters( 'bp_has_blogs', $blogs_template->has_blogs(), $blogs_template );
 }