WP_Object_Cache::set( int|string $key, mixed $data, string $group = 'default', int $expire )
Sets the data contents into the cache.
Description
The cache contents is grouped by the $group parameter followed by the $key. This allows for duplicate ids in unique groups. Therefore, naming of the group should be used with care and should follow normal function naming guidelines outside of core ClassicPress usage.
The $expire parameter is not used, because the cache will automatically expire for each time a page is accessed and PHP finishes. The method is more for cache plugins which use files.
Parameters
- $key
-
(int|string) (Required) What to call the contents in the cache.
- $data
-
(mixed) (Required) The contents to store in the cache.
- $group
-
(string) (Optional) Where to group the cache contents.
Default value: 'default'
- $expire
-
(int) (Optional) Not Used.
Return
(true) Always returns true.
Source
File: wp-includes/cache.php
public function set( $key, $data, $group = 'default', $expire = 0 ) {
if ( empty( $group ) )
$group = 'default';
if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
$key = $this->blog_prefix . $key;
if ( is_object( $data ) )
$data = clone $data;
$this->cache[$group][$key] = $data;
return true;
}
Changelog
| Version | Description |
|---|---|
| WP-2.0.0 | Introduced. |