WP_Site_Health::should_suggest_persistent_object_cache(): bool

Compatibility

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

Return value

bool

Whether to suggest using a persistent object cache.

Performance profile

How much work a call to WP_Site_Health::should_suggest_persistent_object_cache() 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

Light

Only touches the object cache, via wp_cache_get().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9

Executed per call on PHP 8.5. The body compiles to 87.

Plugin surface

2 hooks

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

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below WP_Site_Health::should_suggest_persistent_object_cache()

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 2

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

1. 1
   apply_filters( site_status_should_suggest_persistent_object_cache )filterline 3769 (+13 into the body)

   Filters whether to suggest use of a persistent object cache and bypass default threshold checks.

2. 2
   apply_filters( site_status_persistent_object_cache_thresholds )filterline 3785 (+29 into the body)

   Filters the thresholds used to determine whether to suggest the use of a persistent object cache.

Uses · 4

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_multisite()Determines whether Multisite is enabled.
• wp_load_alloptions()Loads and caches all autoloaded options, if available or all options.
• array_any()Polyfill for `array_any()` function added in PHP 8.4.

Used by · 1

• WP_Site_Health::get_test_persistent_object_cache()Tests if the site uses persistent object cache and recommends to use it if not.

Source code

View on Trac ↗View on GitHub ↗

3756	public function should_suggest_persistent_object_cache() {3757		global $wpdb;3758 3759		/**3760		 * Filters whether to suggest use of a persistent object cache and bypass default threshold checks.3761		 *3762		 * Using this filter allows to override the default logic, effectively short-circuiting the method.3763		 *3764		 * @since 6.1.03765		 *3766		 * @param bool|null $suggest Boolean to short-circuit, for whether to suggest using a persistent object cache.3767		 *                           Default null.3768		 */3769		$short_circuit = apply_filters( 'site_status_should_suggest_persistent_object_cache', null );3770		if ( is_bool( $short_circuit ) ) {3771			return $short_circuit;3772		}3773 3774		if ( is_multisite() ) {3775			return true;3776		}3777 3778		/**3779		 * Filters the thresholds used to determine whether to suggest the use of a persistent object cache.3780		 *3781		 * @since 6.1.03782		 *3783		 * @param int[] $thresholds The list of threshold numbers keyed by threshold name.3784		 */3785		$thresholds = apply_filters(3786			'site_status_persistent_object_cache_thresholds',3787			array(3788				'alloptions_count' => 500,3789				'alloptions_bytes' => 100000,3790				'comments_count'   => 1000,3791				'options_count'    => 1000,3792				'posts_count'      => 1000,3793				'terms_count'      => 1000,3794				'users_count'      => 1000,3795			)3796		);3797 3798		$alloptions = wp_load_alloptions();3799 3800		if ( $thresholds['alloptions_count'] < count( $alloptions ) ) {3801			return true;3802		}3803 3804		if ( $thresholds['alloptions_bytes'] < strlen( serialize( $alloptions ) ) ) {3805			return true;3806		}3807 3808		$table_names = implode( "','", array( $wpdb->comments, $wpdb->options, $wpdb->posts, $wpdb->terms, $wpdb->users ) );3809 3810		// With InnoDB the `TABLE_ROWS` are estimates, which are accurate enough and faster to retrieve than individual `COUNT()` queries.3811		$results = $wpdb->get_results(3812			$wpdb->prepare(3813				// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- This query cannot use interpolation.3814				"SELECT TABLE_NAME AS 'table', TABLE_ROWS AS 'rows', SUM(data_length + index_length) as 'bytes' FROM information_schema.TABLES WHERE TABLE_SCHEMA = %s AND TABLE_NAME IN ('$table_names') GROUP BY TABLE_NAME;",3815				DB_NAME3816			),3817			OBJECT_K3818		);3819 3820		$threshold_map = array(3821			'comments_count' => $wpdb->comments,3822			'options_count'  => $wpdb->options,3823			'posts_count'    => $wpdb->posts,3824			'terms_count'    => $wpdb->terms,3825			'users_count'    => $wpdb->users,3826		);3827 3828		return array_any( $threshold_map, fn( $table, $threshold ) => $thresholds[ $threshold ] <= $results[ $table ]->rows );3829	}

Changelog

Introduced in 6.1.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.1.0 tag, from src/wp-admin/includes/class-wp-site-health.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.