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

Removes the contents of the cache key in the group.


Description Description

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


Top ↑

Parameters 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


Top ↑

Return Return

(bool) False if the contents weren't deleted and true on success.


Top ↑

Source 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;
	}


Top ↑

Changelog Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

Top ↑

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