Changeset 52180 for trunk/tests/phpunit/tests/term/getTermLink.php

Timestamp:

11/16/2021 02:55:04 PM (3 years ago)

Author:

hellofromTonya

Message:

Taxonomy: Allow get_*_*_link() and edit_term_link() functions to accept a term ID, WP_Term, or term object.

get_term() accepts a term ID, instance of WP_Term, or an object (i.e. stdClass as a result of a db query). Functions that use get_term() also now allow for the same data types.

Why? For consistency, removing extra processing code in consuming functions, and performance.

Functions changed in this commit are:

• get_category_feed_link()
• get_term_feed_link()
• get_tag_feed_link()
• get_edit_tag_link()
• get_edit_term_link()
• edit_term_link()

For each of consumer of these functions, changes to pass the object instead of the term ID.

Includes unit/integration tests for test coverage of these changes.

Follow-up to [6365], [9136], [9340], [14711], [15792], [15800], [18827], [32606], [36646], [37252].

Props davidbinda, johnbillion, peterwilsoncc, hellofromTonya, sergeybiryukov, mista-flo, hareesh-pillai, audrasjb, jeffpaul, chaion07.
Fixes #50225.

File:

• trunk/tests/phpunit/tests/term/getTermLink.php (modified) (2 diffs)

trunk/tests/phpunit/tests/term/getTermLink.php

@@ -3 +3 @@
 /**
  * @group taxonomy
+ * @covers ::get_term_link
  */
 class Tests_Term_GetTermLink extends WP_UnitTestCase {
 
+    public static $terms;
+
+    public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+        self::register_custom_taxonomy();
+
+        $taxonomies = array( 'category', 'post_tag', 'wptests_tax' );
+        foreach ( $taxonomies as $taxonomy ) {
+            self::$terms[ $taxonomy ] = $factory->term->create_and_get( array( 'taxonomy' => $taxonomy ) );
+        }
+    }
+
     public function set_up() {
         parent::set_up();
-
-        register_taxonomy( 'wptests_tax', 'post' );
+        self::register_custom_taxonomy();
     }
 
@@ -208 +219 @@
         $this->assertStringContainsString( '/foo/term2/', $actual );
     }
+
+    /**
+     * @dataProvider data_get_term_link
+     *
+     * @ticket 50225
+     *
+     * @param string $taxonomy Taxonomy been tested (used for index of term keys).
+     * @param bool   $use_id   When true, pass term ID. Else, pass term object.
+     */
+    public function test_get_term_link_filter_is_object_by_term_id( $taxonomy, $use_id ) {
+        $term = $this->get_term( $taxonomy, $use_id );
+
+        add_filter(
+            'term_link',
+            function( $location, $term ) {
+                $this->assertInstanceOf( 'WP_Term', $term );
+            },
+            10,
+            2
+        );
+
+        get_term_link( $term, $taxonomy );
+    }
+
+    /**
+     * @dataProvider data_get_term_link
+     *
+     * @ticket 50225
+     *
+     * @param string $taxonomy Taxonomy been tested (used for index of term keys).
+     * @param bool   $use_id   When true, pass term ID. Else, pass term object.
+     */
+    public function test_get_term_link_filter_is_object_by_term_object( $taxonomy, $use_id ) {
+        $term = $this->get_term( $taxonomy, $use_id );
+
+        add_filter(
+            'term_link',
+            function( $location, $term ) {
+                $this->assertInstanceOf( 'WP_Term', $term );
+            },
+            10,
+            2
+        );
+
+        get_term_link( get_term( $term, $taxonomy ), $taxonomy );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_get_term_link() {
+        return array(
+            'category passing term_id'          => array(
+                'taxonomy' => 'category',
+                'use_id'   => false,
+            ),
+            'category passing term object'      => array(
+                'taxonomy' => 'category',
+                'use_id'   => true,
+            ),
+            'post_tag passing term_id'          => array(
+                'taxonomy' => 'post_tag',
+                'use_id'   => false,
+            ),
+            'post_tag passing term object'      => array(
+                'taxonomy' => 'post_tag',
+                'use_id'   => true,
+            ),
+            'a custom taxonomy passing term_id' => array(
+                'taxonomy' => 'wptests_tax',
+                'use_id'   => false,
+            ),
+            'a custom taxonomy passing term_id' => array(
+                'taxonomy' => 'wptests_tax',
+                'use_id'   => true,
+                'expected' => 'term.php?taxonomy=custom_taxonomy&tag_ID=%ID%&post_type=post',
+            ),
+        );
+    }
+
+    /**
+     * Helper to register a custom taxonomy for use in tests.
+     *
+     * @since 5.9.0
+     */
+    private static function register_custom_taxonomy() {
+        register_taxonomy( 'wptests_tax', 'post' );
+    }
+
+    /**
+     * Helper to get the term for the given taxonomy.
+     *
+     * @since 5.9.0
+     *
+     * @param string $taxonomy Taxonomy been tested (used for index of term keys).
+     * @param bool   $use_id   When true, pass term ID. Else, pass term object.
+     * @return WP_Term|int If $use_id is true, term ID is returned; else instance of WP_Term.
+     */
+    private function get_term( $taxonomy, $use_id ) {
+        $term = self::$terms[ $taxonomy ];
+        if ( $use_id ) {
+            $term = $term->term_id;
+        }
+
+        return $term;
+    }
 }