Ticket #10142: 10142.diff

src/wp-admin/includes/schema.php

@@ -57 +57 @@
         $max_index_length = 191;
 
         // Blog specific tables.
-        $blog_tables = "CREATE TABLE $wpdb->terms (
+        $blog_tables = "CREATE TABLE $wpdb->termmeta (
+  meta_id bigint(20) unsigned NOT NULL auto_increment,
+  term_id bigint(20) unsigned NOT NULL default '0',
+  meta_key varchar(255) default NULL,
+  meta_value longtext,
+  PRIMARY KEY  (meta_id),
+  KEY term_id (term_id),
+  KEY meta_key (meta_key($max_index_length))
+) $charset_collate;
+CREATE TABLE $wpdb->terms (
  term_id bigint(20) unsigned NOT NULL auto_increment,
  name varchar(200) NOT NULL default '',
  slug varchar(200) NOT NULL default '',

src/wp-includes/default-filters.php

@@ -201 +201 @@
 add_filter( 'xmlrpc_pingback_error',    'xmlrpc_pingback_error'               );
 add_filter( 'title_save_pre',           'trim'                                );
 add_filter( 'get_comment_metadata',     'wp_lazyload_comment_meta',     10, 2 );
+add_filter( 'get_term_metadata',        'wp_lazyload_term_meta',        10, 2 );
 
 add_filter( 'http_request_host_is_external', 'allowed_http_request_hosts', 10, 2 );
 

src/wp-includes/taxonomy-functions.php

@@ -1003 +1003 @@
  *                                           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 is 'core'.
+ *     @type bool         $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
  * }
  * @return array|int|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies
  *                        do not exist.
@@ -1026 +1027 @@
                 'hide_empty' => true, 'exclude' => array(), 'exclude_tree' => array(), 'include' => array(),
                 'number' => '', 'fields' => 'all', 'name' => '', 'slug' => '', 'parent' => '', 'childless' => false,
                 'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '', 'description__like' => '',
-                'pad_counts' => false, 'offset' => '', 'search' => '', 'cache_domain' => 'core' );
+                'pad_counts' => false, 'offset' => '', 'search' => '', 'cache_domain' => 'core',
+                'update_term_meta_cache' => true );
         $args = wp_parse_args( $args, $defaults );
         $args['number'] = absint( $args['number'] );
         $args['offset'] = absint( $args['offset'] );
@@ -1364 +1366 @@
                 update_term_cache( $terms );
         }
 
+        // Prime termmeta cache.
+        if ( $args['update_term_meta_cache'] ) {
+                $term_ids = wp_list_pluck( $terms, 'term_id' );
+                update_termmeta_cache( $term_ids );
+        }
+
         if ( empty($terms) ) {
                 wp_cache_add( $cache_key, array(), 'terms', DAY_IN_SECONDS );
 
@@ -1445 +1453 @@
 }
 
 /**
+ * Add meta data field to a comment.
+ *
+ * @since 4.4.0
+ *
+ * @param int    $term_id    Term ID.
+ * @param string $meta_key   Metadata name.
+ * @param mixed  $meta_value Metadata value.
+ * @param bool   $unique     Optional, default is false. Whether the same key should not be added.
+ * @return int|bool Meta ID on success, false on failure.
+ */
+function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
+        return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
+}
+
+/**
+ * Remove metadata matching criteria from a term.
+ *
+ * You can match based on the key, or key and value. Removing based on key and
+ * value, will keep from removing duplicate metadata with the same key. It also
+ * allows removing all metadata matching key, if needed.
+ *
+ * @since 4.4.0
+ *
+ * @param int    $term_id    Term ID.
+ * @param string $meta_key   Metadata name.
+ * @param mixed  $meta_value Optional. Metadata value.
+ * @return bool True on success, false on failure.
+ */
+function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
+        return delete_metadata( 'term', $term_id, $meta_key, $meta_value );
+}
+
+/**
+ * Retrieve meta field for a term.
+ *
+ * @since 4.4.0
+ *
+ * @param int    $term_id Term ID.
+ * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
+ * @param bool   $single  Whether to return a single value.
+ * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
+ *  is true.
+ */
+function get_term_meta( $term_id, $key = '', $single = false ) {
+        return get_metadata( 'term', $term_id, $key, $single );
+}
+
+/**
+ * Update term meta field based on term ID.
+ *
+ * Use the $prev_value parameter to differentiate between meta fields with the
+ * same key and term ID.
+ *
+ * If the meta field for the term does not exist, it will be added.
+ *
+ * @since 4.4.0
+ *
+ * @param int    $term_id    Term ID.
+ * @param string $meta_key   Metadata key.
+ * @param mixed  $meta_value Metadata value.
+ * @param mixed  $prev_value Optional. Previous value to check before removing.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
+ */
+function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
+        return update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
+}
+
+/**
+ * Updates metadata cache for list of term IDs.
+ *
+ * Performs SQL query to retrieve the metadata for the term IDs and updates the
+ * metadata cache for the terms. Therefore, the functions, which call this
+ * function, do not need to perform SQL queries on their own.
+ *
+ * @since 4.4.0
+ *
+ * @param array $term_ids List of post IDs.
+ * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
+ */
+function update_termmeta_cache( $term_ids ) {
+        return update_meta_cache( 'term', $term_ids );
+}
+
+/**
+ * Lazy load termmeta when inside of a `WP_Query` loop.
+ *
+ * @since 4.4.0
+ *
+ * @param null $check   The `$check` param passed from the 'pre_term_metadata' hook.
+ * @param int  $term_id ID of the term whose metadata is being cached.
+ * @return null In order not to short-circuit `get_metadata()`.
+ */
+function wp_lazyload_term_meta( $check, $term_id ) {
+        global $wp_query;
+
+        if ( $wp_query instanceof WP_Query && ! empty( $wp_query->posts ) && ! empty( $wp_query->get( 'update_post_term_cache' ) ) ) {
+                // We can only lazyload if the entire post object is present.
+                $posts = array();
+                foreach ( $wp_query->posts as $post ) {
+                        if ( $post instanceof WP_Post ) {
+                                $posts[] = $post;
+                        }
+                }
+
+                if ( empty( $posts ) ) {
+                        return;
+                }
+
+                // Fetch cached term_ids for each post. Keyed by term_id for faster lookup.
+                $term_ids = array();
+                foreach ( $posts as $post ) {
+                        $taxonomies = get_object_taxonomies( $post->post_type );
+                        foreach ( $taxonomies as $taxonomy ) {
+                                $terms = get_object_term_cache( $post->ID, $taxonomy );
+                                if ( false !== $terms ) {
+                                        foreach ( $terms as $term ) {
+                                                if ( ! isset( $term_ids[ $term->term_id ] ) ) {
+                                                        $term_ids[ $term->term_id ] = 1;
+                                                }
+                                        }
+                                }
+                        }
+                }
+
+                if ( $term_ids ) {
+                        update_termmeta_cache( array_keys( $term_ids ) );
+                }
+        }
+
+        return $check;
+}
+
+/**
  * Check if Term exists.
  *
  * Formerly is_term(), introduced in 2.3.0.
@@ -2016 +2157 @@
  *                           term objects being returned, 'ids' will return an array of integers, and 'names' an array
  *                           of strings.
  *     @type int    $parent  Optional. Limit results to the direct children of a given term ID.
+ *     @type bool   $update_term_meta_cache Whether to prime termmeta cache for matched terms. Only applies when
+ *                                          `$fields` is 'all', 'all_with_object_id', or 'term_id'. Default: true.
  * }
  * @return array|WP_Error The requested term data or empty array if no terms found.
  *                        WP_Error if any of the $taxonomies don't exist.
@@ -2043 +2186 @@
                 'order'   => 'ASC',
                 'fields'  => 'all',
                 'parent'  => '',
+                'update_term_meta_cache' => true,
         );
         $args = wp_parse_args( $args, $defaults );
 
@@ -2143 +2287 @@
                 }
         }
 
+        // Update termmeta cache, if necessary.
+        if ( $args['update_term_meta_cache'] && ( 'all' === $fields || 'all_with_object_ids' === $fields || 'term_id' === $fields ) ) {
+                if ( 'term_id' === $fields ) {
+                        $term_ids = $fields;
+                } else {
+                        $term_ids = wp_list_pluck( $terms, 'term_id' );
+                }
+
+                update_termmeta_cache( $term_ids );
+        }
+
         if ( ! $terms ) {
                 $terms = array();
         } elseif ( $objects && 'all_with_object_id' !== $fields ) {
@@ -3278 +3433 @@
         $terms = wp_get_object_terms( $ids, $taxonomies, array(
                 'fields' => 'all_with_object_id',
                 'orderby' => 'none',
+                'update_term_meta_cache' => false,
         ) );
 
         $object_terms = array();

src/wp-includes/wp-db.php

@@ -266 +266 @@
          * @var array
          */
         var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta',
-                'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' );
+                'terms', 'term_taxonomy', 'term_relationships', 'termmeta', 'commentmeta' );
 
         /**
          * List of deprecated WordPress tables
@@ -382 +382 @@
          */
         public $term_taxonomy;
 
+        /**
+         * WordPress Term Meta table.
+         *
+         * @since 4.4.0
+         * @access public
+         * @var string
+         */
+        public $termmeta;
+
         /*
          * Global and Multisite tables
          */

tests/phpunit/tests/term/getTerms.php

@@ -22 +22 @@
                 $num_queries = $wpdb->num_queries;
 
                 // last_changed and num_queries should bump
-                $terms = get_terms( 'post_tag' );
+                $terms = get_terms( 'post_tag', array( 'update_term_meta_cache' => false ) );
                 $this->assertEquals( 3, count( $terms ) );
                 $time1 = wp_cache_get( 'last_changed', 'terms' );
                 $this->assertNotEmpty( $time1 );
@@ -31 +31 @@
                 $num_queries = $wpdb->num_queries;
 
                 // Again. last_changed and num_queries should remain the same.
-                $terms = get_terms( 'post_tag' );
+                $terms = get_terms( 'post_tag', array( 'update_term_meta_cache' => false ) );
                 $this->assertEquals( 3, count( $terms ) );
                 $this->assertEquals( $time1, wp_cache_get( 'last_changed', 'terms' ) );
                 $this->assertEquals( $num_queries, $wpdb->num_queries );
@@ -1502 +1502 @@
                 }
         }
 
+        /**
+         * @ticket 10142
+         */
+        public function test_termmeta_cache_should_be_primed_by_default() {
+                global $wpdb;
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                $terms = $this->factory->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $terms[0], 'foo', 'bar' );
+                add_term_meta( $terms[1], 'foo', 'bar' );
+                add_term_meta( $terms[2], 'foo', 'bar' );
+
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'include' => $terms,
+                ) );
+
+                $num_queries = $wpdb->num_queries;
+
+                foreach ( $terms as $t ) {
+                        $this->assertSame( 'bar', get_term_meta( $t, 'foo', true ) );
+                }
+
+                $this->assertSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @ticket 10142
+         */
+        public function test_termmeta_cache_should_not_be_primed_when_update_term_meta_cache_is_false() {
+                global $wpdb;
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                $terms = $this->factory->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $terms[0], 'foo', 'bar' );
+                add_term_meta( $terms[1], 'foo', 'bar' );
+                add_term_meta( $terms[2], 'foo', 'bar' );
+
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'include' => $terms,
+                        'update_term_meta_cache' => false,
+                ) );
+
+                $num_queries = $wpdb->num_queries;
+
+                foreach ( $terms as $t ) {
+                        $this->assertSame( 'bar', get_term_meta( $t, 'foo', true ) );
+                }
+
+                $this->assertSame( $num_queries + 3, $wpdb->num_queries );
+        }
+
         protected function create_hierarchical_terms_and_posts() {
                 $terms = array();
 

new file tests/phpunit/tests/term/meta.php

@@ +1 @@
+<?php
+
+/**
+ * @group taxonomy
+ * @group meta
+ * @ticket 10142
+ */
+class Tests_Term_Meta extends WP_UnitTestCase {
+        public function setUp() {
+                parent::setUp();
+                register_taxonomy( 'wptests_tax', 'post' );
+        }
+
+        public function test_add() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+                $this->assertNotEmpty( add_term_meta( $t, 'foo', 'bar' ) );
+        }
+
+        public function test_add_unique() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+                $this->assertNotEmpty( add_term_meta( $t, 'foo', 'bar' ) );
+                $this->assertFalse( add_term_meta( $t, 'foo', 'bar', true ) );
+        }
+
+        public function test_delete() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $t, 'foo', 'bar' );
+
+                $this->assertTrue( delete_term_meta( $t, 'foo' ) );
+        }
+
+        public function test_delete_with_invalid_meta_key_should_return_false() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+                $this->assertFalse( delete_term_meta( $t, 'foo' ) );
+        }
+
+        public function test_delete_should_respect_meta_value() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $t, 'foo', 'bar' );
+                add_term_meta( $t, 'foo', 'baz' );
+
+                $this->assertTrue( delete_term_meta( $t, 'foo', 'bar' ) );
+
+                $metas = get_term_meta( $t, 'foo', false );
+                $this->assertSame( array( 'baz' ), $metas );
+        }
+
+        public function test_get_with_no_key_should_fetch_all_keys() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $t, 'foo', 'bar' );
+                add_term_meta( $t, 'foo1', 'baz' );
+
+                $found = get_term_meta( $t );
+                $expected = array(
+                        'foo' => array( 'bar' ),
+                        'foo1' => array( 'baz' ),
+                );
+
+                $this->assertEqualSets( $expected, $found );
+        }
+
+        public function test_get_with_key_should_fetch_all_for_key() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $t, 'foo', 'bar' );
+                add_term_meta( $t, 'foo', 'baz' );
+                add_term_meta( $t, 'foo1', 'baz' );
+
+                $found = get_term_meta( $t, 'foo' );
+                $expected = array( 'bar', 'baz' );
+
+                $this->assertEqualSets( $expected, $found );
+        }
+
+        public function test_get_should_respect_single_true() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $t, 'foo', 'bar' );
+                add_term_meta( $t, 'foo', 'baz' );
+
+                $found = get_term_meta( $t, 'foo', true );
+                $this->assertEquals( 'bar', $found );
+        }
+
+        public function test_update_should_pass_to_add_when_no_value_exists_for_key() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+                $actual = update_term_meta( $t, 'foo', 'bar' );
+                $this->assertInternalType( 'int', $actual );
+                $this->assertNotEmpty( $actual );
+
+                $meta = get_term_meta( $t, 'foo', true );
+                $this->assertSame( 'bar', $meta );
+        }
+
+        public function test_update_should_return_true_when_updating_existing_value_for_key() {
+                $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+                add_term_meta( $t, 'foo', 'bar' );
+
+                $actual = update_term_meta( $t, 'foo', 'baz' );
+                $this->assertTrue( $actual );
+
+                $meta = get_term_meta( $t, 'foo', true );
+                $this->assertSame( 'baz', $meta );
+        }
+
+        public function test_term_meta_should_be_lazy_loaded_for_all_terms_in_wp_query_loop() {
+                global $wpdb;
+
+                $p = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                $terms = $this->factory->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+                wp_set_object_terms( $p, $terms, 'wptests_tax' );
+                foreach ( $terms as $t ) {
+                        add_term_meta( $t, 'foo', 'bar' );
+                }
+
+                // Create another term, which should *not* be lazy loaded because it's unattached.
+                $orphan_term = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $orphan_term, 'foo', 'bar' );
+
+                $this->go_to( get_permalink( $p ) );
+
+                if ( have_posts() ) {
+                        while ( have_posts() ) {
+                                the_post();
+
+                                // First request will hit the database.
+                                $num_queries = $wpdb->num_queries;
+                                $this->assertSame( 'bar', get_term_meta( $terms[0], 'foo', true ) );
+                                $this->assertSame( $num_queries + 1, $wpdb->num_queries );
+
+                                // Second and third requests should be in cache.
+                                $this->assertSame( 'bar', get_term_meta( $terms[1], 'foo', true ) );
+                                $this->assertSame( 'bar', get_term_meta( $terms[2], 'foo', true ) );
+                                $this->assertSame( $num_queries + 1, $wpdb->num_queries );
+
+                                // Querying a term not primed should result in a hit.
+                                $this->assertSame( 'bar', get_term_meta( $orphan_term, 'foo', true ) );
+                                $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+                        }
+                }
+        }
+}

tests/phpunit/tests/term/wpGetObjectTerms.php

@@ -418 +418 @@
                 $this->assertEqualSets( array( $t1, $t2 ), $found );
         }
 
+        /**
+         * @ticket 10142
+         */
+        public function test_termmeta_cache_should_be_primed_by_default() {
+                global $wpdb;
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                $terms = $this->factory->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $terms[0], 'foo', 'bar' );
+                add_term_meta( $terms[1], 'foo', 'bar' );
+                add_term_meta( $terms[2], 'foo', 'bar' );
+
+                $p = $this->factory->post->create();
+                wp_set_object_terms( $p, $terms, 'wptests_tax' );
+
+                $found = wp_get_object_terms( $p, 'wptests_tax' );
+
+                $num_queries = $wpdb->num_queries;
+
+                foreach ( $terms as $t ) {
+                        $this->assertSame( 'bar', get_term_meta( $t, 'foo', true ) );
+                }
+
+                $this->assertSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @ticket 10142
+         */
+        public function test_termmeta_cache_should_not_be_primed_when_update_term_meta_cache_is_false() {
+                global $wpdb;
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                $terms = $this->factory->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+                add_term_meta( $terms[0], 'foo', 'bar' );
+                add_term_meta( $terms[1], 'foo', 'bar' );
+                add_term_meta( $terms[2], 'foo', 'bar' );
+
+                $p = $this->factory->post->create();
+                wp_set_object_terms( $p, $terms, 'wptests_tax' );
+
+                $found = wp_get_object_terms( $p, 'wptests_tax', array(
+                        'update_term_meta_cache' => false,
+                ) );
+
+                $num_queries = $wpdb->num_queries;
+
+                foreach ( $terms as $t ) {
+                        $this->assertSame( 'bar', get_term_meta( $t, 'foo', true ) );
+                }
+
+                $this->assertSame( $num_queries + 3, $wpdb->num_queries );
+        }
+
         public function filter_get_object_terms( $terms ) {
                 $term_ids = wp_list_pluck( $terms, 'term_id' );
                 // all terms should still be objects