wppaste
WordPress

WP_Upgrader_Skin::error( string|WP_Error $errors )

Since
2.8.0
Source
wp-admin/includes/class-wp-upgrader-skin.php:176
Displays an error message about the update.

Compatibility

WordPress
since 2.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

$errorsstring|WP_Error
Errors.

Performance profile

How much work a call to WP_Upgrader_Skin::error() 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
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
9–20

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

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

  • hookthird-party callbacksdo_action()one call below WP_Upgrader_Skin::error()

Further down the call graph this can also reach option, cache, serialize, 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 · 8 distinct outcomes

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

WhenInstructionsCalls it makes
is_string($errors)9->feedback()
!is_string($errors) && !is_wp_error()10is_wp_error()
is_string($errors)11->header(), ->feedback()
!is_string($errors) && !is_wp_error()12->header(), is_wp_error()
!is_string($errors) && is_wp_error() && !->has_errors()13is_wp_error(), ->has_errors()
!is_string($errors) && is_wp_error() && !->has_errors()15->header(), is_wp_error(), ->has_errors()
!is_string($errors) && is_wp_error() && ->has_errors()17–18is_wp_error(), ->has_errors(), ->get_error_messages()
!is_string($errors) && is_wp_error() && ->has_errors()19–20->header(), is_wp_error(), ->has_errors(), ->get_error_messages()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 49 instructions, 9–20 executed per call, 8 branches. The work does not change between versions.

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 · 4

Used by · 1

Source code

View on Trac View on GitHub 

	public function error( $errors ) {		if ( ! $this->done_header ) {			$this->header();		}		if ( is_string( $errors ) ) {			$this->feedback( $errors );		} elseif ( is_wp_error( $errors ) && $errors->has_errors() ) {			foreach ( $errors->get_error_messages() as $message ) {				if ( $errors->get_error_data() && is_string( $errors->get_error_data() ) ) {					$this->feedback( $message . ' ' . esc_html( strip_tags( $errors->get_error_data() ) ) );				} else {					$this->feedback( $message );				}			}		}	}

Changelog

Introduced in 2.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.7.7 tag, from src/wp-admin/includes/class-wp-upgrader-skin.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.