<!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>[48192] trunk/src/wp-includes/meta.php: Docs: Improvements to the inline docs for metadata related 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/48192">48192</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/48192","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-27 16:32:57 +0000 (Sat, 27 Jun 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: Improvements to the inline docs for metadata related functions.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.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-06-27 12:43:07 UTC (rev 48191)
+++ trunk/src/wp-includes/meta.php 2020-06-27 16:32:57 UTC (rev 48192)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,7 +54,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype );
</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">- * Filters whether to add metadata of a specific type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits adding metadata of a specific type.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,7 +183,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype );
</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">- * Filters whether to update metadata of a specific type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits updating metadata of a specific type.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -353,7 +353,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_value = wp_unslash( $meta_value );
</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">- * Filters whether to delete metadata of a specific type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits deleting metadata of a specific type.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -474,8 +474,12 @@
</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 metadata for the specified object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the value of a metadata field for the specified object type and ID.
</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 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.
+ *
</ins><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="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">@@ -485,7 +489,7 @@
</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 Single metadata value, or array of values
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed The metadata value or array of values. See description above for further details.
</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"> if ( ! $meta_type || ! is_numeric( $object_id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -498,19 +502,19 @@
</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">- * Filters whether to retrieve metadata of a specific type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits the return value of a meta field.
</ins><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
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$meta_type`, refers to the
</ins><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * will short-circuit the return value.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param null|array|string $value The value get_metadata() should return - a single metadata value,
- * or an array of values.
- * @param int $object_id ID of the object metadata is for.
- * @param string $meta_key Metadata key.
- * @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 mixed $value The value to return, either a single metadata value or an array
+ * of values depending on the value of `$single`. Default null.
+ * @param int $object_id ID of the object metadata is for.
+ * @param string $meta_key Metadata key.
+ * @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">@@ -552,7 +556,7 @@
</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">- * Determines if a meta key is set for a given object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines if a meta field with the given key exists for the given object ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -560,7 +564,7 @@
</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">- * @return bool True of the key is set, false if not.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether a meta field with the given key exists.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function metadata_exists( $meta_type, $object_id, $meta_key ) {
</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">@@ -602,7 +606,18 @@
</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">- * @return object|false Meta object or false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return stdClass|false {
+ * Metadata object, or boolean `false` if the metadata doesn't exist.
+ *
+ * @type string $meta_key The meta key.
+ * @type mixed $meta_value The unserialized meta value.
+ * @type string $meta_id Optional. The meta ID when the meta type is any value except 'user'.
+ * @type string $umeta_id Optional. The meta ID when the meta type is 'user'.
+ * @type string $post_id Optional. The object ID when the meta type is 'post'.
+ * @type string $comment_id Optional. The object ID when the meta type is 'comment'.
+ * @type string $term_id Optional. The object ID when the meta type is 'term'.
+ * @type string $user_id Optional. The object ID when the meta type is 'user'.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_metadata_by_mid( $meta_type, $meta_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -624,16 +639,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';
</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">- * Filters whether to retrieve metadata of a specific type by meta ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits the return value when fetching a meta field by meta ID.
</ins><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
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$meta_type`, refers to the
</ins><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * will effectively short-circuit the function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * will short-circuit the return value.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $value The value get_metadata_by_mid() should return.
- * @param int $meta_id Meta ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param stdClass|null $value The value to return.
+ * @param int $meta_id Meta ID.
</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_by_mid", null, $meta_id );
</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">@@ -689,7 +704,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';
</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">- * Filters whether to update metadata of a specific type by meta ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits updating metadata of a specific type by meta ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -805,7 +820,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';
</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">- * Filters whether to delete metadata of a specific type by meta ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits deleting metadata of a specific type by meta ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -910,7 +925,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $object_ids = array_map( 'intval', $object_ids );
</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">- * Filters whether to update the metadata cache of a specific type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits updating the metadata cache of a specific type.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (comment, post, term, or user). Returning a non-null value
</span></span></pre>
</div>
</div>
</body>
</html>