Docs: Improve documentation for `wp_die()` handlers.

See #46543.
Built from https://develop.svn.wordpress.org/trunk@44921


git-svn-id: http://core.svn.wordpress.org/trunk@44752 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-03-17 01:45:50 +00:00
parent 72b33ec883
commit 81ca7552b8
2 changed files with 14 additions and 14 deletions

View File

@ -2921,7 +2921,7 @@ function wp_nonce_ays( $action ) {
} }
/** /**
* Kill WordPress execution and display HTML message with error message. * Kills WordPress execution and displays HTML page with an error message.
* *
* This function complements the `die()` PHP function. The difference is that * This function complements the `die()` PHP function. The difference is that
* HTML will be displayed to the user. It is recommended to use this function * HTML will be displayed to the user. It is recommended to use this function
@ -3013,10 +3013,10 @@ function wp_die( $message = '', $title = '', $args = array() ) {
} }
/** /**
* Kills WordPress execution and display HTML message with error message. * Kills WordPress execution and displays HTML page with an error message.
* *
* This is the default handler for wp_die if you want a custom one for your * This is the default handler for wp_die(). If you want a custom one,
* site then you can overload using the {@see 'wp_die_handler'} filter in wp_die(). * you can override this using the {@see 'wp_die_handler'} filter in wp_die().
* *
* @since 3.0.0 * @since 3.0.0
* @access private * @access private
@ -3210,9 +3210,9 @@ function _default_wp_die_handler( $message, $title = '', $args = array() ) {
} }
/** /**
* Kill WordPress execution and display JSON message with error message. * Kills WordPress execution and displays JSON response with an error message.
* *
* This is the handler for wp_die when processing JSON requests. * This is the handler for wp_die() when processing JSON requests.
* *
* @since 5.1.0 * @since 5.1.0
* @access private * @access private
@ -3248,9 +3248,9 @@ function _json_wp_die_handler( $message, $title = '', $args = array() ) {
} }
/** /**
* Kill WordPress execution and display XML message with error message. * Kills WordPress execution and displays XML response with an error message.
* *
* This is the handler for wp_die when processing XMLRPC requests. * This is the handler for wp_die() when processing XMLRPC requests.
* *
* @since 3.2.0 * @since 3.2.0
* @access private * @access private
@ -3280,9 +3280,9 @@ function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
} }
/** /**
* Kill WordPress ajax execution. * Kills WordPress execution and displays Ajax response with an error message.
* *
* This is the handler for wp_die when processing Ajax requests. * This is the handler for wp_die() when processing Ajax requests.
* *
* @since 3.4.0 * @since 3.4.0
* @access private * @access private
@ -3322,9 +3322,9 @@ function _ajax_wp_die_handler( $message, $title = '', $args = array() ) {
} }
/** /**
* Kill WordPress execution. * Kills WordPress execution and displays an error message.
* *
* This is the handler for wp_die when processing APP requests. * This is the handler for wp_die() when processing APP requests.
* *
* @since 3.4.0 * @since 3.4.0
* @since 5.1.0 Added the $title and $args parameters. * @since 5.1.0 Added the $title and $args parameters.
@ -3350,7 +3350,7 @@ function _scalar_wp_die_handler( $message = '', $title = '', $args = array() ) {
} }
/** /**
* Processes arguments passed to {@see wp_die()} consistently for its handlers. * Processes arguments passed to wp_die() consistently for its handlers.
* *
* @since 5.1.0 * @since 5.1.0
* @access private * @access private

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.2-alpha-44920'; $wp_version = '5.2-alpha-44921';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.