Changeset 10818

Timestamp:

05/28/2016 01:43:05 PM (8 years ago)

Author:

boonebgorges

Message:

Taxonomy: Allow the site used for taxonomy term storage to be filtered.

On some setups, it may be desirable to store the terms from a given BP taxonomy
on a site other than the default. For example, on a multi-network setup, where
users are shared between all networks, it may suit the purposes of the
installation better to have bp_member_type data stored on the primary network
and shared between networks.

The new function bp_get_taxonomy_term_site_id() function allows the value to
be filtered, on a taxonomy-specific basis. BP's taxonomy wrapper functions have
been updated to use this new function.

Props rekmla.
Fixes #7077.

File:

• trunk/src/bp-core/bp-core-taxonomy.php (modified) (4 diffs)

trunk/src/bp-core/bp-core-taxonomy.php

@@ -46 +46 @@
 
 /**
+ * Gets the ID of the site that BP should use for taxonomy term storage.
+ *
+ * Defaults to the root blog ID.
+ *
+ * @since 2.6.0
+ *
+ * @return int
+ */
+function bp_get_taxonomy_term_site_id( $taxonomy = '' ) {
+    $site_id = bp_get_root_blog_id();
+
+    /**
+     * Filters the ID of the site where BP should store taxonomy terms.
+     *
+     * @since 2.6.0
+     *
+     * @param int    $site_id
+     * @param string $taxonomy
+     */
+    return (int) apply_filters( 'bp_get_taxonomy_term_site_id', $site_id, $taxonomy );
+}
+
+/**
  * Set taxonomy terms on a BuddyPress object.
  *
@@ -59 +82 @@
  */
 function bp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
-    $is_root_blog = bp_is_root_blog();
+    $site_id = bp_get_taxonomy_term_site_id( $taxonomy );
 
-    if ( ! $is_root_blog ) {
-        switch_to_blog( bp_get_root_blog_id() );
+    $switched = false;
+    if ( $site_id !== get_current_blog_id() ) {
+        switch_to_blog( $site_id );
         bp_register_taxonomies();
+        $switched = true;
     }
 
     $retval = wp_set_object_terms( $object_id, $terms, $taxonomy, $append );
 
-    if ( ! $is_root_blog ) {
+    if ( ! $switched ) {
         restore_current_blog();
     }
@@ -88 +113 @@
  */
 function bp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
-    $is_root_blog = bp_is_root_blog();
-
-    if ( ! $is_root_blog ) {
-        switch_to_blog( bp_get_root_blog_id() );
-        bp_register_taxonomies();
+    // Different taxonomies must be stored on different sites.
+    $taxonomy_site_map = array();
+    foreach ( (array) $taxonomies as $taxonomy ) {
+        $taxonomy_site_id = bp_get_taxonomy_term_site_id( $taxonomy );
+        $taxonomy_site_map[ $taxonomy_site_id ][] = $taxonomy;
     }
 
-    $retval = wp_get_object_terms( $object_ids, $taxonomies, $args );
+    $retval = array();
+    foreach ( $taxonomy_site_map as $taxonomy_site_id => $site_taxonomies ) {
+        $switched = false;
+        if ( $taxonomy_site_id !== get_current_blog_id() ) {
+            switch_to_blog( $site_id );
+            bp_register_taxonomies();
+            $switched = true;
+        }
 
-    if ( ! $is_root_blog ) {
-        restore_current_blog();
+        $site_terms = wp_get_object_terms( $object_ids, $site_taxonomies, $args );
+        $retval     = array_merge( $retval, $site_terms );
+
+        if ( ! $switched ) {
+            restore_current_blog();
+        }
     }
 
@@ -117 +153 @@
  */
 function bp_remove_object_terms( $object_id, $terms, $taxonomy ) {
-    $is_root_blog = bp_is_root_blog();
+    $site_id = bp_get_taxonomy_term_site_id( $taxonomy );
 
-    if ( ! $is_root_blog ) {
-        switch_to_blog( bp_get_root_blog_id() );
+    $switched = false;
+    if ( $site_id !== get_current_blog_id() ) {
+        switch_to_blog( $site_id );
         bp_register_taxonomies();
+        $switched = true;
     }
 
     $retval = wp_remove_object_terms( $object_id, $terms, $taxonomy );
 
-    if ( ! $is_root_blog ) {
+    if ( ! $switched ) {
         restore_current_blog();
     }