WP_Object_Cache::delete() WordPress Method
The WP_Object_Cache::delete() method is used to delete an object from the cache. This method takes a single parameter, which is the key of the object to be deleted.
WP_Object_Cache::delete( int|string $key, string $group = 'default', bool $deprecated = false ) #
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
- $key
(int|string)(Required)What the contents in the cache are called.
- $group
(string)(Optional) Where the cache contents are grouped.
Default value: 'default'
- $deprecated
(bool)(Optional) Unused.
Default value: false
Return
(bool) True on success, false if the contents were not deleted.
Source
File: wp-includes/class-wp-object-cache.php
public function delete( $key, $group = 'default', $deprecated = 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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |