Changeset 6950

Timestamp:

04/26/2013 06:50:47 PM (7 years ago)

Author:

boonebgorges

Message:

Introduces a 'meta_query' parameter for the bp_has_groups() stack

This will allow plugin and theme authors to customize their group directories
based on data stored in the groupmeta table, using a powerful syntax familiar
from WP_Query.

Also adds unit tests for BP_Groups_Group::get() for the meta_query parameter,
as well as an integration test for the entire bp_has_groups() chain of
functions.

Fixes #3521

Location:

trunk

Files:

• bp-groups/bp-groups-classes.php (modified) (3 diffs)
• bp-groups/bp-groups-functions.php (modified) (2 diffs)
• bp-groups/bp-groups-template.php (modified) (4 diffs)
• tests/testcases/groups (added)
• tests/testcases/groups/classes.php (added)
• tests/testcases/groups/template.php (added)

trunk/bp-groups/bp-groups-classes.php

@@ -335 +335 @@
             'user_id'         => 0,
             'search_terms'    => false,
+            'meta_query'      => false,
             'include'         => false,
             'populate_extras' => true,
@@ -366 +367 @@
             $search_terms = like_escape( $wpdb->escape( $search_terms ) );
             $sql['search'] = " AND ( g.name LIKE '%%{$search_terms}%%' OR g.description LIKE '%%{$search_terms}%%' )";
+        }
+
+        $meta_query_sql = self::get_meta_query_sql( $meta_query );
+
+        if ( ! empty( $meta_query_sql['join'] ) ) {
+            $sql['from'] .= $meta_query_sql['join'];
+            $total_sql['select'] .= $meta_query_sql['join_total'];
+        }
+
+        if ( ! empty( $meta_query_sql['where'] ) ) {
+            $sql['meta'] = $meta_query_sql['where'];
         }
 
@@ -465 +477 @@
         return array( 'groups' => $paged_groups, 'total' => $total_groups );
     }
+
+    /**
+     * Get the SQL for the 'meta_query' param in BP_Activity_Activity::get()
+     *
+     * We use WP_Meta_Query to do the heavy lifting of parsing the
+     * meta_query array and creating the necessary SQL clauses. However,
+     * since BP_Activity_Activity::get() builds its SQL differently than
+     * WP_Query, we have to alter the return value (stripping the leading
+     * AND keyword from the 'where' clause).
+     *
+     * @since 1.8
+     *
+     * @param array $meta_query An array of meta_query filters. See the
+     *   documentation for WP_Meta_Query for details.
+     * @return array $sql_array 'join' and 'where' clauses
+     */
+    public static function get_meta_query_sql( $meta_query = array() ) {
+        global $wpdb;
+
+        $sql_array = array(
+            'join'  => '',
+            'where' => '',
+        );
+
+        if ( ! empty( $meta_query ) ) {
+            $groups_meta_query = new WP_Meta_Query( $meta_query );
+
+            // WP_Meta_Query expects the table name at
+            // $wpdb->group
+            $wpdb->groupmeta = buddypress()->groups->table_name_groupmeta;
+
+            $meta_sql = $groups_meta_query->get_sql( 'group', 'g', 'id' );
+
+            // BP_Groups_Group::get uses the comma syntax for table
+            // joins, which means that we have to do some regex to
+            // convert the INNER JOIN and move the ON clause to a
+            // WHERE condition
+            //
+            // @todo It may be better in the long run to refactor
+            // the more general query syntax to accord better with
+            // BP/WP convention
+            preg_match( '/INNER JOIN (.*) ON/', $meta_sql['join'], $matches_a );
+            preg_match( '/ON \((.*)\)$/', $meta_sql['join'], $matches_b );
+            if ( ! empty( $matches_a[1] ) && ! empty( $matches_b[1] ) ) {
+                $sql_array['join']  = $matches_a[1] . ', ';
+                $sql_array['where'] = preg_replace( '/^(\sAND\s+[\(\s]+)/', '$1' . $matches_b[1] . ' AND ', $meta_sql['where'] );
+            }
+        }
+
+        return $sql_array;
+    }
+
 
     function get_by_most_forum_topics( $limit = null, $page = null, $user_id = 0, $search_terms = false, $populate_extras = true, $exclude = false ) {

trunk/bp-groups/bp-groups-functions.php

@@ -419 +419 @@
         'exclude'         => false,    // Do not include these specific groups (group_ids)
         'search_terms'    => false,    // Limit to groups that match these search terms
+        'meta_query'      => false,    // Filter by groupmeta. See WP_Meta_Query for syntax
         'show_hidden'     => false,    // Show hidden groups to non-admins
         'per_page'        => 20,       // The number of results to return per page
@@ -433 +434 @@
         'exclude'         => $r['exclude'],
         'search_terms'    => $r['search_terms'],
+        'meta_query'      => $r['meta_query'],
         'show_hidden'     => $r['show_hidden'],
         'per_page'        => $r['per_page'],

trunk/bp-groups/bp-groups-template.php

@@ -145 +145 @@
             'exclude'         => false,
             'search_terms'    => '',
+            'meta_query'      => false,
             'populate_extras' => true
         );
@@ -170 +171 @@
                 'user_id'         => $user_id,
                 'search_terms'    => $search_terms,
+                'meta_query'      => $meta_query,
                 'include'         => $include,
                 'exclude'         => $exclude,
@@ -308 +310 @@
         'slug'            => $slug,    // Pass a group slug to only return that group
         'search_terms'    => '',       // Pass search terms to return only matching groups
+        'meta_query'      => false,    // Filter by groupmeta. See WP_Meta_Query for format
         'include'         => false,    // Pass comma separated list or array of group ID's to return only these groups
         'exclude'         => false,    // Pass comma separated list or array of group ID's to exclude these groups
@@ -335 +338 @@
         'slug'            => $r['slug'],
         'search_terms'    => $r['search_terms'],
+        'meta_query'      => $r['meta_query'],
         'include'         => $r['include'],
         'exclude'         => $r['exclude'],