<!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>[47611] trunk/src/wp-includes: Docs: Synchronize parameter documentation for various metadata functions, update per the documentation standards.</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/47611">47611</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/47611","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 10:29:34 +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: Synchronize parameter documentation for various metadata functions, update per the documentation standards.
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="#trunksrcwpincludesdeprecatedphp">trunk/src/wp-includes/deprecated.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="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.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-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/comment.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -447,10 +447,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/reference/functions/add_comment_meta/
</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 int $comment_id Comment ID.
- * @param string $meta_key Metadata name.
- * @param mixed $meta_value Metadata value.
- * @param bool $unique Optional. Whether the same key should not be added. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $comment_id Comment ID.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @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">@@ -467,9 +468,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/reference/functions/delete_comment_meta/
</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 int $comment_id comment ID
- * @param string $meta_key Metadata name.
- * @param mixed $meta_value Optional. Metadata value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $comment_id Comment ID.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Optional. Metadata value. If provided,
+ * rows will only be removed that match the value.
+ * Must be serializable if non-scalar. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True 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 delete_comment_meta( $comment_id, $meta_key, $meta_value = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -482,11 +485,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/reference/functions/get_comment_meta/
</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 int $comment_id Comment ID.
- * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
- * @param bool $single Optional. Whether to return a single value. Default false.
- * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
- * is true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $comment_id Comment ID.
+ * @param string $key Optional. The meta key to retrieve. By default,
+ * returns data for all keys.
+ * @param bool $single Optional. Whether to return a single value.
+ * This parameter has no effect if $key is not specified.
+ * Default false.
+ * @return mixed An array if $single is false. The value of meta data field
+ * if $single is true.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_meta( $comment_id, $key = '', $single = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_metadata( 'comment', $comment_id, $key, $single );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -503,11 +509,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/reference/functions/update_comment_meta/
</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 int $comment_id Comment ID.
- * @param string $meta_key Metadata key.
- * @param mixed $meta_value Metadata value.
- * @param mixed $prev_value Optional. Previous value to check before updating. Default empty.
- * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $comment_id Comment ID.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param mixed $prev_value Optional. Previous value to check before updating.
+ * Default empty.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update,
+ * false on failure.
</ins><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 class="cx" style="display: block; padding: 0 10px"> return update_metadata( 'comment', $comment_id, $meta_key, $meta_value, $prev_value );
</span></span></pre></div>
<a id="trunksrcwpincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/deprecated.php 2020-04-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/deprecated.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2211,7 +2211,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata key.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Metadata value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Optional. Metadata value. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True deletion completed and false if user_id is not a number.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2257,7 +2257,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_user_meta()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $meta_key Optional. Metadata key.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $meta_key Optional. Metadata key. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_usermeta( $user_id, $meta_key = '' ) {
</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-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/meta.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -662,7 +662,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
</span><span class="cx" style="display: block; padding: 0 10px"> * or any other object type with an associated meta table.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $meta_id ID for a specific meta row.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $meta_value Metadata value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $meta_value Metadata value. Must be serializable if non-scalar.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Optional. You can provide a meta key to update it. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool 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-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/ms-site.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -385,7 +385,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $site_ids List of site IDs.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|false An array of metadata on success, false if there is nothing to update.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_sitemeta_cache( $site_ids ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Ensure this filter is hooked in even if the function is called early.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1059,8 +1059,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $site_id Site ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Optional. Metadata value. Must be serializable if
- * non-scalar. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Optional. Metadata value. If provided,
+ * rows will only be removed that match the value.
+ * Must be serializable if non-scalar. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True 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 delete_site_meta( $site_id, $meta_key, $meta_value = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1073,11 +1074,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $site_id Site ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $key Optional. The meta key to retrieve. By default, returns
- * data for all keys. Default empty.
- * @param bool $single Optional. Whether to return a single value. Default false.
- * @return mixed Will be an array if $single is false. Will be value of meta data
- * field if $single is true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $key Optional. The meta key to retrieve. By default,
+ * returns data for all keys. Default empty.
+ * @param bool $single Optional. Whether to return a single value.
+ * This parameter has no effect if $key is not specified.
+ * Default false.
+ * @return mixed An array if $single is false. The value of meta data field
+ * if $single is true.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_site_meta( $site_id, $key = '', $single = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_metadata( 'blog', $site_id, $key, $single );
</span></span></pre></div>
<a id="trunksrcwpincludesoptionphp"></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/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2020-04-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/option.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -452,7 +452,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $option Name of option to add. Expected to not be SQL-escaped.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $value Optional. Option value. Must be serializable if non-scalar.
+ * Expected to not be SQL-escaped.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $deprecated Optional. Description. Not used anymore.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default is enabled. Accepts 'no' to disable for legacy reasons.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -747,8 +748,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.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 string $transient Transient name. Expected to not be SQL-escaped. Must be
- * 172 characters or fewer in length.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $transient Transient name. Expected to not be SQL-escaped.
+ * Must be 172 characters or fewer in length.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Transient value. Must be serializable if non-scalar.
</span><span class="cx" style="display: block; padding: 0 10px"> * Expected to not be SQL-escaped.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).
</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-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/post.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2090,8 +2090,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id Post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Optional. Metadata value. Must be serializable if
- * non-scalar. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Optional. Metadata value. If provided,
+ * rows will only be removed that match the value.
+ * Must be serializable if non-scalar. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True 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 delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2110,12 +2111,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id Post ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $key Optional. The meta key to retrieve. By default, returns
- * data for all keys. Default empty.
- * @param bool $single Optional. If true, returns only the first value for the specified meta key.
- * This parameter has no effect if $key is not specified. Default false.
- * @return mixed Will be an array if $single is false. Will be value of the meta
- * field if $single is true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $key Optional. The meta key to retrieve. By default,
+ * returns data for all keys. Default empty.
+ * @param bool $single Optional. Whether to return a single value.
+ * This parameter has no effect if $key is not specified.
+ * Default false.
+ * @return mixed An array if $single is false. The value of the meta field
+ * if $single is true.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_post_meta( $post_id, $key = '', $single = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_metadata( 'post', $post_id, $key, $single );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2136,9 +2138,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id Post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata key.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $prev_value Optional. Previous value to check before updating. Default empty.
- * @return int|bool The new meta field ID if a field with the given key didn't exist and was
- * therefore added, true on successful update, false on failure.
</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.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update,
+ * false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Make sure meta is added to the post, not a revision.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6766,8 +6769,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int[] $post_ids Array of post IDs.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|false Returns false if there is nothing to update or an array
- * of metadata.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|false An array of metadata on success, false if there is nothing to update.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_postmeta_cache( $post_ids ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return update_meta_cache( 'post', $post_ids );
</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-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/taxonomy.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1211,11 +1211,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Metadata value.
- * @param bool $unique Optional. Whether to bail if an entry with the same key is found for the term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param bool $unique Optional. Whether the same key should not be added.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|WP_Error|bool Meta ID on success. WP_Error when term_id is ambiguous between taxonomies.
- * False on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|false|WP_Error Meta ID on success, false on failure.
+ * WP_Error when term_id is ambiguous between taxonomies.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_term_is_shared( $term_id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1232,7 +1232,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Optional. Metadata value. If provided, rows will only be removed that match the value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Optional. Metadata value. If provided,
+ * rows will only be removed that match the value.
+ * Must be serializable if non-scalar. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True 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 delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1245,10 +1247,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><del style="background-color: #fdd; text-decoration:none; 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.
- * @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.
- * @return mixed If `$single` is false, an array of metadata values. If `$single` is true, a single metadata value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $key Optional. The meta key to retrieve. By default,
+ * returns data for all keys. Default empty.
+ * @param bool $single Optional. Whether to return a single value.
+ * This parameter has no effect if $key is not specified.
+ * Default false.
+ * @return mixed An array if $single is false. The value of the meta field
+ * if $single is true.
</ins><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="cx" style="display: block; padding: 0 10px"> return get_metadata( 'term', $term_id, $key, $single );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1265,10 +1270,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata key.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Metadata value.
- * @param mixed $prev_value Optional. Previous value to check before updating. Default empty.
- * @return int|WP_Error|bool Meta ID if the key didn't previously exist. True on successful update.
- * WP_Error when term_id is ambiguous between taxonomies. False on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param mixed $prev_value Optional. Previous value to check before updating.
+ * Default empty.
+ * @return int|bool|WP_Error Meta ID if the key didn't exist. true on successful update,
+ * false on failure. WP_Error when term_id is ambiguous
+ * between taxonomies.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_term_is_shared( $term_id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1287,7 +1294,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $term_ids List of term IDs.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|false An array of metadata on success, false if there is nothing to update.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_termmeta_cache( $term_ids ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return update_meta_cache( 'term', $term_ids );
</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-22 09:38:12 UTC (rev 47610)
+++ trunk/src/wp-includes/user.php 2020-04-22 10:29:34 UTC (rev 47611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -786,8 +786,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Metadata value.
- * @param bool $unique Optional. Whether the same key should not be added. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @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|false 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_user_meta( $user_id, $meta_key, $meta_value, $unique = false ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -806,7 +807,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Optional. Metadata value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Optional. Metadata value. If provided,
+ * rows will only be removed that match the value.
+ * Must be serializable if non-scalar. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True 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 delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -820,9 +823,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/reference/functions/get_user_meta/
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
- * @param bool $single Optional. Whether to return a single value. Default false.
- * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $key Optional. The meta key to retrieve. By default,
+ * returns data for all keys.
+ * @param bool $single Optional. Whether to return a single value.
+ * This parameter has no effect if $key is not specified.
+ * Default false.
+ * @return mixed An array if $single is false. The value of meta data field
+ * if $single is true.
</ins><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="cx" style="display: block; padding: 0 10px"> return get_metadata( 'user', $user_id, $key, $single );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -841,9 +848,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Metadata key.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $meta_value Metadata value.
- * @param mixed $prev_value Optional. Previous value to check before updating. Default empty.
- * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param mixed $prev_value Optional. Previous value to check before updating.
+ * Default empty.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update,
+ * false on failure.
</ins><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 class="cx" style="display: block; padding: 0 10px"> return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value );
</span></span></pre>
</div>
</div>
</body>
</html>