wppaste
WordPress

Bulk_Upgrader_Skin::error( string|WP_Error $errors )

Since
3.0.0, 5.9.0
Source
wp-admin/includes/class-bulk-upgrader-skin.php:128
Displays an error message about the update.

Compatibility

WordPress
since 5.9.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 Bulk_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
17–35

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

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

  • hookthird-party callbacksdo_action()one call below Bulk_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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!is_wp_error()17–26is_wp_error(), esc_js()
is_wp_error()25–35is_wp_error(), ->get_error_messages(), esc_js()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev5817–357
8.55817–357
8.45817–3573 fewer instructions than PHP 8.3
8.36117–387
8.26117–387
8.16117–387
7.46117–387

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

  • is_wp_error()Checks whether the given variable is a WordPress Error.
  • esc_html()Escaping for HTML blocks.
  • esc_js()Escapes single quotes, `"`, ``, `&`, and fixes line endings.

Source code

	public function error( $errors ) {		if ( is_string( $errors ) && isset( $this->upgrader->strings[ $errors ] ) ) {			$this->error = $this->upgrader->strings[ $errors ];		} 		if ( is_wp_error( $errors ) ) {			$messages = array();			foreach ( $errors->get_error_messages() as $emessage ) {				if ( $errors->get_error_data() && is_string( $errors->get_error_data() ) ) {					$messages[] = $emessage . ' ' . esc_html( strip_tags( $errors->get_error_data() ) );				} else {					$messages[] = $emessage;				}			}			$this->error = implode( ', ', $messages );		}		echo '<script>jQuery(\'.waiting-' . esc_js( $this->upgrader->update_current ) . '\').hide();</script>';	}

Changelog

Introduced in 3.0.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.

5.9.0
Renamed $error to $errors for PHP 8 named parameter support.from the docblock
3.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/class-bulk-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.