Changeset 64589 for trunk/src/wp-includes/post.php

Timestamp:

10/20/2026 05:49:16 AM (30 hours ago)

Author:

westonruter

Message:

Posts, Post Types: Add pre_wp_count_attachments filter.

Introduces the pre_wp_count_attachments filter to wp_count_attachments(), the counterpart of pre_wp_count_posts. Returning a stdClass object short-circuits the function, skipping the object cache lookup and both of its queries. Since the counts cache group is non-persistent, those queries otherwise run on every request that needs the counts, and on a site with millions of attachments the GROUP BY post_mime_type aggregate alone can take several seconds. The filter allows the counts to be served instead from a value pre-computed in the background.

Unlike post statuses, the set of MIME types is not known ahead of time, so only a missing trash count is filled in with zero. The filtered value should therefore contain a count for every MIME type matching $mime_type, and only those types. As with pre_wp_count_posts, the value is not cached and is passed through the wp_count_attachments filter.

The pre_wp_count_posts filter introduced in r64245 is brought in line with the new one. A filtered value now short-circuits only when it is a stdClass object: any other non-null value was previously cast to an object, turning false into a nonsensical result, and filling in missing counts on another class can trigger a dynamic property deprecation. Both filters also clone the returned object, so that a callback which keeps it, such as in a static variable, does not have it modified by core or by later callbacks on the wp_count_posts and wp_count_attachments filters.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/14210.
Follow-up to r64245.

Props jdeep, westonruter, peterwilsoncc.
See #66098.
Fixes #66291.

File:

• trunk/src/wp-includes/post.php (modified) (3 diffs)

trunk/src/wp-includes/post.php

@@ -3545 +3545 @@
          * Filters the post counts before the query is run.
          *
-         * Returning a non-null value short-circuits wp_count_posts(), skipping both
-         * the object cache lookup and the database query. This allows the counts to
-         * be served from another source, such as a value pre-computed in the
-         * background, when an exact real-time count is not required.
-         *
-         * Any registered post status missing from the filtered value are added
+         * Returning a stdClass object short-circuits wp_count_posts(), skipping
+         * both the object cache lookup and the database query. This allows the
+         * counts to be served from another source, such as a value pre-computed in
+         * the background, when an exact real-time count is not required.
+         *
+         * Any registered post status missing from the filtered value is added
          * to the result and set to zero.
          *
@@ -3566 +3566 @@
         $counts = apply_filters( 'pre_wp_count_posts', null, $type, $perm );
 
-        if ( null !== $counts ) {
-                $counts = (object) $counts;
+        if ( $counts instanceof stdClass ) {
+                $counts = clone $counts;
 
                 foreach ( get_post_stati() as $status ) {
@@ -3669 +3669 @@
 function wp_count_attachments( $mime_type = '' ) {
         global $wpdb;
+
+        /**
+         * Filters the attachment counts before the query is run.
+         *
+         * Returning a stdClass object short-circuits wp_count_attachments(),
+         * skipping both the object cache lookup and the database queries. This
+         * allows the counts to be served from another source, such as a value
+         * pre-computed in the background, when an exact real-time count is not
+         * required.
+         *
+         * If the filtered value does not contain a trash count, one is added to the
+         * result and set to zero. Missing MIME types are not added, as they depend on
+         * the attachments that exist. The filtered value should therefore contain a
+         * count for every MIME type matching `$mime_type` that has attachments,
+         * including types first uploaded after the value was computed, as callers
+         * may read the count for any MIME type that exists. It should also contain
+         * only MIME types matching `$mime_type`, with a trash count limited to
+         * attachments of those types, as the default query does.
+         *
+         * The returned value is not cached and passed through the
+         * {@see 'wp_count_attachments'} filter.
+         *
+         * @since 7.2.0
+         *
+         * @param stdClass|null   $counts    An object containing the attachment counts by
+         *                                   mime type, or null to run the default query.
+         *                                   Default null.
+         * @param string|string[] $mime_type Array or comma-separated list of MIME patterns.
+         */
+        $counts = apply_filters( 'pre_wp_count_attachments', null, $mime_type );
+
+        if ( $counts instanceof stdClass ) {
+                $counts = clone $counts;
+
+                if ( ! isset( $counts->trash ) ) {
+                        $counts->trash = 0;
+                }
+
+                /** This filter is documented in wp-includes/post.php */
+                return apply_filters( 'wp_count_attachments', $counts, $mime_type );
+        }
 
         $cache_key = sprintf(