WP_Object_Cache::decr( int|string $key, int $offset = 1, string $group = 'default' )
Decrements numeric cache item’s value.
Description Description
Parameters 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: 'default'
Return Return
(false|int) False on failure, the item's new value on success.
Source 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 full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 3.3.0 | Introduced. |