<!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>[30078] trunk/src/wp-includes/functions.php: Docs and code standards cleanup for [30055] (`wp_json_encode()` & friends)</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 { 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/30078">30078</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/30078","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>markjaquith</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-28 21:28:34 +0000 (Tue, 28 Oct 2014)</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'>Docs and code standards cleanup for <a href="https://core.trac.wordpress.org/changeset/30055">[30055]</a> (`wp_json_encode()` & friends)
fixes <a href="https://core.trac.wordpress.org/ticket/28786">#28786</a>
props TobiasBg</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 2014-10-28 21:25:30 UTC (rev 30077)
+++ trunk/src/wp-includes/functions.php 2014-10-28 21:28:34 UTC (rev 30078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2613,23 +2613,24 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Encode a variable into JSON, with some sanity checks
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Encode a variable into JSON, with some sanity checks.
</ins><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 class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $data Variable (usually an array or object) to encode as JSON
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $data Variable (usually an array or object) to encode as JSON.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $options Options to be passed to json_encode(). Default 0.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $depth Maximum depth to walk through $data. Must be greater than 0, default 512.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
- * @return bool|string The JSON encoded string, or false if it cannot be encoded
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|string The JSON encoded string, or false if it cannot be encoded.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_json_encode( $data, $options = 0, $depth = 512 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // json_encode has had extra params added over the years.
- // $options was added in 5.3, and $depth in 5.5.
- // We need to make sure we call it with the correct arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * json_encode() has had extra params added over the years.
+ * $options was added in 5.3, and $depth in 5.5.
+ * We need to make sure we call it with the correct arguments.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( version_compare( PHP_VERSION, '5.5', '>=' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array( $data, $options, $depth );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else if ( version_compare( PHP_VERSION, '5.3', '>=' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( version_compare( PHP_VERSION, '5.3', '>=' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = array( $data, $options );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array( $data );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2637,8 +2638,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $json = call_user_func_array( 'json_encode', $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If json_encode() was successful, no need to do more sanity checking.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $json ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If json_encode was successful, no need to do more sanity checking
</del><span class="cx" style="display: block; padding: 0 10px"> return $json;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2652,7 +2653,17 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ignore
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Perform sanity checks on data that shall be encoded to JSON.
+ *
+ * @see wp_json_encode()
+ *
+ * @since 4.1.0
+ * @access private
+ * @internal
+ *
+ * @param mixed $data Variable (usually an array or object) to encode as JSON.
+ * @param int $depth Maximum depth to walk through $data. Must be greater than 0.
+ * @return mixed The sanitized data that shall be encoded to JSON.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_json_sanity_check( $data, $depth ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $depth < 0 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2669,16 +2680,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $clean_id = $id;
</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">- // Check the element type, so that we're only recursing if we really have to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check the element type, so that we're only recursing if we really have to.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $el ) || is_object( $el ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else if ( is_string( $el ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_string( $el ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $output[ $clean_id ] = _wp_json_convert_string( $el );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $output[ $clean_id ] = $el;
</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">- } else if ( is_object( $data ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_object( $data ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $output = new stdClass;
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $data as $id => $el ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_string( $id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2689,13 +2700,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $el ) || is_object( $el ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else if ( is_string( $el ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_string( $el ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $output->$clean_id = _wp_json_convert_string( $el );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $output->$clean_id = $el;
</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">- } else if ( is_string( $data ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_string( $data ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return _wp_json_convert_string( $data );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> return $data;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2705,7 +2716,16 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ignore
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Convert a string to UTF-8, so that it can be safely encoded to JSON.
+ *
+ * @see _wp_json_sanity_check()
+ *
+ * @since 4.1.0
+ * @access private
+ * @internal
+ *
+ * @param string $string The string which is to be converted.
+ * @return string The checked string.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_json_convert_string( $string ) {
</span><span class="cx" style="display: block; padding: 0 10px"> static $use_mb = null;
</span></span></pre>
</div>
</div>
</body>
</html>