wppaste
WordPress

wp_xmlrpc_server::error( IXR_Error|string $error, false $message = false )

Since
5.7.3
Source
wp-includes/class-wp-xmlrpc-server.php:379
Sends error response to client.

Description

Sends an XML error response to the client. If the endpoint is enabled an HTTP 200 response is always sent per the XML-RPC specification.

Compatibility

WordPress
since 5.7.3
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

$errorIXR_Error|string
Error code or an error object.
$messagefalseoptional
Error message. Optional.Default: false

Performance profile

How much work a call to wp_xmlrpc_server::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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
11–23

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

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 callbacksapply_filters()one call below wp_xmlrpc_server::error()

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 wp_xmlrpc_server::error() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always11–18->getXml(), ->output()
always16–23status_header(), ->getXml(), ->output()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 23 instructions, 11–23 executed per call, 3 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 · 3

Source code

View on Trac View on GitHub 

	public function error( $error, $message = false ) {		// Accepts either an error object or an error code and message		if ( $message && ! is_object( $error ) ) {			$error = new IXR_Error( $error, $message );		} 		if ( ! $this->is_enabled ) {			status_header( $error->code );		} 		$this->output( $error->getXml() );	}

Changelog

Introduced in 5.7.3. 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.9.7 tag, from src/wp-includes/class-wp-xmlrpc-server.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.