Improve line-wrapping and formatting in the DocBlock for wp_send_json_error().

See #30469.


git-svn-id: https://develop.svn.wordpress.org/trunk@30614 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-28 11:38:59 +00:00
parent 7bf6ff37e2
commit f7e01d5331

View File

@ -2807,12 +2807,14 @@ function wp_send_json_success( $data = null ) {
/**
* Send a JSON response back to an Ajax request, indicating failure.
*
* If the `$data` parameter is a `WP_Error` object, the errors within the object are processed
* and output as an array of error codes and corresponding messages. All other types are
* output without further processing.
* If the `$data` parameter is a {@see WP_Error} object, the errors
* within the object are processed and output as an array of error
* codes and corresponding messages. All other types are output
* without further processing.
*
* @since 3.5.0
* @since 4.1.0 The `$data` parameter is now processed if a `WP_Error` object is passed in.
* @since 4.1.0 The `$data` parameter is now processed if a {@see WP_Error}
* object is passed in.
*
* @param mixed $data Data to encode as JSON, then print and die.
*/