<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[44666] trunk/src/wp-includes/functions.php: Bootstrap/Load: Support `WP_Error` and `$args` passed to `wp_die()` consistently in all handlers.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/44666">44666</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/44666","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-01-21 16:01:53 +0000 (Mon, 21 Jan 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Bootstrap/Load: Support `WP_Error` and `$args` passed to `wp_die()` consistently in all handlers.
Prior to this change, each `wp_die()` handler had their own logic for how to parse arguments, causing inconsistencies and even breakage because the arguments possible to pass to `wp_die()` depended on the request context. Passing a `WP_Error` as `$message` for example used to be only support by the default handler, but not the AJAX and XML-RPC handlers.
With the fatal error protection, plus the new `wp_die()` handlers related to that, improving this support and compatibility has become more significant. Therefore this changeset introduces a private `_wp_die_process_input()` function that handles all function parameters consistently.
Props spacedmonkey, flixos90, schlessera.
Fixes <a href="https://core.trac.wordpress.org/ticket/45933">#45933</a>. See <a href="https://core.trac.wordpress.org/ticket/44458">#44458</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2019-01-21 13:53:33 UTC (rev 44665)
+++ trunk/src/wp-includes/functions.php 2019-01-21 16:01:53 UTC (rev 44666)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2955,6 +2955,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $text_direction The text direction. This is only useful internally, when WordPress
</span><span class="cx" style="display: block; padding: 0 10px"> * is still loading and the site's locale is not set up yet. Accepts 'rtl'.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default is the value of is_rtl().
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $code Error code to use. Default is 'wp_die', or the main error code if $message
+ * is a WP_Error.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_die( $message = '', $title = '', $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3021,34 +3023,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args Optional. Arguments to control behavior. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _default_wp_die_handler( $message, $title = '', $args = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $defaults = array( 'response' => 500 );
- $r = wp_parse_args( $args, $defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $message, $title, $r ) = _wp_die_process_input( $message, $title, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $have_gettext = function_exists( '__' );
-
- if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
- if ( empty( $title ) ) {
- $error_data = $message->get_error_data();
- if ( is_array( $error_data ) && isset( $error_data['title'] ) ) {
- $title = $error_data['title'];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_string( $message ) ) {
+ if ( ! empty( $r['additional_errors'] ) ) {
+ $message = array_merge(
+ array( $message ),
+ wp_list_pluck( $r['additional_errors'], 'message' )
+ );
+ $message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $message ) . "</li>\n\t</ul>";
+ } else {
+ $message = "<p>$message</p>";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $errors = $message->get_error_messages();
- switch ( count( $errors ) ) {
- case 0:
- $message = '';
- break;
- case 1:
- $message = "<p>{$errors[0]}</p>";
- break;
- default:
- $message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
- break;
- }
- } elseif ( is_string( $message ) ) {
- $message = "<p>$message</p>";
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $have_gettext = function_exists( '__' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['link_url'] ) && ! empty( $r['link_text'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $link_url = $r['link_url'];
</span><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'esc_url' ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3070,17 +3060,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> header( 'Content-Type: text/html; charset=utf-8' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $title ) ) {
- $title = $have_gettext ? __( 'WordPress › Error' ) : 'WordPress › Error';
- }
-
- $text_direction = 'ltr';
- if ( isset( $r['text_direction'] ) && 'rtl' == $r['text_direction'] ) {
- $text_direction = 'rtl';
- } elseif ( function_exists( 'is_rtl' ) && is_rtl() ) {
- $text_direction = 'rtl';
- }
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $text_direction = $r['text_direction'];
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'language_attributes' ) && function_exists( 'is_rtl' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $dir_attr = get_language_attributes();
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3237,14 +3217,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args Optional. Arguments to control behavior. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _json_wp_die_handler( $message, $title = '', $args = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $defaults = array( 'response' => 500 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $message, $title, $r ) = _wp_die_process_input( $message, $title, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_parse_args( $args, $defaults );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'code' => 'wp_die',
- 'message' => $message,
- 'status' => $r['response'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'code' => $r['code'],
+ 'message' => $message,
+ 'data' => array(
+ 'status' => $r['response'],
+ ),
+ 'additional_errors' => $r['additional_errors'],
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! headers_sent() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3274,9 +3255,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_xmlrpc_server;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $defaults = array( 'response' => 500 );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_parse_args( $args, $defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $message, $title, $r ) = _wp_die_process_input( $message, $title, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_xmlrpc_server ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $error = new IXR_Error( $r['response'], $message );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3298,11 +3278,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args Optional. Arguments to control behavior. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _ajax_wp_die_handler( $message, $title = '', $args = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $defaults = array(
- 'response' => 200,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set default 'response' to 200 for AJAX requests.
+ $args = wp_parse_args(
+ $args,
+ array( 'response' => 200 )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_parse_args( $args, $defaults );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $message, $title, $r ) = _wp_die_process_input( $message, $title, $args );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! headers_sent() && null !== $r['response'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> status_header( $r['response'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3331,6 +3314,83 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Processes arguments passed to {@see wp_die()} consistently for its handlers.
+ *
+ * @since 5.1.0
+ * @access private
+ *
+ * @param string $message Error message.
+ * @param string $title Optional. Error title. Default empty.
+ * @param string|array $args Optional. Arguments to control behavior. Default empty array.
+ * @return array List of processed $message string, $title string, and $args array.
+ */
+function _wp_die_process_input( $message, $title = '', $args = array() ) {
+ $defaults = array(
+ 'response' => 0,
+ 'code' => '',
+ 'back_link' => false,
+ 'link_url' => '',
+ 'link_text' => '',
+ 'text_direction' => '',
+ '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' => $error->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';
+ }
+ }
+
+ return array( $message, $title, $args );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Encode a variable into JSON, with some sanity checks.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.1.0
</span></span></pre>
</div>
</div>
</body>
</html>