mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
7f79d26ca5
`add_term_meta()` and `update_term_meta()` identify terms by `$term_id`. In cases where a term is shared between taxonomies, `$term_id` is insufficient to distinguish where the metadata belongs. When attempting to add/update termmeta on a shared term, a `WP_Error` object is returned. This gives developers enough information to decide whether they'd like to force the term to be split and retry the save, or show an error in the UI, or whatever. Props boonebgorges, mboynes, DH-Shredder, jorbin, aaroncampbell. Fixes #34544. git-svn-id: https://develop.svn.wordpress.org/trunk@35515 602fd350-edb4-49c9-b593-d223f7449a82
388 lines
11 KiB
PHP
388 lines
11 KiB
PHP
<?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 = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
|
|
|
|
$this->assertNotEmpty( add_term_meta( $t, 'foo', 'bar' ) );
|
|
}
|
|
|
|
public function test_add_unique() {
|
|
$t = self::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 = self::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 = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
|
|
|
|
$this->assertFalse( delete_term_meta( $t, 'foo' ) );
|
|
}
|
|
|
|
public function test_delete_should_respect_meta_value() {
|
|
$t = self::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 = self::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 = self::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 = self::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 = self::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 = self::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 = self::factory()->post->create( array( 'post_status' => 'publish' ) );
|
|
|
|
register_taxonomy( 'wptests_tax', 'post' );
|
|
$terms = self::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 = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
|
|
add_term_meta( $orphan_term, 'foo', 'bar' );
|
|
|
|
// Force results to be cached, even when using extended cache.
|
|
add_action( 'pre_get_posts', array( $this, 'set_cache_results' ) );
|
|
$this->go_to( get_permalink( $p ) );
|
|
remove_action( 'pre_get_posts', array( $this, 'set_cache_results' ) );
|
|
|
|
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 );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @ticket 34073
|
|
*/
|
|
public function test_term_meta_should_be_lazy_loaded_only_for_the_queries_in_which_the_term_has_posts() {
|
|
global $wpdb;
|
|
|
|
$posts = self::factory()->post->create_many( 3, array( 'post_status' => 'publish' ) );
|
|
register_taxonomy( 'wptests_tax', 'post' );
|
|
$terms = self::factory()->term->create_many( 6, array( 'taxonomy' => 'wptests_tax' ) );
|
|
|
|
wp_set_object_terms( $posts[0], array( $terms[0], $terms[1] ), 'wptests_tax' );
|
|
wp_set_object_terms( $posts[1], array( $terms[2], $terms[3] ), 'wptests_tax' );
|
|
wp_set_object_terms( $posts[2], array( $terms[0], $terms[4], $terms[5] ), 'wptests_tax' );
|
|
|
|
foreach ( $terms as $t ) {
|
|
add_term_meta( $t, 'foo', 'bar' );
|
|
}
|
|
|
|
$q0 = new WP_Query( array( 'p' => $posts[0], 'cache_results' => true ) );
|
|
$q1 = new WP_Query( array( 'p' => $posts[1], 'cache_results' => true ) );
|
|
$q2 = new WP_Query( array( 'p' => $posts[2], 'cache_results' => true ) );
|
|
|
|
/*
|
|
* $terms[0] belongs to both $posts[0] and $posts[2], so `get_term_meta( $terms[0] )` should prime
|
|
* the cache for term matched by $q0 and $q2.
|
|
*/
|
|
|
|
// First request will hit the database.
|
|
$num_queries = $wpdb->num_queries;
|
|
|
|
// Prime caches.
|
|
$this->assertSame( 'bar', get_term_meta( $terms[0], 'foo', true ) );
|
|
|
|
// Two queries: one for $q0 and one for $q2.
|
|
$num_queries += 2;
|
|
$this->assertSame( $num_queries, $wpdb->num_queries );
|
|
|
|
// Next requests should be in cache.
|
|
$this->assertSame( 'bar', get_term_meta( $terms[1], 'foo', true ) );
|
|
$this->assertSame( 'bar', get_term_meta( $terms[4], 'foo', true ) );
|
|
$this->assertSame( 'bar', get_term_meta( $terms[5], 'foo', true ) );
|
|
$this->assertSame( $num_queries, $wpdb->num_queries );
|
|
|
|
// Querying for $terms[2] will prime $terms[3] as well.
|
|
$this->assertSame( 'bar', get_term_meta( $terms[2], 'foo', true ) );
|
|
$num_queries++;
|
|
$this->assertSame( $num_queries, $wpdb->num_queries );
|
|
|
|
$this->assertSame( 'bar', get_term_meta( $terms[3], 'foo', true ) );
|
|
$this->assertSame( $num_queries, $wpdb->num_queries );
|
|
}
|
|
|
|
public function test_adding_term_meta_should_bust_get_terms_cache() {
|
|
$terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
|
|
|
|
add_term_meta( $terms[0], 'foo', 'bar' );
|
|
|
|
// Prime cache.
|
|
$found = get_terms( 'wptests_tax', array(
|
|
'hide_empty' => false,
|
|
'fields' => 'ids',
|
|
'meta_query' => array(
|
|
array(
|
|
'key' => 'foo',
|
|
'value' => 'bar',
|
|
),
|
|
),
|
|
) );
|
|
|
|
$this->assertEqualSets( array( $terms[0] ), $found );
|
|
|
|
add_term_meta( $terms[1], 'foo', 'bar' );
|
|
|
|
$found = get_terms( 'wptests_tax', array(
|
|
'hide_empty' => false,
|
|
'fields' => 'ids',
|
|
'meta_query' => array(
|
|
array(
|
|
'key' => 'foo',
|
|
'value' => 'bar',
|
|
),
|
|
),
|
|
) );
|
|
|
|
$this->assertEqualSets( array( $terms[0], $terms[1] ), $found );
|
|
}
|
|
|
|
public function test_updating_term_meta_should_bust_get_terms_cache() {
|
|
$terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
|
|
|
|
add_term_meta( $terms[0], 'foo', 'bar' );
|
|
add_term_meta( $terms[1], 'foo', 'baz' );
|
|
|
|
// Prime cache.
|
|
$found = get_terms( 'wptests_tax', array(
|
|
'hide_empty' => false,
|
|
'fields' => 'ids',
|
|
'meta_query' => array(
|
|
array(
|
|
'key' => 'foo',
|
|
'value' => 'bar',
|
|
),
|
|
),
|
|
) );
|
|
|
|
$this->assertEqualSets( array( $terms[0] ), $found );
|
|
|
|
update_term_meta( $terms[1], 'foo', 'bar' );
|
|
|
|
$found = get_terms( 'wptests_tax', array(
|
|
'hide_empty' => false,
|
|
'fields' => 'ids',
|
|
'meta_query' => array(
|
|
array(
|
|
'key' => 'foo',
|
|
'value' => 'bar',
|
|
),
|
|
),
|
|
) );
|
|
|
|
$this->assertEqualSets( array( $terms[0], $terms[1] ), $found );
|
|
}
|
|
|
|
public function test_deleting_term_meta_should_bust_get_terms_cache() {
|
|
$terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
|
|
|
|
add_term_meta( $terms[0], 'foo', 'bar' );
|
|
add_term_meta( $terms[1], 'foo', 'bar' );
|
|
|
|
// Prime cache.
|
|
$found = get_terms( 'wptests_tax', array(
|
|
'hide_empty' => false,
|
|
'fields' => 'ids',
|
|
'meta_query' => array(
|
|
array(
|
|
'key' => 'foo',
|
|
'value' => 'bar',
|
|
),
|
|
),
|
|
) );
|
|
|
|
$this->assertEqualSets( array( $terms[0], $terms[1] ), $found );
|
|
|
|
delete_term_meta( $terms[1], 'foo', 'bar' );
|
|
|
|
$found = get_terms( 'wptests_tax', array(
|
|
'hide_empty' => false,
|
|
'fields' => 'ids',
|
|
'meta_query' => array(
|
|
array(
|
|
'key' => 'foo',
|
|
'value' => 'bar',
|
|
),
|
|
),
|
|
) );
|
|
|
|
$this->assertEqualSets( array( $terms[0] ), $found );
|
|
}
|
|
|
|
/**
|
|
* @ticket 34544
|
|
*/
|
|
public function test_add_term_meta_should_return_error_when_term_id_is_shared() {
|
|
global $wpdb;
|
|
|
|
update_option( 'finished_splitting_shared_terms', false );
|
|
|
|
register_taxonomy( 'wptests_tax', 'post' );
|
|
register_taxonomy( 'wptests_tax_2', 'post' );
|
|
register_taxonomy( 'wptests_tax_3', 'post' );
|
|
|
|
$t1 = wp_insert_term( 'Foo', 'wptests_tax' );
|
|
$t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
|
|
$t3 = wp_insert_term( 'Foo', 'wptests_tax_3' );
|
|
|
|
// Manually modify because shared terms shouldn't naturally occur.
|
|
$wpdb->update( $wpdb->term_taxonomy,
|
|
array( 'term_id' => $t1['term_id'] ),
|
|
array( 'term_taxonomy_id' => $t2['term_taxonomy_id'] ),
|
|
array( '%d' ),
|
|
array( '%d' )
|
|
);
|
|
|
|
$wpdb->update( $wpdb->term_taxonomy,
|
|
array( 'term_id' => $t1['term_id'] ),
|
|
array( 'term_taxonomy_id' => $t3['term_taxonomy_id'] ),
|
|
array( '%d' ),
|
|
array( '%d' )
|
|
);
|
|
|
|
$found = add_term_meta( $t1['term_id'], 'bar', 'baz' );
|
|
$this->assertWPError( $found );
|
|
$this->assertSame( 'ambiguous_term_id', $found->get_error_code() );
|
|
}
|
|
|
|
/**
|
|
* @ticket 34544
|
|
*/
|
|
public function test_update_term_meta_should_return_error_when_term_id_is_shared() {
|
|
global $wpdb;
|
|
|
|
update_option( 'finished_splitting_shared_terms', false );
|
|
|
|
register_taxonomy( 'wptests_tax', 'post' );
|
|
$t1 = wp_insert_term( 'Foo', 'wptests_tax' );
|
|
add_term_meta( $t1, 'foo', 'bar' );
|
|
|
|
register_taxonomy( 'wptests_tax_2', 'post' );
|
|
register_taxonomy( 'wptests_tax_3', 'post' );
|
|
|
|
$t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
|
|
$t3 = wp_insert_term( 'Foo', 'wptests_tax_3' );
|
|
|
|
// Manually modify because shared terms shouldn't naturally occur.
|
|
$wpdb->update( $wpdb->term_taxonomy,
|
|
array( 'term_id' => $t1['term_id'] ),
|
|
array( 'term_taxonomy_id' => $t2['term_taxonomy_id'] ),
|
|
array( '%d' ),
|
|
array( '%d' )
|
|
);
|
|
|
|
$wpdb->update( $wpdb->term_taxonomy,
|
|
array( 'term_id' => $t1['term_id'] ),
|
|
array( 'term_taxonomy_id' => $t3['term_taxonomy_id'] ),
|
|
array( '%d' ),
|
|
array( '%d' )
|
|
);
|
|
|
|
$found = update_term_meta( $t1['term_id'], 'foo', 'baz' );
|
|
$this->assertWPError( $found );
|
|
$this->assertSame( 'ambiguous_term_id', $found->get_error_code() );
|
|
}
|
|
|
|
public static function set_cache_results( $q ) {
|
|
$q->set( 'cache_results', true );
|
|
}
|
|
}
|