Changeset 38518

Timestamp:

09/04/2016 03:40:04 AM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Update the $message parameter for _default_wp_die_handler() to notate that it can also accept a WP_Error object.

Additionally, update the $message parameter description in the DocBlock for wp_die() to make it explicitly clear messages derived from a passed WP_Error object will only be evaluated if not performing an Ajax or XML-RPC request (as both default handlers completely ignore WP_Error object messages).

See #37770.

File:

• trunk/src/wp-includes/functions.php (modified) (2 diffs)

trunk/src/wp-includes/functions.php

@@ -2573 +2573 @@
  *
  * @param string|WP_Error  $message Optional. Error message. If this is a WP_Error object,
- *                                  the error's messages are used. Default empty.
+ *                                  and not an Ajax or XML-RPC request, the error's messages are used.
+ *                                  Default empty.
  * @param string|int       $title   Optional. Error title. If `$message` is a `WP_Error` object,
  *                                  error data with the key 'title' may be used to specify the title.
@@ -2639 +2640 @@
  * @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.
+ * @param string|WP_Error $message Error message or WP_Error object.
+ * @param string          $title   Optional. Error title. Default empty.
+ * @param string|array    $args    Optional. Arguments to control behavior. Default empty array.
  */
 function _default_wp_die_handler( $message, $title = '', $args = array() ) {