enmi-conf.org: comparison wp/wp-includes/class-wp-term-query.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 *
 * @since 4.6.0
 *
 * @see WP_Term_Query::__construct() for accepted arguments.
 */
+#[AllowDynamicProperties]
 class WP_Term_Query {
 	/**
 	 * SQL string used to perform database query.
 	 *
 	 * @since 4.6.0 Introduced 'term_taxonomy_id' parameter.
 	 * @since 4.7.0 Introduced 'object_ids' parameter.
 	 * @since 4.9.0 Added 'slug__in' support for 'orderby'.
 	 * @since 5.1.0 Introduced the 'meta_compare_key' parameter.
 	 * @since 5.3.0 Introduced the 'meta_type_key' parameter.
+	 * @since 6.4.0 Introduced the 'cache_results' parameter.
 	 *
 	 * @param string|array $query {
 	 *     Optional. Array or query string of term query parameters. Default empty.
 	 *
 	 *     @type string|string[] $taxonomy               Taxonomy name, or array of taxonomy names, to which results
 	 *     @type bool            $childless              True to limit results to terms that have no children.
 	 *                                                   This parameter has no effect on non-hierarchical taxonomies.
 	 *                                                   Default false.
 	 *     @type string          $cache_domain           Unique cache key to be produced when this query is stored in
 	 *                                                   an object cache. Default 'core'.
+	 *     @type bool            $cache_results          Whether to cache term information. Default true.
 	 *     @type bool            $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
 	 *     @type string|string[] $meta_key               Meta key or keys to filter by.
 	 *     @type string|string[] $meta_value             Meta value or values to filter by.
 	 *     @type string          $meta_compare           MySQL operator used for comparing the meta value.
-	 *                                                   See WP_Meta_Query::__construct for accepted values and default value.
+	 *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
 	 *     @type string          $meta_compare_key       MySQL operator used for comparing the meta key.
-	 *                                                   See WP_Meta_Query::__construct for accepted values and default value.
+	 *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
 	 *     @type string          $meta_type              MySQL data type that the meta_value column will be CAST to for comparisons.
-	 *                                                   See WP_Meta_Query::__construct for accepted values and default value.
+	 *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
 	 *     @type string          $meta_type_key          MySQL data type that the meta_key column will be CAST to for comparisons.
-	 *                                                   See WP_Meta_Query::__construct for accepted values and default value.
+	 *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
 	 *     @type array           $meta_query             An associative array of WP_Meta_Query arguments.
-	 *                                                   See WP_Meta_Query::__construct for accepted values.
+	 *                                                   See WP_Meta_Query::__construct() for accepted values.
 	 * }
 	 */
 	public function __construct( $query = '' ) {
 		$this->query_var_defaults = array(
 			'taxonomy'               => null,
 			'get'                    => '',
 			'child_of'               => 0,
 			'parent'                 => '',
 			'childless'              => false,
 			'cache_domain'           => 'core',
+			'cache_results'          => true,
 			'update_term_meta_cache' => true,
 			'meta_query'             => '',
 			'meta_key'               => '',
 			'meta_value'             => '',
 			'meta_type'              => '',
 	/**
 	 * Parse arguments passed to the term query with default query parameters.
 	 *
 	 * @since 4.6.0
 	 *
-	 * @param string|array $query WP_Term_Query arguments. See WP_Term_Query::__construct()
+	 * @param string|array $query WP_Term_Query arguments. See WP_Term_Query::__construct() for accepted arguments.
 	 */
 	public function parse_query( $query = '' ) {
 		if ( empty( $query ) ) {
 			$query = $this->query_vars;
 		}
 		$exclusions = array();
 		if ( ! empty( $exclude_tree ) ) {
 			$exclude_tree      = wp_parse_id_list( $exclude_tree );
 			$excluded_children = $exclude_tree;
 			foreach ( $exclude_tree as $extrunk ) {
 				$excluded_children = array_merge(
 					$excluded_children,
 					(array) get_terms(
 						array(
 							'hide_empty' => 0,
 						)
 					)
 				);
 			}
 			$exclusions = array_merge( $excluded_children, $exclusions );
 		}
 		if ( ! empty( $exclude ) ) {
 			$exclusions = array_merge( wp_parse_id_list( $exclude ), $exclusions );
 		 * @param string[] $taxonomies An array of taxonomy names.
 		 */
 		$exclusions = apply_filters( 'list_terms_exclusions', $exclusions, $args, $taxonomies );
 		if ( ! empty( $exclusions ) ) {
-			// Must do string manipulation here for backward compatibility with filter.
+			// Strip leading 'AND'. Must do string manipulation here for backward compatibility with filter.
 			$this->sql_clauses['where']['exclusions'] = preg_replace( '/^\s*AND\s*/', '', $exclusions );
 		}
 		if ( '' === $args['name'] ) {
 			$args['name'] = array();
 			$args['name'] = (array) $args['name'];
 		}
 		if ( ! empty( $args['name'] ) ) {
 			$names = $args['name'];
 			foreach ( $names as &$_name ) {
 				// `sanitize_term_field()` returns slashed data.
 				$_name = stripslashes( sanitize_term_field( 'name', $_name, 0, reset( $taxonomies ), 'db' ) );
 			}
 		$this->meta_query->parse_query_vars( $this->query_vars );
 		$mq_sql       = $this->meta_query->get_sql( 'term', 't', 'term_id' );
 		$meta_clauses = $this->meta_query->get_clauses();
 		if ( ! empty( $meta_clauses ) ) {
-			$join                                    .= $mq_sql['join'];
+			$join .= $mq_sql['join'];
+			// Strip leading 'AND'.
 			$this->sql_clauses['where']['meta_query'] = preg_replace( '/^\s*AND\s*/', '', $mq_sql['where'] );
-			$distinct                                .= 'DISTINCT';
+			$distinct .= 'DISTINCT';
 		}
 		$selects = array();
 		switch ( $args['fields'] ) {
 			$distinct = 'DISTINCT';
 		}
 		$where = implode( ' AND ', $this->sql_clauses['where'] );
-		$clauses = array( 'fields', 'join', 'where', 'distinct', 'orderby', 'order', 'limits' );
+		$pieces = array( 'fields', 'join', 'where', 'distinct', 'orderby', 'order', 'limits' );
 		/**
 		 * Filters the terms query SQL clauses.
 		 *
 		 * @since 3.1.0
 		 *     @type string $limits   The LIMIT clause of the query.
 		 * }
 		 * @param string[] $taxonomies An array of taxonomy names.
 		 * @param array    $args       An array of term query arguments.
 		 */
-		$clauses = apply_filters( 'terms_clauses', compact( $clauses ), $taxonomies, $args );
+		$clauses = apply_filters( 'terms_clauses', compact( $pieces ), $taxonomies, $args );
 		$fields   = isset( $clauses['fields'] ) ? $clauses['fields'] : '';
 		$join     = isset( $clauses['join'] ) ? $clauses['join'] : '';
 		$where    = isset( $clauses['where'] ) ? $clauses['where'] : '';
 		$distinct = isset( $clauses['distinct'] ) ? $clauses['distinct'] : '';
 		$orderby  = isset( $clauses['orderby'] ) ? $clauses['orderby'] : '';
 		$order    = isset( $clauses['order'] ) ? $clauses['order'] : '';
 		$limits   = isset( $clauses['limits'] ) ? $clauses['limits'] : '';
+		$fields_is_filtered = implode( ', ', $selects ) !== $fields;
 		if ( $where ) {
 			$where = "WHERE $where";
 		}
 		$this->sql_clauses['select']  = "SELECT $distinct $fields";
 		$this->sql_clauses['from']    = "FROM $wpdb->terms AS t $join";
 		$this->sql_clauses['orderby'] = $orderby ? "$orderby $order" : '';
 		$this->sql_clauses['limits']  = $limits;
-		$this->request = "
+		// Beginning of the string is on a new line to prevent leading whitespace. See https://core.trac.wordpress.org/ticket/56841.
-			{$this->sql_clauses['select']}
+		$this->request =
-			{$this->sql_clauses['from']}
+			"{$this->sql_clauses['select']}
-			{$where}
+			 {$this->sql_clauses['from']}
-			{$this->sql_clauses['orderby']}
+			 {$where}
-			{$this->sql_clauses['limits']}
+			 {$this->sql_clauses['orderby']}
-		";
+			 {$this->sql_clauses['limits']}";
 		$this->terms = null;
 		/**
 		 * Filters the terms array before the query takes place.
 		if ( null !== $this->terms ) {
 			return $this->terms;
 		}
-		// $args can be anything. Only use the args defined in defaults to compute the key.
+		if ( $args['cache_results'] ) {
-		$cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
+			$cache_key = $this->generate_cache_key( $args, $this->request );
+			$cache     = wp_cache_get( $cache_key, 'term-queries' );
-		unset( $cache_args['update_term_meta_cache'] );
+			if ( false !== $cache ) {
-		if ( 'count' !== $_fields && 'all_with_object_id' !== $_fields ) {
+				if ( 'ids' === $_fields ) {
-			$cache_args['fields'] = 'all';
+					$cache = array_map( 'intval', $cache );
-		}
+				} elseif ( 'count' !== $_fields ) {
+					if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) )
-		$key          = md5( serialize( $cache_args ) . serialize( $taxonomies ) . $this->request );
+					|| ( 'all' === $_fields && $args['pad_counts'] || $fields_is_filtered )
-		$last_changed = wp_cache_get_last_changed( 'terms' );
+					) {
-		$cache_key    = "get_terms:$key:$last_changed";
+						$term_ids = wp_list_pluck( $cache, 'term_id' );
-		$cache        = wp_cache_get( $cache_key, 'terms' );
+					} else {
+						$term_ids = array_map( 'intval', $cache );
-		if ( false !== $cache ) {
+					}
-			if ( 'ids' === $_fields ) {
-				$cache = array_map( 'intval', $cache );
+					_prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
-			} elseif ( 'count' !== $_fields ) {
-				if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) ) || ( 'all' === $_fields && $args['pad_counts'] ) ) {
+					$term_objects = $this->populate_terms( $cache );
-					$term_ids = wp_list_pluck( $cache, 'term_id' );
+					$cache        = $this->format_terms( $term_objects, $_fields );
-				} else {
-					$term_ids = array_map( 'intval', $cache );
 				}
-				_prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
-				$term_objects = $this->populate_terms( $cache );
+				$this->terms = $cache;
-				$cache        = $this->format_terms( $term_objects, $_fields );
+				return $this->terms;
 			}
-			$this->terms = $cache;
-			return $this->terms;
 		}
 		if ( 'count' === $_fields ) {
 			$count = $wpdb->get_var( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			wp_cache_set( $cache_key, $count, 'terms' );
+			if ( $args['cache_results'] ) {
+				wp_cache_set( $cache_key, $count, 'term-queries' );
+			}
 			return $count;
 		}
 		$terms = $wpdb->get_results( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 		if ( empty( $terms ) ) {
-			wp_cache_add( $cache_key, array(), 'terms' );
+			if ( $args['cache_results'] ) {
+				wp_cache_add( $cache_key, array(), 'term-queries' );
+			}
 			return array();
 		}
 		$term_ids = wp_list_pluck( $terms, 'term_id' );
 		_prime_term_caches( $term_ids, false );
 		// Make sure we show empty categories that have children.
 		if ( $hierarchical && $args['hide_empty'] && is_array( $term_objects ) ) {
 			foreach ( $term_objects as $k => $term ) {
 				if ( ! $term->count ) {
 					$children = get_term_children( $term->term_id, $term->taxonomy );
 					if ( is_array( $children ) ) {
 						foreach ( $children as $child_id ) {
 							$child = get_term( $child_id, $term->taxonomy );
 							if ( $child->count ) {
 								continue 2;
 		}
 		// Prime termmeta cache.
 		if ( $args['update_term_meta_cache'] ) {
 			$term_ids = wp_list_pluck( $term_objects, 'term_id' );
-			update_termmeta_cache( $term_ids );
+			wp_lazyload_term_meta( $term_ids );
 		}
 		if ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) ) {
 			$term_cache = array();
 			foreach ( $term_objects as $term ) {
 				$object          = new stdClass();
 				$object->term_id = $term->term_id;
 				$object->count   = $term->count;
 				$term_cache[]    = $object;
 			}
+		} elseif ( $fields_is_filtered ) {
+			$term_cache = $term_objects;
 		} else {
 			$term_cache = wp_list_pluck( $term_objects, 'term_id' );
 		}
-		wp_cache_add( $cache_key, $term_cache, 'terms' );
+		if ( $args['cache_results'] ) {
+			wp_cache_add( $cache_key, $term_cache, 'term-queries' );
+		}
 		$this->terms = $this->format_terms( $term_objects, $_fields );
 		return $this->terms;
 	}
 	/**
 	 * Parse and sanitize 'orderby' keys passed to the term query.
 	 *
 	 * @since 4.6.0
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
 	 *
 	 * @param string $orderby_raw Alias for the field to order by.
 	 * @return string|false Value to used in the ORDER clause. False otherwise.
 	 */
 	protected function parse_orderby( $orderby_raw ) {
 			}
 		}
 		return $term_objects;
 	}
+	/**
+	 * Generate cache key.
+	 *
+	 * @since 6.2.0
+	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
+	 *
+	 * @param array  $args WP_Term_Query arguments.
+	 * @param string $sql  SQL statement.
+	 *
+	 * @return string Cache key.
+	 */
+	protected function generate_cache_key( array $args, $sql ) {
+		global $wpdb;
+		// $args can be anything. Only use the args defined in defaults to compute the key.
+		$cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
+		unset( $cache_args['cache_results'], $cache_args['update_term_meta_cache'] );
+		if ( 'count' !== $args['fields'] && 'all_with_object_id' !== $args['fields'] ) {
+			$cache_args['fields'] = 'all';
+		}
+		$taxonomies = (array) $args['taxonomy'];
+		// Replace wpdb placeholder in the SQL statement used by the cache key.
+		$sql = $wpdb->remove_placeholder_escape( $sql );
+		$key          = md5( serialize( $cache_args ) . serialize( $taxonomies ) . $sql );
+		$last_changed = wp_cache_get_last_changed( 'terms' );
+		return "get_terms:$key:$last_changed";
+	}
 }

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef