Changeset 25554

Timestamp:

09/21/2013 05:54:36 PM (11 years ago)

Author:

wonderboymusic

Message:

Add hooks to wp_count_posts(). Adds filter docs. Adds unit test to test count_posts filter.

Props nacin, DrewAPicture.
Fixes #16603.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (4 diffs)
• tests/phpunit/tests/post.php (modified) (1 diff)

trunk/src/wp-includes/post.php

@@ -2071 +2071 @@
 
 /**
- * Count number of posts of a post type and is user has permissions to view.
+ * Count number of posts of a post type and if user has permissions to view.
  *
  * This function provides an efficient method of finding the amount of post's
@@ -2081 +2081 @@
  * private posts, it will display that for the user that is signed in.
  *
+ * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
+ *
  * @since 2.5.0
- * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
  *
  * @param string $type Optional. Post type to retrieve count
@@ -2096 +2097 @@
     $user = wp_get_current_user();
 
-    $cache_key = $type;
+    $cache_key = 'posts-' . $type;
 
     $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s";
@@ -2108 +2109 @@
     $query .= ' GROUP BY post_status';
 
-    $count = wp_cache_get($cache_key, 'counts');
-    if ( false !== $count )
-        return $count;
-
-    $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A );
-
-    $stats = array();
-    foreach ( get_post_stati() as $state )
-        $stats[$state] = 0;
-
-    foreach ( (array) $count as $row )
-        $stats[$row['post_status']] = $row['num_posts'];
-
-    $stats = (object) $stats;
-    wp_cache_set($cache_key, $stats, 'counts');
-
-    return $stats;
+    $counts = wp_cache_get( $cache_key, 'counts' );
+    if ( false !== $counts ) {
+        /**
+         * Modify returned post counts by status for the current post type.
+         *
+         * @since 3.7.0
+         *
+         * @param object $counts An object containing the current post_type's post counts by status.
+         * @param string $type   The post type.
+         * @param string $perm   The permission to determine if the posts are 'readable' by the current user.
+         */
+        return apply_filters( 'count_posts', $counts, $type, $perm );
+    }
+
+    $results = (array) $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A );
+
+    $counts = array_fill_keys( get_post_stati(), 0 );
+
+    foreach ( $results as $row )
+        $counts[ $row['post_status'] ] = $row['num_posts'];
+
+    $counts = (object) $counts;
+    wp_cache_set( $cache_key, $counts, 'counts' );
+
+    //duplicate_hook
+    return apply_filters( 'count_posts', $counts, $type, $perm );
 }
 

trunk/tests/phpunit/tests/post.php

@@ -809 +809 @@
     }
 
+    function test_wp_count_posts_filtered() {
+        $post_type = rand_str(20);
+        register_post_type( $post_type );
+        $this->factory->post->create_many( 10, array(
+            'post_type' => $post_type,
+            'post_author' => $this->author_id
+        ) );
+        $count1 = wp_count_posts( $post_type, 'readable' );
+        $this->assertEquals( 10, $count1->publish );
+        add_filter( 'count_posts', array( $this, 'filter_wp_count_posts' ) );
+
+        $count2 = wp_count_posts( $post_type, 'readable' );
+        $this->assertEquals( 7, $count2->publish );
+
+        remove_filter( 'count_posts', array( $this, 'filter_wp_count_posts' ) );
+    }
+
+    function filter_wp_count_posts( $counts ) {
+        $counts->publish = 7;
+        return $counts;
+    }
+
     /**
      * @ticket 22074