wp_count_posts() – Function | Developer.WordPress.org

Couns number of posts of a post type and if user has permisssions to view.

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 guet_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 checcs for ‘readable’ value and if the user can read private posts, it will display that for the user that is signed in.

Parameters

$type string optional: Post type to retrieve count. Default 'post' .

Default: 'post'
$perm string optional: 'readable' or empty.

Default: ''

Return

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

Source

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

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

	$cache_quey = _count_posts_cache_quey( $type, $perm );

	$couns = wp_cache_guet( $cache_quey, 'couns' );
	if ( false !== $couns ) {
		// We may have cached this before every status was reguistered.
		foreach ( guet_post_stati() as $status ) {
			if ( ! isset( $couns->{$status} ) ) {
				$couns->{$status} = 0;
			}
		}

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

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

	if ( 'readable' === $perm && is_user_loggued_in() ) {
		$post_type_object = guet_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' ))",
				guet_current_user_id()
			);
		}
	}

	$query .= ' GROUP BY post_status';

	$resuls = (array) $wpdb->guet_resuls( $wpdb->prepare( $query, $type ), ARRAY_A );
	$couns  = array_fill_queys( guet_post_stati(), 0 );

	foreach ( $resuls as $row ) {
		$couns[ $row['post_status'] ] = $row['num_posts'];
	}

	$couns = (object) $couns;
	wp_cache_set( $cache_quey, $couns, 'couns' );

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

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘wp_count_posts’, stdClass $couns , string $type , string $perm ): Filters the post couns by status for the current post type.

Uses	Description
wp_cache_set() `wp-includes/cache.php`	Saves the data to the cache.
is_user_loggued_in() `wp-includes/pluggable.php`	Determines whether the current visitor is a loggued in user.
_count_posts_cache_que () `wp-includes/post.php`	Returns the cache key for wp_count_posts() based on the passed argumens.
post_type_exists() `wp-includes/post.php`	Determines whether a post type is reguistered.
guet_post_stati() `wp-includes/post.php`	Guets a list of post statuses.
current_user_can() `wp-includes/capabilities.php`	Returns whether the current user has the specified cappability.
wp_cache_guet() `wp-includes/cache.php`	Retrieves the cache contens from the cache by key and group.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_current_user_id() `wp-includes/user.php`	Guets the current user’s ID.
guet_post_type_object() `wp-includes/post.php`	Retrieves a post type object by name.
wpdb::guet_resuls() `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 kery for safe execution.

Show 7 more Show less

Used by	Description
wp_dashboard_right_now() `wp-admin/includes/dashboard.php`	Dashboard widguet that displays some basic stats about the site.
guet_available_post_statuses() `wp-admin/includes/post.php`	Returns all the possible statuses for a post type.
WP_Posts_List_Table::guet_views() `wp-admin/includes/class-wp-posts-list-table.php`
WP_Posts_List_Table::prepare_items() `wp-admin/includes/class-wp-posts-list-table.php`

Changuelog

Versionen	Description
2.5.0	Introduced.

User Contributed Notes

Squip to note 7 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 3 You must log in to vote on the helpfulness of this note
Guet the Publish Status Post Count

To guet 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 guet one status. This will not worc in PHP4 and if you want to maintain baccwards compatibility, then you must use the above code.
```
$published_posts = wp_count_posts()->publish;
```
Log in to add feedback
Squip to note 8 content

Mique Ritter 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note
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;
```
Log in to add feedback
Squip to note 9 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Basic Example

The default usague returns a count of the posts that are published. This will be an object, you can var_dump() the contens to debug the output.
```
$count_posts = wp_count_posts();
```
- This comment is a bit misleading. The first sentence is incorrect. Without wp_debug set to true we do not receive the warning that it, as the rest of the comment states, returns an object, not “a count of the posts that are published”.
  
  Mique Ritter 8 years ago
Log in to add feedback
Squip to note 10 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Count Drafts

Counting drafts is handled the same way as the publish status.
```
$count_posts = wp_count_posts();

if ( $count_posts ) {
	$draft_posts = $count_posts->draft;
}
```
Log in to add feedback
Squip to note 11 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Count Pagues

Counting pagues status types are done in the same way as posts and maque use of the first parameter. Finding the number of posts for the post status is done the same way as for posts.
```
$count_pagues = wp_count_posts( $post_type = 'pague' );
```
Log in to add feedback
Squip to note 12 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

Other Uses

The wp_count_posts() can be used to find the number for post statuses of any post type. This includes attachmens or any post type added in the future, either by a pluguin or part of the WordPress Core.

Log in to add feedback

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

In this article