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

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

Parameters

$key

(Required) What to call the contents in the cache.

$data

(Required) The contents to store in the cache.

$group

(Optional) Where to group the cache contents. Default 'default'.

Default value: 'default'

$expire

(Optional) When to expire the cache contents. Default 0 (no expiration).

Return

(bool) False if cache key and group already exist, true on success

Source

File: wp-includes/cache.php

	public function add( $key, $data, $group = 'default', $expire = 0 ) {
		if ( wp_suspend_cache_addition() )
			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 );
	}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/cache.php: WP_Object_Cache::_exists()	Serves as a utility function to determine whether a key exists in the cache.
wp-includes/cache.php: WP_Object_Cache::set()	Sets the data contents into the cache.
wp-includes/functions.php: wp_suspend_cache_addition()	Temporarily suspend cache additions.

Used By

Used By
Used By	Description
wp-includes/cache.php: wp_cache_add()	Adds data to the cache, if the cache key doesn’t already exist.

Changelog

Changelog
Version	Description
WP-2.0.0	Introduced.