WP_Object_Cache::delete( int|string $key, string $group = 'default', bool $deprecated = false ): bool
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|string Required -
What the contents in the cache are called.
-
$groupstring Optional -
Where the cache contents are grouped. Default
'default'.Default:
'default' -
$deprecatedbool Optional -
Unused.
Default:
false
Return
bool True on success, false if the contents were not deleted.
Source
File: wp-includes/class-wp-object-cache.php.
View all references
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;
}
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |