<!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>[39022] trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: Docs: Add much more complete and syntactically correct documentation throughout the `WP_REST_Meta_Fields` class.</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 { 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/39022">39022</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/39022","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-30 16:32:05 +0000 (Sun, 30 Oct 2016)</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: Add much more complete and syntactically correct documentation throughout the `WP_REST_Meta_Fields` class.
Props Soean, mrahmadawais, flixos90.
See <a href="https://core.trac.wordpress.org/ticket/38398">#38398</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapifieldsclasswprestmetafieldsphp">trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2016-10-30 16:19:22 UTC (rev 39021)
+++ trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2016-10-30 16:32:05 UTC (rev 39022)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,42 +1,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * REST API: WP_REST_Meta_Fields class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 4.7.0
+ */
</ins><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">- * Manage meta values for an object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Core class to manage meta values for an object via the REST API.
+ *
+ * @since 4.7.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> abstract class WP_REST_Meta_Fields {
</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">- * Get the object type for meta.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the object meta type.
</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 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string One of 'post', 'comment', 'term', 'user', or anything
</span><span class="cx" style="display: block; padding: 0 10px"> * else supported by `_get_meta_table()`.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> abstract protected function get_meta_type();
</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">- * Get the object type for `register_rest_field`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the object type for register_rest_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">- * @return string Custom post type, 'taxonomy', 'comment', or `user`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @return string The REST field type, such as post type name, taxonomy name, 'comment', or `user`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> abstract protected function get_rest_field_type();
</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">- * Register the meta field.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers the meta field.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @see register_rest_field()
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register_field() {
</span><span class="cx" style="display: block; padding: 0 10px"> register_rest_field( $this->get_rest_field_type(), 'meta', array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'get_callback' => array( $this, 'get_value' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'get_callback' => array( $this, 'get_value' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'update_callback' => array( $this, 'update_value' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'schema' => $this->get_field_schema(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'schema' => $this->get_field_schema(),
</ins><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><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get the `meta` field value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the meta field value.
</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 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id Object ID to fetch meta for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Error|object Object containing the meta values by name, otherwise WP_Error object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_value( $object_id, $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $this->get_registered_fields();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,13 +88,16 @@
</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">- * Prepare value for response.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prepares a meta value for a response.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This is required because some native types cannot be stored correctly in
- * the database, such as booleans. We need to cast back to the relevant
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This is required because some native types cannot be stored correctly
+ * in the database, such as booleans. We need to cast back to the relevant
</ins><span class="cx" style="display: block; padding: 0 10px"> * type before passing back to JSON.
</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 Value to prepare.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @param mixed $value Meta value to prepare.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Current request object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Options for the field.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed Prepared value.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,11 +111,14 @@
</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">- * Update meta values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Updates meta 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">- * @param WP_REST_Request $request Full details about the request.
- * @param int $object_id Object ID to fetch meta for.
- * @return WP_Error|null Error if one occurs, null on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @param int $object_id Object ID to fetch meta for.
+ * @return WP_Error|null WP_Error if one occurs, null on success.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_value( $request, $object_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $this->get_registered_fields();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,8 +128,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- // A null value means reset the field, which is essentially deleting it
- // from the database and then relying on the default value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * A null value means reset the field, which is essentially deleting it
+ * from the database and then relying on the default value.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_null( $request[ $name ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $this->delete_meta_value( $object_id, $name );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $args['single'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,11 +149,14 @@
</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">- * Delete meta value for an object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes a meta value for an 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">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id Object ID the field belongs to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Key for the field.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|WP_Error True if meta field is deleted, error otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|WP_Error True if meta field is deleted, WP_Error otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function delete_meta_value( $object_id, $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! current_user_can( 'delete_post_meta', $object_id, $name ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,14 +179,17 @@
</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">- * Update multiple meta values for an object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Updates multiple meta values for an object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Alters the list of values in the database to match the list of provided values.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id Object ID to update.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Key for the custom field.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $values List of values to update to.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|WP_Error True if meta fields are updated, error otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|WP_Error True if meta fields are updated, WP_Error otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function update_multi_meta_value( $object_id, $name, $values ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! current_user_can( 'edit_post_meta', $object_id, $name ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,9 +203,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $current = get_metadata( $this->get_meta_type(), $object_id, $name, false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $to_remove = $current;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $to_add = $values;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $to_add = $values;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $to_add as $add_key => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $remove_keys = array_keys( $to_remove, $value, true );
</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 ( empty( $remove_keys ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -179,13 +218,14 @@
</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"> $remove_key = $remove_keys[0];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $to_remove[ $remove_key ] );
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $to_add[ $add_key ] );
</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">- // `delete_metadata` removes _all_ instances of the value, so only call
- // once.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // `delete_metadata` removes _all_ instances of the value, so only call once.
</ins><span class="cx" style="display: block; padding: 0 10px"> $to_remove = array_unique( $to_remove );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $to_remove as $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! delete_metadata( $this->get_meta_type(), $object_id, wp_slash( $name ), wp_slash( $value ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -195,6 +235,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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $to_add as $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! add_metadata( $this->get_meta_type(), $object_id, wp_slash( $name ), wp_slash( $value ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -209,12 +250,15 @@
</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">- * Update meta value for an object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Updates a meta value for an 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">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id Object ID to update.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Key for the custom field.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Updated value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|WP_Error True if meta field is updated, error otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|WP_Error True if the meta field was updated, WP_Error otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function update_meta_value( $object_id, $name, $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! current_user_can( 'edit_post_meta', $object_id, $name ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,6 +275,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Do the exact same check for a duplicate value as in update_metadata() to avoid update_metadata() returning false.
</span><span class="cx" style="display: block; padding: 0 10px"> $old_value = get_metadata( $meta_type, $object_id, $meta_key );
</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 ( 1 === count( $old_value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $old_value[0] === $meta_value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -249,9 +294,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">- * Get all the registered meta fields.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves all the registered meta fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @return array Registered fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_registered_fields() {
</span><span class="cx" style="display: block; padding: 0 10px"> $registered = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -262,6 +310,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"> $rest_args = array();
</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 ( is_array( $args['show_in_rest'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $rest_args = $args['show_in_rest'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,11 +321,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'schema' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'prepare_callback' => array( $this, 'prepare_value' ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $default_schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => empty( $args['description'] ) ? '' : $args['description'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => isset( $args['default'] ) ? $args['default'] : null,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $rest_args = array_merge( $default_args, $rest_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $rest_args['schema'] = array_merge( $default_schema, $rest_args['schema'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -297,15 +348,18 @@
</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"> $registered[ $rest_args['name'] ] = $rest_args;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } // End foreach().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $registered;
</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">- * Get the object's `meta` schema, conforming to JSON Schema.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the object's meta schema, conforming to JSON Schema.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @return array Field schema data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_field_schema() {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $this->get_registered_fields();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,15 +379,18 @@
</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">- * Prepare a meta value for output.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prepares a meta value for output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Default preparation for meta fields. Override by passing the
</span><span class="cx" style="display: block; padding: 0 10px"> * `prepare_callback` in your `show_in_rest` options.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Meta value from the database.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args REST-specific options for the meta key.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed Value prepared for output.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed Value prepared for output. If a non-JsonSerializable object, null.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function prepare_value( $value, $request, $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $type = $args['schema']['type'];
</span></span></pre>
</div>
</div>
</body>
</html>