<!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>[50641] trunk/src/wp-includes: Docs: Clarify return results for a non-existing ID in 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/50641">50641</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/50641","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>davidbaumwald</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-04-02 15:47:34 +0000 (Fri, 02 Apr 2021)</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: Clarify return results for a non-existing ID in metadata functions.
<a href="https://core.trac.wordpress.org/changeset/48658">[48658]</a> documented that various metadata functions return false for an invalid ID. However, that does not clarify what an invalid ID is: a non-numeric, zero, or negative value. This change adds the clarification in all relevant metadata function docblocks.
Props icopydoc, SergeyBiryukov, davidkryzaniak, audrasjb.
Fixes <a href="https://core.trac.wordpress.org/ticket/51797">#51797</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 2021-04-02 15:46:33 UTC (rev 50640)
+++ trunk/src/wp-includes/comment.php 2021-04-02 15:47:34 UTC (rev 50641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -493,10 +493,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Optional. The meta key to retrieve. By default,
</span><span class="cx" style="display: block; padding: 0 10px"> * returns data for all keys.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. Whether to return a single value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This parameter has no effect if $key is not specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This parameter has no effect if `$key` is not specified.
</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 mixed An array if $single is false. The value of meta data field
- * if $single is true. False for an invalid $comment_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed An array of values if `$single` is false.
+ * The value of meta data field if `$single` is true.
+ * False for an invalid `$comment_id` (non-numeric, zero, or negative value).
+ * An empty string if a valid but non-existing comment ID is passed.
</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></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 2021-04-02 15:46:33 UTC (rev 50640)
+++ trunk/src/wp-includes/meta.php 2021-04-02 15:47:34 UTC (rev 50641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -497,10 +497,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id ID of the object metadata is for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
</span><span class="cx" style="display: block; padding: 0 10px"> * the specified object. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $single Optional. If true, return only the first value of the specified meta_key.
- * This parameter has no effect if meta_key is not specified. Default false.
- * @return mixed Single metadata value, or array of values.
- * False if there's a problem with the parameters passed to the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $single Optional. If true, return only the first value of the specified `$meta_key`.
+ * This parameter has no effect if `$meta_key` is not specified. Default false.
+ * @return mixed An array of values if `$single` is false.
+ * The value of the meta field if `$single` is true.
+ * False for an invalid `$object_id` (non-numeric, zero, or negative value),
+ * or if `$meta_type` is not specified.
+ * An empty string if a valid but non-existing object ID is passed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -521,10 +524,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id ID of the object metadata is for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
</span><span class="cx" style="display: block; padding: 0 10px"> * the specified object. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $single Optional. If true, return only the first value of the specified meta_key.
- * This parameter has no effect if meta_key is not specified. Default false.
- * @return mixed Single metadata value, or array of values. Null if the value does not exist.
- * False if there's a problem with the parameters passed to the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $single Optional. If true, return only the first value of the specified `$meta_key`.
+ * This parameter has no effect if `$meta_key` is not specified. Default false.
+ * @return mixed An array of values if `$single` is false.
+ * The value of the meta field if `$single` is true.
+ * False for an invalid `$object_id` (non-numeric, zero, or negative value),
+ * or if `$meta_type` is not specified.
+ * Null if the value does not exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_metadata_raw( $meta_type, $object_id, $meta_key = '', $single = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $meta_type || ! is_numeric( $object_id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -608,9 +614,10 @@
</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 $object_id ID of the object metadata is for.
</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 bool $single Optional. If true, return only the first value of the specified meta_key.
- * This parameter has no effect if meta_key is not specified. Default false.
- * @return mixed Single metadata value, or array of values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $single Optional. If true, return only the first value of the specified `$meta_key`.
+ * This parameter has no effect if `$meta_key` is not specified. Default false.
+ * @return mixed An array of default values if `$single` is false.
+ * The default 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_metadata_default( $meta_type, $object_id, $meta_key, $single = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $single ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1401,11 +1408,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Current value passed to filter.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id ID of the object metadata is for.
</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 bool $single If true, return only the first value of the specified meta_key.
- * This parameter has no effect if meta_key is not specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $single If true, return only the first value of the specified `$meta_key`.
+ * This parameter has no effect if `$meta_key` is not specified.
</ins><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed Single metadata default, or array of defaults.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed An array of default values if `$single` is false.
+ * The default 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 filter_default_metadata( $value, $object_id, $meta_key, $single, $meta_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_meta_keys;
</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 2021-04-02 15:46:33 UTC (rev 50640)
+++ trunk/src/wp-includes/ms-site.php 2021-04-02 15:47:34 UTC (rev 50641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1084,10 +1084,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Optional. The meta key to retrieve. By default,
</span><span class="cx" style="display: block; padding: 0 10px"> * returns data for all keys. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. Whether to return a single value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This parameter has no effect if $key is not specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This parameter has no effect if `$key` is not specified.
</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 mixed An array if $single is false. The value of meta data field
- * if $single is true. False for an invalid $site_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed An array of values if `$single` is false.
+ * The value of meta data field if `$single` is true.
+ * False for an invalid `$site_id` (non-numeric, zero, or negative value).
+ * An empty string if a valid but non-existing site ID is passed.
</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="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 2021-04-02 15:46:33 UTC (rev 50640)
+++ trunk/src/wp-includes/post.php 2021-04-02 15:47:34 UTC (rev 50641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2236,10 +2236,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Optional. The meta key to retrieve. By default,
</span><span class="cx" style="display: block; padding: 0 10px"> * returns data for all keys. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. Whether to return a single value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This parameter has no effect if $key is not specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This parameter has no effect if `$key` is not specified.
</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 mixed An array if $single is false. The value of the meta field
- * if $single is true. False for an invalid $post_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed An array of values if `$single` is false.
+ * The value of the meta field if `$single` is true.
+ * False for an invalid `$post_id` (non-numeric, zero, or negative value).
+ * An empty string if a valid but non-existing post ID is passed.
</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></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 2021-04-02 15:46:33 UTC (rev 50640)
+++ trunk/src/wp-includes/taxonomy.php 2021-04-02 15:47:34 UTC (rev 50641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1324,10 +1324,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Optional. The meta key to retrieve. By default,
</span><span class="cx" style="display: block; padding: 0 10px"> * returns data for all keys. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. Whether to return a single value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This parameter has no effect if $key is not specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This parameter has no effect if `$key` is not specified.
</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 mixed An array if $single is false. The value of the meta field
- * if $single is true. False for an invalid $term_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed An array of values if `$single` is false.
+ * The value of the meta field if `$single` is true.
+ * False for an invalid `$term_id` (non-numeric, zero, or negative value).
+ * An empty string if a valid but non-existing term ID is passed.
</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></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 2021-04-02 15:46:33 UTC (rev 50640)
+++ trunk/src/wp-includes/user.php 2021-04-02 15:47:34 UTC (rev 50641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1008,10 +1008,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Optional. The meta key to retrieve. By default,
</span><span class="cx" style="display: block; padding: 0 10px"> * returns data for all keys.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. Whether to return a single value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This parameter has no effect if $key is not specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This parameter has no effect if `$key` is not specified.
</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 mixed An array if $single is false. The value of meta data field
- * if $single is true. False for an invalid $user_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed An array of values if `$single` is false.
+ * The value of meta data field if `$single` is true.
+ * False for an invalid `$user_id` (non-numeric, zero, or negative value).
+ * An empty string if a valid but non-existing user ID is passed.
</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></pre>
</div>
</div>
</body>
</html>