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

Increments numeric cache item’s value.

Parameters

$key

(int|string) (Required) The cache key to increment

$offset

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

Default value: 1

$group

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

Default value: 'default'

Return

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

Source

File: wp-includes/class-wp-object-cache.php

public function incr( $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 ];
	}

Changelog

Version Description
3.3.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_object_cache/incr