wp_count_posts( string $type = 'post', string $perm = '' ): stdClass

Counts number of posts of a post type and if user has permissions to view.

Contents

Description

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 get_posts() , but that method has a lot of overhead with doing so. Therefore, when developing for 2.5+, use this function instead.

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.

Top ↑

Parameters

$type string Optional
Post type to retrieve count. Default 'post'.

Default: 'post'

$perm string Optional
'readable' or empty.

Default: ''

Top ↑

Return

stdClass An object containing the number of posts for each status, or an empty object if the post type does not exist.

Top ↑

Source

File: wp-includes/post.php. View all references 

function wp_count_posts( $type = 'post', $perm = '' ) {
	global $wpdb;

	if ( ! post_type_exists( $type ) ) {
		return new stdClass();
	}

	$cache_key = _count_posts_cache_key( $type, $perm );

	$counts = wp_cache_get( $cache_key, 'counts' );
	if ( false !== $counts ) {
		// We may have cached this before every status was registered.
		foreach ( get_post_stati() as $status ) {
			if ( ! isset( $counts->{$status} ) ) {
				$counts->{$status} = 0;
			}
		}

		/** This filter is documented in wp-includes/post.php */
		return apply_filters( 'wp_count_posts', $counts, $type, $perm );
	}

	$query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s";

	if ( 'readable' === $perm && is_user_logged_in() ) {
		$post_type_object = get_post_type_object( $type );
		if ( ! current_user_can( $post_type_object->cap->read_private_posts ) ) {
			$query .= $wpdb->prepare(
				" AND (post_status != 'private' OR ( post_author = %d AND post_status = 'private' ))",
				get_current_user_id()
			);
		}
	}

	$query .= ' GROUP BY post_status';

	$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' );

	/**
	 * Filters the post counts by status for the current post type.
	 *
	 * @since 3.7.0
	 *
	 * @param stdClass $counts An object containing the current post_type's post
	 *                         counts by status.
	 * @param string   $type   Post type.
	 * @param string   $perm   The permission to determine if the posts are 'readable'
	 *                         by the current user.
	 */
	return apply_filters( 'wp_count_posts', $counts, $type, $perm );
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
_count_posts_cache_key() wp-includes/post.php

Returns the cache key for wp_count_posts() based on the passed arguments.
wp_cache_set() wp-includes/cache.php

Saves the data to the cache.
post_type_exists() wp-includes/post.php

Determines whether a post type is registered.
get_post_stati() wp-includes/post.php

Gets a list of post statuses.
current_user_can() wp-includes/capabilities.php

Returns whether the current user has the specified capability.
wp_cache_get() wp-includes/cache.php

Retrieves the cache contents from the cache by key and group.
is_user_logged_in() wp-includes/pluggable.php

Determines whether the current visitor is a logged in user.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
get_current_user_id() wp-includes/user.php

Gets the current user’s ID.
get_post_type_object() wp-includes/post.php

Retrieves a post type object by name.
wpdb::get_results() wp-includes/class-wpdb.php

Retrieves an entire SQL result set from the database (i.e., many rows).
wpdb::prepare() wp-includes/class-wpdb.php

Prepares a SQL query for safe execution.
Show 8 more uses Hide more uses

Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Get the Publish Status Post Count

    To get the published status type, you would call the wp_count_posts() function and then access the ‘publish’ property.

    $count_posts = wp_count_posts();

if ( $count_posts ) {
	$published_posts = $count_posts->publish;
}

    If you are developing for PHP5 only, then you can use shorthand, if you only want to get one status. This will not work in PHP4 and if you want to maintain backwards compatibility, then you must use the above code.

    $published_posts = wp_count_posts()->publish;
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Mike Ritter —

    This function returns an object whose properties you can access:

     stdClass Object ( [publish] => 12 [future] => 0 [draft] => 0 [pending] => 0 [private] => 0 [trash] => 1 [auto-draft] => 1 [inherit] => 0 [request-pending] => 0 [request-confirmed] => 0 [request-failed] => 0 [request-completed] => 0 ) 1

    So, to find out if you have more than 1 post published try:

    if( wp_count_posts()->publish > 1 ) :
	return true;
else:
	return false;
endif;
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Basic Example

    The default usage returns a count of the posts that are published. This will be an object, you can var_dump() the contents to debug the output.

    $count_posts = wp_count_posts();

You must log in before being able to contribute a note or feedback.