4.1 Docs Audit: Ensure optional arguments in `wp_json_encode()` are properly documented as such.

See #30469.

Built from https://develop.svn.wordpress.org/trunk@30613


git-svn-id: http://core.svn.wordpress.org/trunk@30603 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-28 11:36:23 +00:00
parent 1357e2fd2f
commit 68432b0cd1
2 changed files with 4 additions and 3 deletions

View File

@ -2641,8 +2641,9 @@ function _scalar_wp_die_handler( $message = '' ) {
* @since 4.1.0 * @since 4.1.0
* *
* @param mixed $data Variable (usually an array or object) to encode as JSON. * @param mixed $data Variable (usually an array or object) to encode as JSON.
* @param int $options Options to be passed to json_encode(). Default 0. * @param int $options Optional. Options to be passed to json_encode(). Default 0.
* @param int $depth Maximum depth to walk through $data. Must be greater than 0, default 512. * @param int $depth Optional. Maximum depth to walk through $data. Must be
* greater than 0. Default 512.
* @return bool|string The JSON encoded string, or false if it cannot be encoded. * @return bool|string The JSON encoded string, or false if it cannot be encoded.
*/ */
function wp_json_encode( $data, $options = 0, $depth = 512 ) { function wp_json_encode( $data, $options = 0, $depth = 512 ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30612'; $wp_version = '4.1-beta2-30613';
/** /**
* 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.