WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Object_Cache::delete()

WP_Object_Cache::delete( int|string $key, string $group = ‘default’, bool $deprecated = false ): bool

In this article

Back to top

Removes the contents of the cache key in the group.

Description

If the cache key does not exist in the group, then nothing will happen.

Parameters

$keyint|stringrequired
What the contents in the cache are called.
$groupstringoptional
Where the cache contents are grouped. Default 'default'.

Default:'default'

$deprecatedbooloptional
Unused.

Default:false

Return

bool True on success, false if the contents were not deleted.

Source

public function delete( $key, $group = 'default', $deprecated = false ) {
	if ( ! $this->is_valid_key( $key ) ) {
		return false;
	}

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

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

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

	unset( $this->cache[ $group ][ $key ] );
	return true;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Object_Cache::is_valid_key()wp-includes/class-wp-object-cache.php

Serves as a utility function to determine whether a key is valid.

WP_Object_Cache::_exists()wp-includes/class-wp-object-cache.php

Serves as a utility function to determine whether a key exists in the cache.

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

Deletes multiple values from the cache in one call.

wp_cache_delete()wp-includes/cache.php

Removes the cache contents matching key and group.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

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