Make `get_term()` behave more consistently in the context of shared terms.

When `WP_Term` was introduced in [34997], the `$taxonomy` parameter for
`get_term()` was made optional. This meant that, when the optional param was
omitted, `get_term()` had no way of determining which term was intended when
the term_id was shared between multiple taxonomies. As a (somewhat sneaky) way
of fixing things, `get_term()` split any shared terms it found. But this could
cause problems with developer expectations: it's not clear why requesting a
term should result in a database update, much less a potential change in the
ID of a term.

In place of this technique, this changeset introduces a number of changes that
make the handling of shared terms a bit less insane:

* When a taxonomy is provided to `get_term()`, and a cached term is found matching the term_id, make sure the taxonomy also matches before returning it.
* When a taxonomy is not provided, ensure that the term is not shared before adding it to the cache.
* When a term is shared between taxonomies and no taxonomy is provided, return a `WP_Error` rather than splitting the term.
* When a term is shared between taxonomies, only one of which is valid, return the term from that taxonomy.

Props boonebgorges, dlh.
Fixes #34533.
Built from https://develop.svn.wordpress.org/trunk@35537


git-svn-id: http://core.svn.wordpress.org/trunk@35501 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/class-wp-term.php

@@ -116,9 +116,13 @@ final class WP_Term {
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 *
 	 * @param int    $term_id  Term ID.
-	 * @return WP_Term|false Term object, false otherwise.
+	 * @param string $taxonomy Optional. Limit matched terms to those matching `$taxonomy`. Only used for
+	 *                         disambiguating potentially shared terms.
+	 * @return WP_Term|WP_Error|false Term object, if found. WP_Error if `$term_id` is shared between taxonomies and
+	 *                                there's insufficient data to distinguish which term is intended.
+	 *                                False for other failures.
 	 */
-	public static function get_instance( $term_id ) {
+	public static function get_instance( $term_id, $taxonomy = null ) {
 		global $wpdb;
 
 		$term_id = (int) $term_id;
@@ -129,15 +133,59 @@ final class WP_Term {
 		$_term = wp_cache_get( $term_id, 'terms' );
 
 		// If there isn't a cached version, hit the database.
-		if ( ! $_term ) {
+		if ( ! $_term || ( $taxonomy && $taxonomy !== $_term->taxonomy ) ) {
-			$_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id = %d LIMIT 1", $term_id ) );
+			// Grab all matching terms, in case any are shared between taxonomies.
+			$terms = $wpdb->get_results( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id = %d", $term_id ) );
+			if ( ! $terms ) {
+				return false;
+			}
+
+			// If a taxonomy was specified, find a match.
+			if ( $taxonomy ) {
+				foreach ( $terms as $match ) {
+					if ( $taxonomy === $match->taxonomy ) {
+						$_term = $match;
+						break;
+					}
+				}
+
+			// If only one match was found, it's the one we want.
+			} elseif ( 1 === count( $terms ) ) {
+				$_term = reset( $terms );
+
+			// Otherwise, the term must be shared between taxonomies.
+			} else {
+				// If the term is shared only with invalid taxonomies, return the one valid term.
+				foreach ( $terms as $t ) {
+					if ( ! taxonomy_exists( $t->taxonomy ) ) {
+						continue;
+					}
+
+					// Only hit if we've already identified a term in a valid taxonomy.
+					if ( $_term ) {
+						return new WP_Error( 'ambiguous_term_id', __( 'Term ID is shared between multiple taxonomies' ), $term_id );
+					}
+
+					$_term = $t;
+				}
+			}
+
 			if ( ! $_term ) {
 				return false;
 			}
 
+			// Don't return terms from invalid taxonomies.
+			if ( ! taxonomy_exists( $_term->taxonomy ) ) {
+				return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
+			}
+
 			$_term = sanitize_term( $_term, $_term->taxonomy, 'raw' );
+
+			// Don't cache terms that are shared between taxonomies.
+			if ( 1 === count( $terms ) ) {
 				wp_cache_add( $term_id, $_term, 'terms' );
 			}
+		}
 
 		$term_obj = new WP_Term( $_term );
 		$term_obj->filter( $term_obj->filter );

wp-includes/taxonomy-functions.php

@@ -764,25 +764,12 @@ function get_term( $term, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
 			$_term = WP_Term::get_instance( $term->term_id );
 		}
 	} else {
-		$_term = WP_Term::get_instance( $term );
+		$_term = WP_Term::get_instance( $term, $taxonomy );
 	}
 
-	// If `$taxonomy` was provided, make sure it matches the taxonomy of the located term.
+	if ( is_wp_error( $_term ) ) {
-	if ( $_term && $taxonomy && $taxonomy !== $_term->taxonomy ) {
+		return $_term;
-		// If there are two terms with the same ID, split the other one to a new term.
+	} elseif ( ! $_term ) {
-		$new_term_id = _split_shared_term( $_term->term_id, $_term->term_taxonomy_id );
-
-		// If no split occurred, this is an invalid request. Return null (not WP_Error) for back compat.
-		if ( $new_term_id === $_term->term_id ) {
-			return null;
-
-		// The term has been split. Refetch the term from the proper taxonomy.
-		} else {
-			return get_term( $_term->term_id, $taxonomy, $output, $filter );
-		}
-	}
-
-	if ( ! $_term ) {
 		return null;
 	}
 

wp-includes/version.php

@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.4-beta3-35536';
+$wp_version = '4.4-beta3-35537';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.