WP_Object_Cache::decr( int|string $key, int $offset = 1, string $group = 'default' )

Decrements numeric cache item’s value.

Parameters

$key

(Required) The cache key to decrement.

$offset

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

Default value: 1

$group

(Optional) The group the key is in. Default 'default'.

Default value: 'default'

Return

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

Source

File: wp-includes/cache.php

	public function decr( $key, $offset = 1, $group = 'default' ) {
		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;

		if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
			$this->cache[ $group ][ $key ] = 0;

		$offset = (int) $offset;

		$this->cache[ $group ][ $key ] -= $offset;

		if ( $this->cache[ $group ][ $key ] < 0 )
			$this->cache[ $group ][ $key ] = 0;

		return $this->cache[ $group ][ $key ];
	}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/cache.php: WP_Object_Cache::_exists()	Serves as a utility function to determine whether a key exists in the cache.

Used By

Used By
Used By	Description
wp-includes/cache.php: wp_cache_decr()	Decrements numeric cache item’s value.

Changelog

Changelog
Version	Description
WP-3.3.0	Introduced.