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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$typestringoptional

Post type to retrieve count. Default 'post'.Default: 'post'

$permstringoptional

'readable' or empty. Default empty.Default: ''

Return value

stdClass

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

Performance profile

How much work a call to wp_count_posts() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

10–84

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 114.

Plugin surface

1 hook

Third-party callbacks on 'wp_count_posts' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• cacheobject cachewp_cache_get()called directly
• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->get_results()called directly

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_count_posts() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_count_posts() runs, in this order:

1. 1
   apply_filters( wp_count_posts )filterline 3421 (+19 into the body)

   Filters the post counts by status for the current post type.

2. 2
   apply_filters( wp_count_posts )filterline 3478 (+76 into the body)

   Filters the post counts by status for the current post type.

Uses · 11

• post_type_exists()Determines whether a post type is registered.
• _count_posts_cache_key()Returns the cache key for wp_count_posts() based on the passed arguments.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• get_post_stati()Gets a list of post statuses.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• current_user_can()Returns whether the current user has the specified capability.
• get_post_type_object()Retrieves a post type object by name.
• get_current_user_id()Gets the current user's ID.
• wp_cache_set()Saves the data to the cache.
• stdClass::__construct()

Used by · 4

• WP_Posts_List_Table::get_views()
• WP_Posts_List_Table::prepare_items()
• get_available_post_statuses()Returns all the possible statuses for a post type.
• wp_dashboard_right_now()Dashboard widget that displays some basic stats about the site.

Source code

View on Trac ↗View on GitHub ↗

3402function wp_count_posts( $type = 'post', $perm = '' ) {3403	global $wpdb;3404 3405	if ( ! post_type_exists( $type ) ) {3406		return new stdClass();3407	}3408 3409	$cache_key = _count_posts_cache_key( $type, $perm );3410 3411	$counts = wp_cache_get( $cache_key, 'counts' );3412	if ( false !== $counts ) {3413		// We may have cached this before every status was registered.3414		foreach ( get_post_stati() as $status ) {3415			if ( ! isset( $counts->{$status} ) ) {3416				$counts->{$status} = 0;3417			}3418		}3419 3420		/** This filter is documented in wp-includes/post.php */3421		return apply_filters( 'wp_count_posts', $counts, $type, $perm );3422	}3423 3424	if (3425		'readable' === $perm &&3426		is_user_logged_in() &&3427		! current_user_can( get_post_type_object( $type )->cap->read_private_posts )3428	) {3429		// Optimized query uses subqueries which can leverage DB indexes for better performance. See #61097.3430		$query = "3431			SELECT post_status, COUNT(*) AS num_posts3432			FROM (3433				SELECT post_status3434				FROM {$wpdb->posts}3435				WHERE post_type = %s AND post_status != 'private'3436				UNION ALL3437				SELECT post_status3438				FROM {$wpdb->posts}3439				WHERE post_type = %s AND post_status = 'private' AND post_author = %d3440			) AS filtered_posts3441		";3442		$args  = array( $type, $type, get_current_user_id() );3443	} else {3444		$query = "3445			SELECT post_status, COUNT(*) AS num_posts3446			FROM {$wpdb->posts}3447			WHERE post_type = %s3448		";3449		$args  = array( $type );3450	}3451 3452	$query .= ' GROUP BY post_status';3453 3454	$results = (array) $wpdb->get_results(3455		$wpdb->prepare( $query, ...$args ), // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Placeholders are used in the string contained in the variable.3456		ARRAY_A3457	);3458	$counts  = array_fill_keys( get_post_stati(), 0 );3459 3460	foreach ( $results as $row ) {3461		$counts[ $row['post_status'] ] = $row['num_posts'];3462	}3463 3464	$counts = (object) $counts;3465	wp_cache_set( $cache_key, $counts, 'counts' );3466 3467	/**3468	 * Filters the post counts by status for the current post type.3469	 *3470	 * @since 3.7.03471	 *3472	 * @param stdClass $counts An object containing the current post_type's post3473	 *                         counts by status.3474	 * @param string   $type   Post type.3475	 * @param string   $perm   The permission to determine if the posts are 'readable'3476	 *                         by the current user.3477	 */3478	return apply_filters( 'wp_count_posts', $counts, $type, $perm );3479}

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.