<!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>[25076] trunk/src/wp-includes: Improve inline docs for function params that can be serialized when non-scalar.</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">

<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25076">25076</a></dd>

<dt>Author</dt> <dd>wonderboymusic</dd>

<dt>Date</dt> <dd>2013-08-21 21:10:23 +0000 (Wed, 21 Aug 2013)</dd>

</dl>

<h3>Log Message</h3>

<pre>Improve inline docs for function params that can be serialized when non-scalar. Fixes <a href="http://core.trac.wordpress.org/ticket/18488">#18488</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.php</a></li>

<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>

<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludesmetaphp"></a>

<div class="modfile"><h4>Modified: trunk/src/wp-includes/meta.php (25075 => 25076)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/src/wp-includes/meta.php   2013-08-21 19:13:35 UTC (rev 25075)

+++ trunk/src/wp-includes/meta.php      2013-08-21 21:10:23 UTC (rev 25076)

</span><span class="lines">@@ -22,7 +22,7 @@

</span><span class="cx">  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)

</span><span class="cx">  * @param int $object_id ID of the object metadata is for

</span><span class="cx">  * @param string $meta_key Metadata key

</span><del>- * @param string $meta_value Metadata value

</del><ins>+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.

</ins><span class="cx">  * @param bool $unique Optional, default is false. Whether the specified metadata key should be

</span><span class="cx">  *               unique for the object. If true, and the object already has a value for the specified

</span><span class="cx">  *               metadata key, no change will be made

</span><span class="lines">@@ -93,8 +93,8 @@

</span><span class="cx">  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)

</span><span class="cx">  * @param int $object_id ID of the object metadata is for

</span><span class="cx">  * @param string $meta_key Metadata key

</span><del>- * @param string $meta_value Metadata value

- * @param string $prev_value Optional. If specified, only update existing metadata entries with

</del><ins>+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.

+ * @param mixed $prev_value Optional. If specified, only update existing metadata entries with

</ins><span class="cx">  *                the specified value. Otherwise, update all entries.

<span class="cx">  * @return bool True on successful update, false on failure.

</span><span class="cx">  */

</span><span class="lines">@@ -174,7 +174,7 @@

</span><span class="cx">  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)

</span><span class="cx">  * @param int $object_id ID of the object metadata is for

</span><span class="cx">  * @param string $meta_key Metadata key

</span><del>- * @param string $meta_value Optional. Metadata value. If specified, only delete metadata entries

</del><ins>+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete metadata entries

</ins><span class="cx">  *                with this value. Otherwise, delete all entries with the specified meta_key.

</span><span class="cx">  * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries

</span><span class="cx">  *               for all objects, ignoring the specified object_id. Otherwise, only delete matching

</span><span class="lines">@@ -720,8 +720,8 @@

</span><span class="cx">                          $key_only_queries[$k] = $q;

</span><span class="cx">                          unset( $this->queries[$k] );

</span><span class="cx">                  }

</span><del>-               }               

-               

</del><ins>+                }

+

</ins><span class="cx">           // Split out the meta_key only queries (we can only do this for OR)

</span><span class="cx">          if ( 'OR' == $this->relation ) {

</span><span class="cx">                  foreach ( $this->queries as $k => $q ) {

</span></span></pre></div>

<a id="trunksrcwpincludesoptionphp"></a>

<div class="modfile"><h4>Modified: trunk/src/wp-includes/option.php (25075 => 25076)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/src/wp-includes/option.php 2013-08-21 19:13:35 UTC (rev 25075)

+++ trunk/src/wp-includes/option.php    2013-08-21 21:10:23 UTC (rev 25076)

</span><span class="lines">@@ -208,7 +208,7 @@

<span class="cx">  * @uses do_action() Calls 'update_option_$option' and 'updated_option' hooks on success.

</span><span class="cx">  *

<span class="cx">  * @param string $option Option name. Expected to not be SQL-escaped.

<del>- * @param mixed $newvalue Option value. Expected to not be SQL-escaped.

</del><ins>+ * @param mixed $newvalue Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

</ins><span class="cx">  * @return bool False if value was not updated and true if value was updated.

</span><span class="cx">  */

</span><span class="cx"> function update_option( $option, $newvalue ) {

</span><span class="lines">@@ -284,7 +284,7 @@

<span class="cx">  * @uses do_action() Calls 'add_option_$option' and 'added_option' hooks on success.

</span><span class="cx">  *

<span class="cx">  * @param string $option Name of option to add. Expected to not be SQL-escaped.

<del>- * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.

</del><ins>+ * @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

</ins><span class="cx">  * @param mixed $deprecated Optional. Description. Not used anymore.

<span class="cx">  * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.

<span class="cx">  * @return bool False if option was not added and true if option was added.

</span><span class="lines">@@ -488,7 +488,7 @@

<span class="cx">  * @uses do_action() Calls 'set_transient_$transient' and 'setted_transient' hooks on success.

</span><span class="cx">  *

<span class="cx">  * @param string $transient Transient name. Expected to not be SQL-escaped.

<del>- * @param mixed $value Transient value. Expected to not be SQL-escaped.

</del><ins>+ * @param mixed $value Transient value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

</ins><span class="cx">  * @param int $expiration Time until expiration in seconds, default 0

<span class="cx">  * @return bool False if value was not set and true if value was set.

</span><span class="cx">  */

</span></span></pre></div>

<a id="trunksrcwpincludespostphp"></a>

<div class="modfile"><h4>Modified: trunk/src/wp-includes/post.php (25075 => 25076)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/src/wp-includes/post.php   2013-08-21 19:13:35 UTC (rev 25075)

+++ trunk/src/wp-includes/post.php      2013-08-21 21:10:23 UTC (rev 25076)

</span><span class="lines">@@ -1671,7 +1671,7 @@

</span><span class="cx">  *

<span class="cx">  * @param int $post_id Post ID.

<span class="cx">  * @param string $meta_key Metadata name.

<del>- * @param mixed $meta_value Metadata value.

</del><ins>+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.

</ins><span class="cx">  * @param bool $unique Optional, default is false. Whether the same key should not be added.

<span class="cx">  * @return int|bool Meta ID on success, false on failure.

</span><span class="cx">  */

</span><span class="lines">@@ -1695,7 +1695,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @param int $post_id post ID

<span class="cx">  * @param string $meta_key Metadata name.

<del>- * @param mixed $meta_value Optional. Metadata value.

</del><ins>+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar.

</ins><span class="cx">  * @return bool True on success, false on failure.

</span><span class="cx">  */

</span><span class="cx"> function delete_post_meta($post_id, $meta_key, $meta_value = '') {

</span><span class="lines">@@ -1735,7 +1735,7 @@

</span><span class="cx">  *

<span class="cx">  * @param int $post_id Post ID.

<span class="cx">  * @param string $meta_key Metadata key.

<del>- * @param mixed $meta_value Metadata value.

</del><ins>+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.

</ins><span class="cx">  * @param mixed $prev_value Optional. Previous value to check before removing.

<span class="cx">  * @return bool True on success, false on failure.

</span><span class="cx">  */

</span></span></pre>

</div>

</div>

</body>

</html>