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

Send error response to client.

Description

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

Parameters

$error

(IXR_Error|string) (Required) Error code or an error object.

$message

(false) (Optional) Error message. Optional.

Default value: false

Source

File: wp-includes/class-wp-xmlrpc-server.php

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

Version Description
5.7.3 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/error