Changeset 29862

Timestamp:

10/09/2014 02:31:35 AM (10 years ago)

Author:

boonebgorges

Message:

Improve 'alias_of' handling in wp_insert_term() and wp_update_term().

Using get_term_by() rather than direct SQL queries to fetch the alias term
fixes a number of issues:

• Object cache for aliased term is properly cleared after update.
• If the aliased term is in the object cache, it's served from there, saving a database query.
• Duplicate 'edit_terms' and 'edited_terms' hooks can be removed.
• Fix a PHP notice when the 'alias_of' term is not found.
• Prevent the incorrect creation of a new term group for the primary term when the 'alias_of' term is not found.

Adds unit tests for 'alias_of' functionality in both functions.

Fixes #29848.

Location:

trunk

Files:

• src/wp-includes/taxonomy.php (modified) (4 diffs)
• tests/phpunit/tests/term.php (modified) (2 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -2449 +2449 @@
     $term_group = 0;
     if ( $args['alias_of'] ) {
-        $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $args['alias_of'] ) );
-        if ( $alias->term_group ) {
+        $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy );
+        if ( ! empty( $alias->term_group ) ) {
             // The alias we want is already in a group, so let's use that one.
             $term_group = $alias->term_group;
-        } else {
-            // The alias isn't in a group, so let's create a new one and firstly add the alias term to it.
+        } else if ( ! empty( $alias->term_id ) ) {
+            /*
+             * The alias is not in a group, so we create a new one
+             * and add the alias to it.
+             */
             $term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
 
-            /**
-             * Fires immediately before the given terms are edited.
-             *
-             * @since 2.9.0
-             *
-             * @param int    $term_id  Term ID.
-             * @param string $taxonomy Taxonomy slug.
-             */
-            do_action( 'edit_terms', $alias->term_id, $taxonomy );
-            $wpdb->update($wpdb->terms, compact('term_group'), array('term_id' => $alias->term_id) );
-
-            /**
-             * Fires immediately after the given terms are edited.
-             *
-             * @since 2.9.0
-             *
-             * @param int    $term_id  Term ID
-             * @param string $taxonomy Taxonomy slug.
-             */
-            do_action( 'edited_terms', $alias->term_id, $taxonomy );
+            wp_update_term( $alias->term_id, $taxonomy, array(
+                'term_group' => $term_group,
+            ) );
         }
     }
@@ -2961 +2947 @@
     $term_group = isset( $parsed_args['term_group'] ) ? $parsed_args['term_group'] : 0;
     if ( $args['alias_of'] ) {
-        $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $args['alias_of'] ) );
-        if ( $alias->term_group ) {
+        $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy );
+        if ( ! empty( $alias->term_group ) ) {
             // The alias we want is already in a group, so let's use that one.
             $term_group = $alias->term_group;
-        } else {
-            // The alias isn't in a group, so let's create a new one and firstly add the alias term to it.
+        } else if ( ! empty( $alias->term_id ) ) {
+            /*
+             * The alias is not in a group, so we create a new one
+             * and add the alias to it.
+             */
             $term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
 
-            /** This action is documented in wp-includes/taxonomy.php */
-            do_action( 'edit_terms', $alias->term_id, $taxonomy );
-            $wpdb->update( $wpdb->terms, compact('term_group'), array( 'term_id' => $alias->term_id ) );
-
-            /** This action is documented in wp-includes/taxonomy.php */
-            do_action( 'edited_terms', $alias->term_id, $taxonomy );
+            wp_update_term( $alias->term_id, $taxonomy, array(
+                'term_group' => $term_group,
+            ) );
         }
 
@@ -3006 +2992 @@
     }
 
-    /** This action is documented in wp-includes/taxonomy.php */
+    /**
+     * Fires immediately before the given terms are edited.
+     *
+     * @since 2.9.0
+     *
+     * @param int    $term_id  Term ID.
+     * @param string $taxonomy Taxonomy slug.
+     */
     do_action( 'edit_terms', $term_id, $taxonomy );
     $wpdb->update($wpdb->terms, compact( 'name', 'slug', 'term_group' ), compact( 'term_id' ) );
@@ -3014 +3007 @@
     }
 
-    /** This action is documented in wp-includes/taxonomy.php */
+    /**
+     * Fires immediately after the given terms are edited.
+     *
+     * @since 2.9.0
+     *
+     * @param int    $term_id  Term ID
+     * @param string $taxonomy Taxonomy slug.
+     */
     do_action( 'edited_terms', $term_id, $taxonomy );
 

trunk/tests/phpunit/tests/term.php

@@ -418 +418 @@
     }
 
+    public function test_wp_insert_term_alias_of_no_term_group() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $t1 = $this->factory->term->create( array(
+            'taxonomy' => 'wptests_tax',
+        ) );
+        $term_1 = get_term( $t1, 'wptests_tax' );
+
+        $created_term_ids = wp_insert_term( 'Foo', 'wptests_tax', array(
+            'alias_of' => $term_1->slug,
+        ) );
+        $created_term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+
+        $updated_term_1 = get_term( $term_1->term_id, 'wptests_tax' );
+
+        $term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertSame( 0, $term_1->term_group );
+        $this->assertNotEmpty( $created_term->term_group );
+        $this->assertSame( $created_term->term_group, $updated_term_1->term_group );
+    }
+
+    public function test_wp_insert_term_alias_of_existing_term_group() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $t1 = $this->factory->term->create( array(
+            'taxonomy' => 'wptests_tax',
+        ) );
+        $term_1 = get_term( $t1, 'wptests_tax' );
+
+        $t2 = $this->factory->term->create( array(
+            'taxonomy' => 'wptests_tax',
+            'alias_of' => $term_1->slug,
+        ) );
+        $term_2 = get_term( $t2, 'wptests_tax' );
+
+        $created_term_ids = wp_insert_term( 'Foo', 'wptests_tax', array(
+            'alias_of' => $term_2->slug,
+        ) );
+        $created_term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertNotEmpty( $created_term->term_group );
+        $this->assertSame( $created_term->term_group, $term_2->term_group );
+    }
+
+    public function test_wp_insert_term_alias_of_nonexistent_term() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $created_term_ids = wp_insert_term( 'Foo', 'wptests_tax', array(
+            'alias_of' => 'foo',
+        ) );
+        $created_term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertSame( 0, $created_term->term_group );
+    }
+
     public function test_wp_insert_term_duplicate_name_slug_non_hierarchical() {
         register_taxonomy( 'foo', 'post', array() );
@@ -538 +594 @@
     }
 
+    public function test_wp_update_term_alias_of_no_term_group() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $t1 = $this->factory->term->create( array(
+            'taxonomy' => 'wptests_tax',
+        ) );
+        $term_1 = get_term( $t1, 'wptests_tax' );
+
+        $created_term_ids = wp_insert_term( 'Foo', 'wptests_tax' );
+        wp_update_term( $created_term_ids['term_id'], 'wptests_tax', array(
+            'alias_of' => $term_1->slug,
+        ) );
+        $created_term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+
+        $updated_term_1 = get_term( $t1, 'wptests_tax' );
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertSame( 0, $term_1->term_group );
+        $this->assertNotEmpty( $created_term->term_group );
+        $this->assertSame( $created_term->term_group, $updated_term_1->term_group );
+    }
+
+    public function test_wp_update_term_alias_of_existing_term_group() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $t1 = $this->factory->term->create( array(
+            'taxonomy' => 'wptests_tax',
+        ) );
+        $term_1 = get_term( $t1, 'wptests_tax' );
+
+        $t2 = $this->factory->term->create( array(
+            'taxonomy' => 'wptests_tax',
+            'alias_of' => $term_1->slug,
+        ) );
+        $term_2 = get_term( $t2, 'wptests_tax' );
+
+        $created_term_ids = wp_insert_term( 'Foo', 'wptests_tax' );
+        wp_update_term( $created_term_ids['term_id'], 'wptests_tax', array(
+            'alias_of' => $term_2->slug,
+        ) );
+        $created_term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertNotEmpty( $created_term->term_group );
+        $this->assertSame( $created_term->term_group, $term_2->term_group );
+    }
+
+    public function test_wp_update_term_alias_of_nonexistent_term() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $created_term_ids = wp_insert_term( 'Foo', 'wptests_tax' );
+        wp_update_term( $created_term_ids['term_id'], 'wptests_tax', array(
+            'alias_of' => 'bar',
+        ) );
+        $created_term = get_term( $created_term_ids['term_id'], 'wptests_tax' );
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertSame( 0, $created_term->term_group );
+    }
     /**
      * @ticket 5381