Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

_xml_wp_die_handler() WordPress Function

The xml_wp_die_handler() function is a custom handler for printing XML errors when the Wordpress XML-RPC interface is accessed. It is used to print a more user-friendly error message when an XML error is encountered.

_xml_wp_die_handler( string $message, string $title = '', string|array $args = array() ) #

Kills WordPress execution and displays XML response with an error message.


Description

This is the handler for wp_die() when processing XML requests.


Top ↑

Parameters

$message

(string)(Required)Error message.

$title

(string)(Optional) Error title.

Default value: ''

$args

(string|array)(Optional) Arguments to control behavior.

Default value: array()


Top ↑

Source

File: wp-includes/functions.php

function _xml_wp_die_handler( $message, $title = '', $args = array() ) {
	list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );

	$message = htmlspecialchars( $message );
	$title   = htmlspecialchars( $title );

	$xml = <<<EOD
<error>
    <code>{$parsed_args['code']}</code>
    <title><![CDATA[{$title}]]></title>
    <message><![CDATA[{$message}]]></message>
    <data>
        <status>{$parsed_args['response']}</status>
    </data>
</error>

EOD;

	if ( ! headers_sent() ) {
		header( "Content-Type: text/xml; charset={$parsed_args['charset']}" );
		if ( null !== $parsed_args['response'] ) {
			status_header( $parsed_args['response'] );
		}
		nocache_headers();
	}

	echo $xml;
	if ( $parsed_args['exit'] ) {
		die();
	}
}


Top ↑

Changelog

Changelog
VersionDescription
5.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More