WP_Object_Cache::add() – Method | Developer.WordPress.org

WP_Object_Cache::add( int|string $key, mixed $data, string $group = 'default', int $expire ): bool

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

Parameters

$keyint|stringrequired: What to call the contents in the cache.
$datamixedrequired: The contents to store in the cache.
$groupstringoptional: Where to group the cache contents. Default 'default'.
Default:'default'
$expireintoptional: When to expire the cache contents, in seconds.
Default 0 (no expiration).

Return

bool True on success, false if cache key and group already exist.

Source

public function add( $key, $data, $group = 'default', $expire = 0 ) {
	if ( wp_suspend_cache_addition() ) {
		return false;
	}

	if ( ! $this->is_valid_key( $key ) ) {
		return false;
	}

	if ( empty( $group ) ) {
		$group = 'default';
	}

	$id = $key;
	if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
		$id = $this->blog_prefix . $key;
	}

	if ( $this->_exists( $id, $group ) ) {
		return false;
	}

	return $this->set( $key, $data, $group, (int) $expire );
}

View all references View on Trac View on GitHub

Changelog

Version	Description
2.0.0	Introduced.

User Contributed Notes

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