<!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>[48411] trunk: Docs: Synchronize and correct documentation for various metadata functions and filters.</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/48411">48411</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/48411","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-07-09 11:24:43 +0000 (Thu, 09 Jul 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 and correct documentation for various metadata functions and filters.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/47390">[47390]</a>, <a href="https://core.trac.wordpress.org/changeset/47611">[47611]</a>, <a href="https://core.trac.wordpress.org/changeset/48192">[48192]</a>, <a href="https://core.trac.wordpress.org/changeset/48402">[48402]</a>.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>, <a href="https://core.trac.wordpress.org/ticket/43941">#43941</a>, <a href="https://core.trac.wordpress.org/ticket/45464">#45464</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.php</a></li>
<li><a href="#trunksrcwpincludesrestapifieldsclasswprestmetafieldsphp">trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php</a></li>
<li><a href="#trunktestsphpunittestsmetaregisterMetaphp">trunk/tests/phpunit/tests/meta/registerMeta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-07-08 13:42:30 UTC (rev 48410)
+++ trunk/src/wp-includes/meta.php 2020-07-09 11:24:43 UTC (rev 48411)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,9 +56,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits adding metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user). Returning a non-null value
- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,8 +89,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately before meta of a specific type is added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -120,8 +120,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately after meta of a specific type is added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,9 +189,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits updating metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user). Returning a non-null value
- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,8 +241,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately before updating metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -280,8 +280,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately after updating metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -360,9 +360,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits deleting metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user). Returning a non-null value
- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -408,8 +408,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately before deleting metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -451,8 +451,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately after deleting metadata of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -481,10 +481,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the value of a metadata field for the specified object type and ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the meta field exists, a single value is returned if `$single` is true, or an array of values if it's false.
- * If the meta field does not exist, an empty string is returned if `$single` is true, or an empty array if it's false.
- * If there's a problem with the parameters passed to the function, boolean `false` is returned.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If the meta field exists, a single value is returned if `$single` is true,
+ * or an array of values if it's false.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If the meta field does not exist, the result depends on get_metadata_default().
+ * By default, an empty string is returned if `$single` is true, or an empty array if it's false.
+ *
+ * @since 2.9.0
+ *
+ * @see get_metadata_raw()
+ * @see get_metadata_default()
+ *
+ * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
+ * or any other object type with an associated meta table.
+ * @param int $object_id ID of the object metadata is for.
+ * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
+ * the specified object. Default empty.
+ * @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.
+ */
+function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
+ $value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
+ if ( ! is_null( $value ) ) {
+ return $value;
+ }
+
+ return get_metadata_default( $meta_type, $meta_key, $single, $object_id );
+}
+
+/**
+ * Retrieves raw metadata value for the specified object.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -494,7 +523,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the specified object. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. If true, return only the first value of the specified meta_key.
</span><span class="cx" style="display: block; padding: 0 10px"> * This parameter has no effect if meta_key is not specified. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The metadata value or array of values. See description above for further details.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</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">@@ -509,9 +539,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits the return value of a meta field.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, `$meta_type`, refers to the
- * object type (comment, post, term, or user). Returning a non-null value
- * will short-circuit the return value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -519,7 +549,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * of values depending on the value of `$single`. Default null.
</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 Whether to return only the first value of the specified $meta_key.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $single Whether to return only the first value of the specified `$meta_key`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null !== $check ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -557,44 +587,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieves raw metadata for the specified object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves default metadata value for the specified object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.9.0
- * @uses get_metadata_raw()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * By default, an empty string is returned if `$single` is true, or an empty array if it's false.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0
+ *
</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">- * @param int $object_id ID of the object metadata is for.
- * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
- * the specified object. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $meta_key Metadata key.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param bool $single Optional. If true, return only the first value of the specified meta_key.
</span><span class="cx" style="display: block; padding: 0 10px"> * This parameter has no effect if meta_key is not specified. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed Single metadata value, or array of values
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $object_id Optional. ID of the object metadata is for. Default 0.
+ * @return mixed Single metadata value, or array of values.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
- $value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
- if ( ! is_null( $value ) ) {
- return $value;
- }
-
- return get_metadata_default( $meta_type, $meta_key, $single, $object_id );
-}
-
-/**
- * Retrieve metadata data default for the specified object.
- *
- * @since 5.5.0
- *
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
- * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
- * the specified object.
- * @param bool $single Optional, default is false.
- * If true, return only the first value of the specified meta_key.
- * This parameter has no effect if meta_key is not specified.
- * @param int $object_id Optional, default is 0.
- * ID of the object metadata is for
- * @return mixed Single metadata value, or array of values
- */
</del><span class="cx" style="display: block; padding: 0 10px"> function get_metadata_default( $meta_type, $meta_key, $single = false, $object_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $single ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -603,16 +609,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the default value a specified object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the default value for a specified object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.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 array|string $value The value should return - a single metadata value,
- * or an array of values.
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
- * @param string $meta_key Meta key.
- * @param bool $single Whether to return only the first value of the specified $meta_key.
- * @param int $object_id Object ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $value The value to return, either a single metadata value or an array
+ * of values depending on the value of `$single`.
+ * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
+ * or any other object type with an associated meta table.
+ * @param string $meta_key Metadata key.
+ * @param bool $single Whether to return only the first value of the specified `$meta_key`.
+ * @param int $object_id ID of the object metadata is for.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "default_{$meta_type}_metadata", $value, $meta_type, $meta_key, $single, $object_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -704,14 +714,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits the return value when fetching a meta field by meta ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, `$meta_type`, refers to the
- * object type (comment, post, term, or user). Returning a non-null value
- * will short-circuit the return value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -723,6 +731,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $check;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $meta = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE $id_column = %d", $meta_id ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $meta ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -774,9 +784,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits updating metadata of a specific type by meta ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user). Returning a non-null value
- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -890,9 +900,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits deleting metadata of a specific type by meta ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user). Returning a non-null value
- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -995,9 +1005,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Short-circuits updating the metadata cache of a specific type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, term, or user). Returning a non-null value
- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
+ * Returning a non-null value will effectively short-circuit the function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1364,6 +1374,64 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters into default_{$object_type}_metadata and adds in default value.
+ *
+ * @since 5.5.0
+ *
+ * @param mixed $value Current value passed to filter.
+ * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
+ * or any other object type with an associated meta table.
+ * @param string $meta_key Metadata key.
+ * @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.
+ * @param int $object_id ID of the object metadata is for.
+ * @return mixed Single metadata default, or array of defaults.
+ */
+function filter_default_metadata( $value, $meta_type, $meta_key, $single, $object_id ) {
+ global $wp_meta_keys;
+
+ if ( wp_installing() ) {
+ return $value;
+ }
+
+ if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $meta_type ] ) ) {
+ return $value;
+ }
+
+ $defaults = array();
+ foreach ( $wp_meta_keys[ $meta_type ] as $sub_type => $meta_data ) {
+ foreach ( $meta_data as $_meta_key => $args ) {
+ if ( $_meta_key === $meta_key && array_key_exists( 'default', $args ) ) {
+ $defaults[ $sub_type ] = $args;
+ }
+ }
+ }
+
+ if ( ! $defaults ) {
+ return $value;
+ }
+
+ // If this meta type does not have sub types, then the default is keyed as an empty string.
+ if ( isset( $defaults[''] ) ) {
+ $metadata = $defaults[''];
+ } else {
+ $sub_type = get_object_subtype( $meta_type, $object_id );
+ if ( ! isset( $defaults[ $sub_type ] ) ) {
+ return $value;
+ }
+ $metadata = $defaults[ $sub_type ];
+ }
+
+ if ( $single ) {
+ $value = $metadata['default'];
+ } else {
+ $value = array( $metadata['default'] );
+ }
+
+ return $value;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Checks if a meta key is registered.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1573,8 +1641,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the object subtype identifier for a non-standard object type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook, `$object_type`, refers to the object
- * type (post, comment, term, or user).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook, `$object_type`, refers to the meta object type
+ * (post, comment, term, user, or any other type with an associated meta table).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.8
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1583,64 +1651,3 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( "get_object_subtype_{$object_type}", $object_subtype, $object_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-/**
- * Filter into default_{$object_type}_metadata and add in default value.
- *
- * @since 5.5.0
- *
- * @param mixed $value Current value passed to filter.
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
-
- * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
- * the specified object.
- * @param bool $single Optional, default is false.
- * If true, return only the first value of the specified meta_key.
- * This parameter has no effect if meta_key is not specified.
- * @param int $object_id ID of the object metadata is for
- *
- * @return mixed Single metadata default, or array of defaults
- */
-function filter_default_metadata( $value, $meta_type, $meta_key, $single, $object_id ) {
- global $wp_meta_keys;
-
- if ( wp_installing() ) {
- return $value;
- }
-
- if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $meta_type ] ) ) {
- return $value;
- }
-
- $defaults = array();
- foreach ( $wp_meta_keys[ $meta_type ] as $sub_type => $meta_data ) {
- foreach ( $meta_data as $_meta_key => $args ) {
- if ( $_meta_key === $meta_key && array_key_exists( 'default', $args ) ) {
- $defaults[ $sub_type ] = $args;
- }
- }
- }
-
- if ( ! $defaults ) {
- return $value;
- }
-
- // If this meta type does not have sub types, then the default is keyed as an empty string.
- if ( isset( $defaults[''] ) ) {
- $metadata = $defaults[''];
- } else {
- $sub_type = get_object_subtype( $meta_type, $object_id );
- if ( ! isset( $defaults[ $sub_type ] ) ) {
- return $value;
- }
- $metadata = $defaults[ $sub_type ];
- }
-
- if ( $single ) {
- $value = $metadata['default'];
- } else {
- $value = array( $metadata['default'] );
- }
-
- return $value;
-}
</del></span></pre></div>
<a id="trunksrcwpincludesrestapifieldsclasswprestmetafieldsphp"></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/rest-api/fields/class-wp-rest-meta-fields.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2020-07-08 13:42:30 UTC (rev 48410)
+++ trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2020-07-09 11:24:43 UTC (rev 48411)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,6 +79,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $fields as $meta_key => $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $name = $args['name'];
</span><span class="cx" style="display: block; padding: 0 10px"> $all_values = get_metadata( $this->get_meta_type(), $object_id, $meta_key, false );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $args['single'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $all_values ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $args['schema']['default'];
</span></span></pre></div>
<a id="trunktestsphpunittestsmetaregisterMetaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/meta/registerMeta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/meta/registerMeta.php 2020-07-08 13:42:30 UTC (rev 48410)
+++ trunk/tests/phpunit/tests/meta/registerMeta.php 2020-07-09 11:24:43 UTC (rev 48411)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -666,7 +666,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( array( 'wibble' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // types
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Types.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'single object key with single ask' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'single' => true,
</span></span></pre>
</div>
</div>
</body>
</html>