<!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>[46186] trunk: REST API: Issue warning if array meta is registered without item schema.</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/46186">46186</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/46186","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-19 14:35:47 +0000 (Thu, 19 Sep 2019)</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'>REST API: Issue warning if array meta is registered without item schema.
The purpose of meta registration is to assert that the meta key will contain a predictable value conforming to a schema, so the schema is therefore considered to be required.
Props TimothyBlynJacobs, grapplerulrich.
Fixes <a href="https://core.trac.wordpress.org/ticket/43392">#43392</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostmetafieldsphp">trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.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 2019-09-19 14:29:30 UTC (rev 46185)
+++ trunk/src/wp-includes/meta.php 2019-09-19 14:35:47 UTC (rev 46186)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1115,6 +1115,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * to support an array of data to attach to registered meta keys}. Previous arguments for
</span><span class="cx" style="display: block; padding: 0 10px"> * `$sanitize_callback` and `$auth_callback` have been folded into this array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.8 The `$object_subtype` argument was added to the arguments array.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Valid meta types expanded to include "array" and "object".
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $object_type Type of object this meta is registered to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $meta_key Meta key to register.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1121,17 +1122,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Data used to describe the meta key when registered.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $object_subtype A subtype; e.g. if the object type is "post", the post type. If left empty,
- * the meta key will be registered on the entire object type. Default empty.
- * @type string $type The type of data associated with this meta key.
- * Valid values are 'string', 'boolean', 'integer', and 'number'.
- * @type string $description A description of the data attached to this meta key.
- * @type bool $single Whether the meta key has one value per object, or an array of values per object.
- * @type string $sanitize_callback A function or method to call when sanitizing `$meta_key` data.
- * @type string $auth_callback Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks.
- * @type bool $show_in_rest Whether data associated with this meta key can be considered public and
- * should be accessible via the REST API. A custom post type must also declare
- * support for custom fields for registered meta to be accessible via REST.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $object_subtype A subtype; e.g. if the object type is "post", the post type. If left empty,
+ * the meta key will be registered on the entire object type. Default empty.
+ * @type string $type The type of data associated with this meta key.
+ * Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
+ * @type string $description A description of the data attached to this meta key.
+ * @type bool $single Whether the meta key has one value per object, or an array of values per object.
+ * @type string $sanitize_callback A function or method to call when sanitizing `$meta_key` data.
+ * @type string $auth_callback Optional. A function or method to call when performing edit_post_meta,
+ * add_post_meta, and delete_post_meta capability checks.
+ * @type bool|array $show_in_rest Whether data associated with this meta key can be considered public and
+ * should be accessible via the REST API. A custom post type must also declare
+ * support for custom fields for registered meta to be accessible via REST.
+ * When registering complex meta values this argument may optionally be an
+ * array with 'schema' or 'prepare_callback' keys instead of a boolean.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $deprecated Deprecated. Use `$args` instead.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1188,6 +1192,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );
</span><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args( $args, $defaults );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Require an item schema when registering array meta.
+ if ( false !== $args['show_in_rest'] && 'array' === $args['type'] ) {
+ if ( ! is_array( $args['show_in_rest'] ) || ! isset( $args['show_in_rest']['schema']['items'] ) ) {
+ _doing_it_wrong( __FUNCTION__, __( 'When registering an "array" meta type to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.3.0' );
+
+ return false;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $object_subtype = ! empty( $args['object_subtype'] ) ? $args['object_subtype'] : '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If `auth_callback` is not provided, fall back to `is_protected_meta()`.
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostmetafieldsphp"></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/rest-api/rest-post-meta-fields.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php 2019-09-19 14:29:30 UTC (rev 46185)
+++ trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php 2019-09-19 14:35:47 UTC (rev 46186)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2205,6 +2205,66 @@
</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">+ * @ticket 43392
+ */
+ public function test_register_meta_issues_doing_it_wrong_when_show_in_rest_is_true() {
+ $this->setExpectedIncorrectUsage( 'register_meta' );
+
+ $registered = register_meta(
+ 'post',
+ 'invalid_array',
+ array(
+ 'type' => 'array',
+ 'show_in_rest' => true,
+ )
+ );
+
+ self::assertFalse( $registered );
+ }
+
+ /**
+ * @ticket 43392
+ */
+ public function test_register_meta_issues_doing_it_wrong_when_show_in_rest_omits_schema() {
+ $this->setExpectedIncorrectUsage( 'register_meta' );
+
+ $registered = register_meta(
+ 'post',
+ 'invalid_array',
+ array(
+ 'type' => 'array',
+ 'show_in_rest' => array(
+ 'prepare_callback' => 'rest_sanitize_value_from_schema',
+ ),
+ )
+ );
+
+ self::assertFalse( $registered );
+ }
+
+ /**
+ * @ticket 43392
+ */
+ public function test_register_meta_issues_doing_it_wrong_when_show_in_rest_omits_schema_items() {
+ $this->setExpectedIncorrectUsage( 'register_meta' );
+
+ $registered = register_meta(
+ 'post',
+ 'invalid_array',
+ array(
+ 'type' => 'array',
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'default' => array( 'Hi!' ),
+ ),
+ ),
+ )
+ );
+
+ self::assertFalse( $registered );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Internal function used to disable an insert query which
</span><span class="cx" style="display: block; padding: 0 10px"> * will trigger a wpdb error for testing purposes.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>