WP_Object_Cache::add() WordPress Method

The WP_Object_Cache::add() method adds an object to the cache.

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

(int|string)(Required)What to call the contents in the cache.

$data

(mixed)(Required)The contents to store in the cache.

$group

(string)(Optional) Where to group the cache contents.

Default value: 'default'

$expire

(int)(Optional) When to expire the cache contents, in seconds. Default 0 (no expiration).


Top ↑

Return

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


Top ↑

Source

File: wp-includes/class-wp-object-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 );
	}


Top ↑

Changelog

Changelog
VersionDescription
2.0.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.