WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_suspend_cache_addition()

wp_suspend_cache_addition( bool $suspend = null ): bool

In this article

Back to top

Temporarily suspends 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.

Parameters

$suspendbooloptional
Suspends additions if true, re-enables them if false.
Defaults to not changing the current setting.

Default:null

Return

bool The current suspend setting.

Source

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

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

	return $_suspend;
}

View all references View on Trac View on GitHub

Used byDescription
WP_Object_Cache::add()wp-includes/class-wp-object-cache.php

Adds data to the cache if it doesn’t already exist.

WP_Widget::display_callback()wp-includes/class-wp-widget.php

Generates the actual widget content (Do NOT override).

WP_Widget::update_callback()wp-includes/class-wp-widget.php

Handles changed settings (Do NOT override).

Changelog

VersionDescription
3.3.0Introduced.

User Contributed Notes

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