From 5a74d939ecccf31a3fa4d2d79215ce2e95639c7f Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Sat, 21 Sep 2013 17:54:36 +0000 Subject: [PATCH] Add hooks to `wp_count_posts()`. Adds filter docs. Adds unit test to test `count_posts` filter. Props nacin, DrewAPicture. Fixes #16603. git-svn-id: https://develop.svn.wordpress.org/trunk@25554 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post.php | 40 ++++++++++++++++++++++-------------- tests/phpunit/tests/post.php | 22 ++++++++++++++++++++ 2 files changed, 47 insertions(+), 15 deletions(-) diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index 81b5d76c44..d28f5984d9 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -2070,7 +2070,7 @@ function unstick_post($post_id) { } /** - * 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 * type a blog has. Another method is to count the amount of items in @@ -2080,9 +2080,10 @@ function unstick_post($post_id) { * The $perm parameter checks for 'readable' value and if the user can read * private posts, it will display that for the user that is signed in. * - * @since 2.5.0 * @link http://codex.wordpress.org/Template_Tags/wp_count_posts * + * @since 2.5.0 + * * @param string $type Optional. Post type to retrieve count * @param string $perm Optional. 'readable' or empty. * @return object Number of posts for each status @@ -2095,7 +2096,7 @@ function wp_count_posts( $type = 'post', $perm = '' ) { $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"; if ( 'readable' == $perm && is_user_logged_in() ) { @@ -2107,23 +2108,32 @@ function wp_count_posts( $type = 'post', $perm = '' ) { } $query .= ' GROUP BY post_status'; - $count = wp_cache_get($cache_key, 'counts'); - if ( false !== $count ) - return $count; + $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 ); + } - $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A ); + $results = (array) $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A ); - $stats = array(); - foreach ( get_post_stati() as $state ) - $stats[$state] = 0; + $counts = array_fill_keys( get_post_stati(), 0 ); - foreach ( (array) $count as $row ) - $stats[$row['post_status']] = $row['num_posts']; + foreach ( $results as $row ) + $counts[ $row['post_status'] ] = $row['num_posts']; - $stats = (object) $stats; - wp_cache_set($cache_key, $stats, 'counts'); + $counts = (object) $counts; + wp_cache_set( $cache_key, $counts, 'counts' ); - return $stats; + //duplicate_hook + return apply_filters( 'count_posts', $counts, $type, $perm ); } /** diff --git a/tests/phpunit/tests/post.php b/tests/phpunit/tests/post.php index 130035e1a7..4428143f00 100644 --- a/tests/phpunit/tests/post.php +++ b/tests/phpunit/tests/post.php @@ -808,6 +808,28 @@ class Tests_Post extends WP_UnitTestCase { $this->assertEquals( new stdClass, wp_count_posts( $post_type, 'readable' ) ); } + 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 */