wppaste
WordPress

WP_Community_Events::cache_events( array $events, int|false $expiration = false ): bool

Since
4.8.0
Source
wp-admin/includes/class-wp-community-events.php:333
Caches an array of events data from the Events API.

Compatibility

WordPress
since 4.8.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$eventsarray
Response body from the API request.
$expirationint|falseoptional
Amount of time to cache the events. Defaults to false.Default: false

Return value

bool
true if events were cached; false if not.

Performance profile

How much work a call to WP_Community_Events::cache_events() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Moderate

Reads stored settings via get_site_option(), cached per request but not free on a cold cache.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
15–24

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 26.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • transienttransientset_site_transient()called directly
  • hookthird-party callbacksapply_filters()one call below WP_Community_Events::cache_events()
  • cacheobject cachewp_cache_set()one call below WP_Community_Events::cache_events()
  • optionnetwork optionget_site_option()one call below WP_Community_Events::cache_events()

Further down the call graph this can also reach serialize and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Community_Events::cache_events() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always15->get_events_transient_key()
always18->get_events_transient_key(), absint()
always21->get_events_transient_key(), set_site_transient()
always24->get_events_transient_key(), absint(), set_site_transient()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev2515–2321 fewer instruction than PHP 8.5
8.52615–242
8.42615–242
8.32615–242
8.22615–242
8.12615–2421 fewer instruction than PHP 7.4
7.42716–242

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Used by · 1

Source code

View on Trac View on GitHub 

	protected function cache_events( $events, $expiration = false ) {		$set              = false;		$transient_key    = $this->get_events_transient_key( $events['location'] );		$cache_expiration = $expiration ? absint( $expiration ) : HOUR_IN_SECONDS * 12; 		if ( $transient_key ) {			$set = set_site_transient( $transient_key, $events, $cache_expiration );		} 		return $set;	}

Changelog

Introduced in 4.8.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/class-wp-community-events.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.