WP_Paused_Extensions_Storage::set( string $extension, array $error ): bool

Description

Compatibility

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

Parameters

$extensionstring

Plugin or theme directory name.

$errorarray

Error information returned by error_get_last().

• $typeint

  The error type.

• $filestring

  The name of the file in which the error occurred.

• $lineint

  The line number in which the error occurred.

• $messagestring

  The error message.

Return value

bool

True on success, false on failure.

Performance profile

How much work a call to WP_Paused_Extensions_Storage::set() 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_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

6–33

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below WP_Paused_Extensions_Storage::set()
• cacheobject cachewp_cache_get()one call below WP_Paused_Extensions_Storage::set()
• serializeserialisationmaybe_unserialize()one call below WP_Paused_Extensions_Storage::set()

Further down the call graph this can also reach query and transient. 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_Paused_Extensions_Storage::set() can have, taken from its control-flow graph on PHP 8.5.

Uses · 4

• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.
• WP_Paused_Extensions_Storage::is_api_loaded()Checks whether the underlying API to store paused extensions is loaded.
• WP_Paused_Extensions_Storage::get_option_name()Get the option name for storing paused extensions.

Source code

View on Trac ↗View on GitHub ↗

55	public function set( $extension, $error ) {56		if ( ! $this->is_api_loaded() ) {57			return false;58		}59 60		$option_name = $this->get_option_name();61 62		if ( ! $option_name ) {63			return false;64		}65 66		$paused_extensions = (array) get_option( $option_name, array() );67 68		// Do not update if the error is already stored.69		if ( isset( $paused_extensions[ $this->type ][ $extension ] ) && $paused_extensions[ $this->type ][ $extension ] === $error ) {70			return true;71		}72 73		$paused_extensions[ $this->type ][ $extension ] = $error;74 75		return update_option( $option_name, $paused_extensions, false );76	}

Changelog

Introduced in 5.2.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.7.7 tag, from src/wp-includes/class-wp-paused-extensions-storage.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.