Changeset 48840

Timestamp:

08/21/2020 10:30:06 PM (4 years ago)

Author:

flixos90

Message:

Taxonomy: Allow for wp_count_terms( $args ) signature, making passing a taxonomy optional.

This brings wp_count_terms() in line with other taxonomy functions such as get_terms() which technically no longer require a taxonomy. Similar to the previously modified functions, no deprecation warning is triggered when using the legacy signature.

Fixes #36399.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-terms-list-table.php (modified) (1 diff)
• src/wp-admin/includes/nav-menu.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (1 diff)
• src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php (modified) (1 diff)
• src/wp-includes/taxonomy.php (modified) (1 diff)
• tests/phpunit/tests/import/import.php (modified) (2 diffs)
• tests/phpunit/tests/term.php (modified) (4 diffs)
• tests/phpunit/tests/term/wpInsertTerm.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-wp-terms-list-table.php

@@ -130 +130 @@
         $this->set_pagination_args(
             array(
-                'total_items' => wp_count_terms( $this->screen->taxonomy, compact( 'search' ) ),
+                'total_items' => wp_count_terms(
+                    array(
+                        'taxonomy' => $this->screen->taxonomy,
+                        'search'   => $search,
+                    )
+                ),
                 'per_page'    => $tags_per_page,
             )

trunk/src/wp-admin/includes/nav-menu.php

@@ -726 +726 @@
     $num_pages = ceil(
         wp_count_terms(
-            $taxonomy_name,
             array_merge(
                 $args,

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

@@ -264 +264 @@
         unset( $count_args['number'], $count_args['offset'] );
 
-        $total_terms = wp_count_terms( $this->taxonomy, $count_args );
+        $total_terms = wp_count_terms( $count_args );
 
         // wp_count_terms() can return a falsey value when the term has no children.

trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

@@ -151 +151 @@
         }
 
-        $term_count = wp_count_terms( $taxonomy, $this->get_taxonomies_query_args( $taxonomy ) );
+        $term_count = wp_count_terms( $this->get_taxonomies_query_args( $taxonomy ) );
 
         return (int) ceil( $term_count / wp_sitemaps_get_max_urls( $this->object_type ) );

trunk/src/wp-includes/taxonomy.php

@@ -1731 +1731 @@
  *
  * @since 2.3.0
- *
- * @param string       $taxonomy Taxonomy name.
- * @param array|string $args     Optional. Array of arguments that get passed to get_terms().
- *                               Default empty array.
+ * @since 5.6.0 Changed the function signature so that the `$args` array can be provided as the first parameter.
+ *
+ * @param array|string $args       Optional. Array of arguments that get passed to get_terms().
+ *                                 Default empty array.
+ * @param array|string $deprecated Taxonomy name.
  * @return array|int|WP_Error Number of terms in that taxonomy or WP_Error if the taxonomy does not exist.
  */
-function wp_count_terms( $taxonomy, $args = array() ) {
-    $defaults = array(
-        'taxonomy'   => $taxonomy,
-        'hide_empty' => false,
-    );
-    $args     = wp_parse_args( $args, $defaults );
+function wp_count_terms( $args = array(), $deprecated = array() ) {
+    // Check whether function is used with legacy signature `$taxonomy` and `$args`.
+    $use_legacy_args = $args && ( is_string( $args ) && taxonomy_exists( $args ) || is_array( $args ) && wp_is_numeric_array( $args ) );
+
+    $defaults = array( 'hide_empty' => false );
+    if ( $use_legacy_args ) {
+        $defaults['taxonomy'] = $args;
+        $args                 = $deprecated;
+    }
+
+    $args = wp_parse_args( $args, $defaults );
 
     // Backward compatibility.

trunk/tests/phpunit/tests/import/import.php

@@ -66 +66 @@
 
         // Check that terms were imported correctly.
-        $this->assertEquals( 30, wp_count_terms( 'category' ) );
-        $this->assertEquals( 3, wp_count_terms( 'post_tag' ) );
+        $this->assertEquals( 30, wp_count_terms( array( 'taxonomy' => 'category' ) ) );
+        $this->assertEquals( 3, wp_count_terms( array( 'taxonomy' => 'post_tag' ) ) );
         $foo = get_term_by( 'slug', 'foo', 'category' );
         $this->assertEquals( 0, $foo->parent );
@@ -231 +231 @@
         $this->assertEquals( 'author@example.org', $author->user_email );
 
-        $this->assertEquals( 30, wp_count_terms( 'category' ) );
-        $this->assertEquals( 3, wp_count_terms( 'post_tag' ) );
+        $this->assertEquals( 30, wp_count_terms( array( 'taxonomy' => 'category' ) ) );
+        $this->assertEquals( 3, wp_count_terms( array( 'taxonomy' => 'post_tag' ) ) );
         $foo = get_term_by( 'slug', 'foo', 'category' );
         $this->assertEquals( 0, $foo->parent );

trunk/tests/phpunit/tests/term.php

@@ -66 +66 @@
      */
     function test_wp_count_terms() {
-        $count = wp_count_terms( 'category', array( 'hide_empty' => true ) );
+        $count = wp_count_terms(
+            array(
+                'hide_empty' => true,
+                'taxonomy'   => 'category',
+            )
+        );
         // There are 5 posts, all Uncategorized.
         $this->assertEquals( 1, $count );
+    }
+
+    /**
+     * @ticket 36399
+     */
+    function test_wp_count_terms_legacy_interoperability() {
+        self::factory()->tag->create_many( 5 );
+
+        // Counts all terms (1 default category, 5 tags).
+        $count = wp_count_terms();
+        $this->assertEquals( 6, $count );
+
+        // Counts only tags (5), with both current and legacy signature.
+        // Legacy usage should not trigger deprecated notice.
+        $count        = wp_count_terms( array( 'taxonomy' => 'post_tag' ) );
+        $legacy_count = wp_count_terms( 'post_tag' );
+        $this->assertEquals( 5, $count );
+        $this->assertEquals( $count, $legacy_count );
     }
 
@@ -128 +151 @@
         $this->assertNull( category_exists( $term ) );
 
-        $initial_count = wp_count_terms( 'category' );
+        $initial_count = wp_count_terms( array( 'taxonomy' => 'category' ) );
 
         $t = wp_insert_category( array( 'cat_name' => $term ) );
@@ -134 +157 @@
         $this->assertNotWPError( $t );
         $this->assertTrue( $t > 0 );
-        $this->assertEquals( $initial_count + 1, wp_count_terms( 'category' ) );
+        $this->assertEquals( $initial_count + 1, wp_count_terms( array( 'taxonomy' => 'category' ) ) );
 
         // Make sure the term exists.
@@ -144 +167 @@
         $this->assertNull( term_exists( $term ) );
         $this->assertNull( term_exists( $t ) );
-        $this->assertEquals( $initial_count, wp_count_terms( 'category' ) );
+        $this->assertEquals( $initial_count, wp_count_terms( array( 'taxonomy' => 'category' ) ) );
     }
 

trunk/tests/phpunit/tests/term/wpInsertTerm.php

@@ -25 +25 @@
         $this->assertNull( term_exists( $term ) );
 
-        $initial_count = wp_count_terms( $taxonomy );
+        $initial_count = wp_count_terms( array( 'taxonomy' => $taxonomy ) );
 
         $t = wp_insert_term( $term, $taxonomy );
@@ -32 +32 @@
         $this->assertTrue( $t['term_id'] > 0 );
         $this->assertTrue( $t['term_taxonomy_id'] > 0 );
-        $this->assertEquals( $initial_count + 1, wp_count_terms( $taxonomy ) );
+        $this->assertEquals( $initial_count + 1, wp_count_terms( array( 'taxonomy' => $taxonomy ) ) );
 
         // Make sure the term exists.
@@ -44 +44 @@
         $this->assertNull( term_exists( $term ) );
         $this->assertNull( term_exists( $t['term_id'] ) );
-        $this->assertEquals( $initial_count, wp_count_terms( $taxonomy ) );
+        $this->assertEquals( $initial_count, wp_count_terms( array( 'taxonomy' => $taxonomy ) ) );
     }