On this page
_wp_die_process_input( string|WP_Error $message, string $title = '', string|array $args = array() ): array
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.
Processes arguments passed to wp_die() consistently for its handlers.
Parameters
Return
array Processed arguments.
- string
Error message.
1stringError title.2arrayArguments to control behavior.
Source
File: wp-includes/functions.php. View all references
function _wp_die_process_input( $message, $title = '', $args = array() ) {
$defaults = array(
'response' => 0,
'code' => '',
'exit' => true,
'back_link' => false,
'link_url' => '',
'link_text' => '',
'text_direction' => '',
'charset' => 'utf-8',
'additional_errors' => array(),
);
$args = wp_parse_args( $args, $defaults );
if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
if ( ! empty( $message->errors ) ) {
$errors = array();
foreach ( (array) $message->errors as $error_code => $error_messages ) {
foreach ( (array) $error_messages as $error_message ) {
$errors[] = array(
'code' => $error_code,
'message' => $error_message,
'data' => $message->get_error_data( $error_code ),
);
}
}
$message = $errors[0]['message'];
if ( empty( $args['code'] ) ) {
$args['code'] = $errors[0]['code'];
}
if ( empty( $args['response'] ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['status'] ) ) {
$args['response'] = $errors[0]['data']['status'];
}
if ( empty( $title ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['title'] ) ) {
$title = $errors[0]['data']['title'];
}
unset( $errors[0] );
$args['additional_errors'] = array_values( $errors );
} else {
$message = '';
}
}
$have_gettext = function_exists( '__' );
// The $title and these specific $args must always have a non-empty value.
if ( empty( $args['code'] ) ) {
$args['code'] = 'wp_die';
}
if ( empty( $args['response'] ) ) {
$args['response'] = 500;
}
if ( empty( $title ) ) {
$title = $have_gettext ? __( 'WordPress › Error' ) : 'WordPress › Error';
}
if ( empty( $args['text_direction'] ) || ! in_array( $args['text_direction'], array( 'ltr', 'rtl' ), true ) ) {
$args['text_direction'] = 'ltr';
if ( function_exists( 'is_rtl' ) && is_rtl() ) {
$args['text_direction'] = 'rtl';
}
}
if ( ! empty( $args['charset'] ) ) {
$args['charset'] = _canonical_charset( $args['charset'] );
}
return array( $message, $title, $args );
}
Related
Uses
| Uses | Description |
|---|---|
| _canonical_charset() wp-includes/functions.php | Retrieves a canonical form of the provided charset appropriate for passing to PHP functions such as htmlspecialchars() and charset HTML attributes. |
| is_rtl() wp-includes/l10n.php | Determines whether the current locale is right-to-left (RTL). |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| wp_parse_args() wp-includes/functions.php | Merges user defined arguments into defaults array. |
| is_wp_error() wp-includes/load.php | Checks whether the given variable is a WordPress Error. |
Used By
| Used By | Description |
|---|---|
| _jsonp_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays JSONP response with an error message. |
| _xml_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays XML response with an error message. |
| _json_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays JSON response with an error message. |
| _scalar_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays an error message. |
| _default_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays HTML page with an error message. |
| _ajax_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays Ajax response with an error message. |
| _xmlrpc_wp_die_handler() wp-includes/functions.php | Kills WordPress execution and displays XML response with an error message. |
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_wp_die_process_input