wp_suspend_cache_addition( bool $suspend = null ): bool

Temporarily suspend cache additions.


Description

Stops more data being added to the cache, but still allows cache retrieval.
This is useful for actions, such as imports, when a lot of data would otherwise be almost uselessly added to the cache.

Suspension lasts for a single page load at most. Remember to call this function again if you wish to re-enable cache adds earlier.


Top ↑

Parameters

$suspend bool Optional
Suspends additions if true, re-enables them if false.

Default: null


Top ↑

Return

bool The current suspend setting


Top ↑

Source

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

function wp_suspend_cache_addition( $suspend = null ) {
	static $_suspend = false;

	if ( is_bool( $suspend ) ) {
		$_suspend = $suspend;
	}

	return $_suspend;
}


Top ↑

Changelog

Changelog
Version Description
3.3.0 Introduced.

Top ↑

User Contributed Notes

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