wp_cache_decr() WordPress Function

The wp_cache_decr() function is used to decrease the value of a cached item by a given amount. This function is useful for decrementing a counter stored in cache.

wp_cache_decr( int|string $key, int $offset = 1, string $group = '' ) #

Decrements numeric cache item’s value.


Description

Top ↑

See also


Top ↑

Parameters

$key

(int|string)(Required)The cache key to decrement.

$offset

(int)(Optional) The amount by which to decrement the item's value.

Default value: 1

$group

(string)(Optional) The group the key is in.

Default value: ''


Top ↑

Return

(int|false) The item's new value on success, false on failure.


Top ↑

Source

File: wp-includes/cache.php

function wp_cache_decr( $key, $offset = 1, $group = '' ) {
	global $wp_object_cache;

	return $wp_object_cache->decr( $key, $offset, $group );
}


Top ↑

Changelog

Changelog
VersionDescription
3.3.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.