<!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>[47610] trunk/src/wp-includes: Docs: Document the default value of `$single` and `$prev_value` parameters in various metadata functions.</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 { white-space: pre-line; 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/47610">47610</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/47610","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-04-22 09:38:12 +0000 (Wed, 22 Apr 2020)</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: Document the default value of `$single` and `$prev_value` parameters in various metadata functions.

Props denisco.

See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>.</pre>

<h3>Modified Paths</h3>

<ul>

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

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

<li><a href="#trunksrcwpincludesmssitephp">trunk/src/wp-includes/ms-site.php</a></li>

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

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

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

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludescommentphp"></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/comment.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2020-04-21 20:04:29 UTC (rev 47609)

+++ trunk/src/wp-includes/comment.php   2020-04-22 09:38:12 UTC (rev 47610)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -450,7 +450,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int $comment_id Comment ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key Metadata name.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed $meta_value Metadata value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $unique Optional, default is false. Whether the same key should not be added.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $unique Optional. Whether the same key should not be added. Default false.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|bool Meta ID on success, false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,7 +484,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param int $comment_id Comment ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $single Whether to return a single value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $single Optional. Whether to return a single value. Default false.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single

<span class="cx" style="display: block; padding: 0 10px">  *  is true.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -506,7 +506,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int $comment_id Comment ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key Metadata key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed $meta_value Metadata value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $prev_value Optional. Previous value to check before removing.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $prev_value Optional. Previous value to check before updating. Default empty.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value = '' ) {

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

<a id="trunksrcwpincludesmetaphp"></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/meta.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/meta.php    2020-04-21 20:04:29 UTC (rev 47609)

+++ trunk/src/wp-includes/meta.php      2020-04-22 09:38:12 UTC (rev 47610)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,7 +149,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key   Metadata key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.

</span><span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $prev_value Optional. If specified, only update existing metadata entries

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *                           with this value. Otherwise, update all entries.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *                           with this value. Otherwise, update all entries. Default empty.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|bool The new meta field ID if a field with the given key didn't exist and was

<span class="cx" style="display: block; padding: 0 10px">  *                  therefore added, true on successful update, false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

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

<a id="trunksrcwpincludesmssitephp"></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/ms-site.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-site.php 2020-04-21 20:04:29 UTC (rev 47609)

+++ trunk/src/wp-includes/ms-site.php   2020-04-22 09:38:12 UTC (rev 47610)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1096,7 +1096,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $site_id    Site ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key   Metadata key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed  $prev_value Optional. Previous value to check before removing.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed  $prev_value Optional. Previous value to check before updating.

</ins><span class="cx" style="display: block; padding: 0 10px">  *                           Default empty.

</span><span class="cx" style="display: block; padding: 0 10px">  * @return int|bool Meta ID if the key didn't exist, true on successful update,

<span class="cx" style="display: block; padding: 0 10px">  *                  false on failure.

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

<a id="trunksrcwpincludespostphp"></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/post.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php    2020-04-21 20:04:29 UTC (rev 47609)

+++ trunk/src/wp-includes/post.php      2020-04-22 09:38:12 UTC (rev 47610)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2136,7 +2136,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $post_id    Post ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key   Metadata key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed  $prev_value Optional. Previous value to check before updating.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed  $prev_value Optional. Previous value to check before updating. Default empty.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|bool The new meta field ID if a field with the given key didn't exist and was

<span class="cx" style="display: block; padding: 0 10px">  *                  therefore added, true on successful update, false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

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

<a id="trunksrcwpincludestaxonomyphp"></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/taxonomy.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php        2020-04-21 20:04:29 UTC (rev 47609)

+++ trunk/src/wp-includes/taxonomy.php  2020-04-22 09:38:12 UTC (rev 47610)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1246,8 +1246,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $term_id Term ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $key     Optional. The meta key to retrieve. If no key is provided, fetches all metadata for the term.

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool   $single  Whether to return a single value. If false, an array of all values matching the

- *                        `$term_id`/`$key` pair will be returned. Default: false.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool   $single  Optional. Whether to return a single value. If false, an array of all values matching the

+ *                        `$term_id`/`$key` pair will be returned. Default false.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return mixed If `$single` is false, an array of metadata values. If `$single` is true, a single metadata value.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_term_meta( $term_id, $key = '', $single = false ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1266,7 +1266,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $term_id    Term ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key   Metadata key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $meta_value Metadata value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed  $prev_value Optional. Previous value to check before removing.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed  $prev_value Optional. Previous value to check before updating. Default empty.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|WP_Error|bool Meta ID if the key didn't previously exist. True on successful update.

<span class="cx" style="display: block; padding: 0 10px">  *                           WP_Error when term_id is ambiguous between taxonomies. False on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

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

<a id="trunksrcwpincludesuserphp"></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/user.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php    2020-04-21 20:04:29 UTC (rev 47609)

+++ trunk/src/wp-includes/user.php      2020-04-22 09:38:12 UTC (rev 47610)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -821,7 +821,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $user_id User ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool   $single  Whether to return a single value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool   $single  Optional. Whether to return a single value. Default false.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_user_meta( $user_id, $key = '', $single = false ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -842,7 +842,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $user_id    User ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $meta_key   Metadata key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $meta_value Metadata value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed  $prev_value Optional. Previous value to check before removing.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed  $prev_value Optional. Previous value to check before updating. Default empty.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) {

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

</div>

</div>

</body>

</html>