<!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>[48951] trunk: REST API: Extract `WP_REST_Controller::get_endpoint_args_for_item_schema()` to a standalone function.</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/48951">48951</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/48951","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-09-07 02:35:52 +0000 (Mon, 07 Sep 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'>REST API: Extract `WP_REST_Controller::get_endpoint_args_for_item_schema()` to a standalone function.
This method is useful whenever a JSON Schema needs to be converted to a format suitable for argument validation with `WP_REST_Request`. Moving the logic into a standalone function allows developers to use it outside of the `WP_REST_Controller` context.
Props pentatonicfunk.
Fixes <a href="https://core.trac.wordpress.org/ticket/50876">#50876</a>. </pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp"></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/endpoints/class-wp-rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-09-06 04:23:46 UTC (rev 48950)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-09-07 02:35:52 UTC (rev 48951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -625,78 +625,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Endpoint arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $schema = $this->get_item_schema();
- $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
- $endpoint_args = array();
- $valid_schema_properties = array(
- 'type',
- 'format',
- 'enum',
- 'items',
- 'properties',
- 'additionalProperties',
- 'minimum',
- 'maximum',
- 'exclusiveMinimum',
- 'exclusiveMaximum',
- 'minLength',
- 'maxLength',
- 'pattern',
- 'minItems',
- 'maxItems',
- 'uniqueItems',
- );
-
- foreach ( $schema_properties as $field_id => $params ) {
-
- // Arguments specified as `readonly` are not allowed to be set.
- if ( ! empty( $params['readonly'] ) ) {
- continue;
- }
-
- $endpoint_args[ $field_id ] = array(
- 'validate_callback' => 'rest_validate_request_arg',
- 'sanitize_callback' => 'rest_sanitize_request_arg',
- );
-
- if ( isset( $params['description'] ) ) {
- $endpoint_args[ $field_id ]['description'] = $params['description'];
- }
-
- if ( WP_REST_Server::CREATABLE === $method && isset( $params['default'] ) ) {
- $endpoint_args[ $field_id ]['default'] = $params['default'];
- }
-
- if ( WP_REST_Server::CREATABLE === $method && ! empty( $params['required'] ) ) {
- $endpoint_args[ $field_id ]['required'] = true;
- }
-
- foreach ( $valid_schema_properties as $schema_prop ) {
- if ( isset( $params[ $schema_prop ] ) ) {
- $endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];
- }
- }
-
- // Merge in any options provided by the schema property.
- if ( isset( $params['arg_options'] ) ) {
-
- // Only use required / default from arg_options on CREATABLE endpoints.
- if ( WP_REST_Server::CREATABLE !== $method ) {
- $params['arg_options'] = array_diff_key(
- $params['arg_options'],
- array(
- 'required' => '',
- 'default' => '',
- )
- );
- }
-
- $endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params['arg_options'] );
- }
- }
-
- return $endpoint_args;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return rest_get_endpoint_args_for_schema( $this->get_item_schema(), $method );
</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></pre></div>
<a id="trunksrcwpincludesrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2020-09-06 04:23:46 UTC (rev 48950)
+++ trunk/src/wp-includes/rest-api.php 2020-09-07 02:35:52 UTC (rev 48951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2258,3 +2258,88 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'rest_queried_resource_route', $route );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Retrieves an array of endpoint arguments from the item schema and endpoint method.
+ *
+ * @since 5.6.0
+ *
+ * @param array $schema The full JSON schema for the endpoint.
+ * @param string $method Optional. HTTP method of the endpoint. The arguments for `CREATABLE` endpoints are
+ * checked for required values and may fall-back to a given default, this is not done
+ * on `EDITABLE` endpoints. Default WP_REST_Server::CREATABLE.
+ * @return array The endpoint arguments.
+ */
+function rest_get_endpoint_args_for_schema( $schema, $method = WP_REST_Server::CREATABLE ) {
+
+ $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
+ $endpoint_args = array();
+ $valid_schema_properties = array(
+ 'type',
+ 'format',
+ 'enum',
+ 'items',
+ 'properties',
+ 'additionalProperties',
+ 'minimum',
+ 'maximum',
+ 'exclusiveMinimum',
+ 'exclusiveMaximum',
+ 'minLength',
+ 'maxLength',
+ 'pattern',
+ 'minItems',
+ 'maxItems',
+ 'uniqueItems',
+ );
+
+ foreach ( $schema_properties as $field_id => $params ) {
+
+ // Arguments specified as `readonly` are not allowed to be set.
+ if ( ! empty( $params['readonly'] ) ) {
+ continue;
+ }
+
+ $endpoint_args[ $field_id ] = array(
+ 'validate_callback' => 'rest_validate_request_arg',
+ 'sanitize_callback' => 'rest_sanitize_request_arg',
+ );
+
+ if ( isset( $params['description'] ) ) {
+ $endpoint_args[ $field_id ]['description'] = $params['description'];
+ }
+
+ if ( WP_REST_Server::CREATABLE === $method && isset( $params['default'] ) ) {
+ $endpoint_args[ $field_id ]['default'] = $params['default'];
+ }
+
+ if ( WP_REST_Server::CREATABLE === $method && ! empty( $params['required'] ) ) {
+ $endpoint_args[ $field_id ]['required'] = true;
+ }
+
+ foreach ( $valid_schema_properties as $schema_prop ) {
+ if ( isset( $params[ $schema_prop ] ) ) {
+ $endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];
+ }
+ }
+
+ // Merge in any options provided by the schema property.
+ if ( isset( $params['arg_options'] ) ) {
+
+ // Only use required / default from arg_options on CREATABLE endpoints.
+ if ( WP_REST_Server::CREATABLE !== $method ) {
+ $params['arg_options'] = array_diff_key(
+ $params['arg_options'],
+ array(
+ 'required' => '',
+ 'default' => '',
+ )
+ );
+ }
+
+ $endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params['arg_options'] );
+ }
+ }
+
+ return $endpoint_args;
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsrestapirestcontrollerphp"></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-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-09-06 04:23:46 UTC (rev 48950)
+++ trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-09-07 02:35:52 UTC (rev 48951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,10 +222,33 @@
</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 50876
+ */
+ public function test_get_endpoint_args_for_item_schema() {
+ $controller = new WP_REST_Test_Controller();
+ $args = $controller->get_endpoint_args_for_item_schema();
+
+ $this->assertArrayHasKey( 'somestring', $args );
+ $this->assertArrayHasKey( 'someinteger', $args );
+ $this->assertArrayHasKey( 'someboolean', $args );
+ $this->assertArrayHasKey( 'someurl', $args );
+ $this->assertArrayHasKey( 'somedate', $args );
+ $this->assertArrayHasKey( 'someemail', $args );
+ $this->assertArrayHasKey( 'somehex', $args );
+ $this->assertArrayHasKey( 'someuuid', $args );
+ $this->assertArrayHasKey( 'someenum', $args );
+ $this->assertArrayHasKey( 'someargoptions', $args );
+ $this->assertArrayHasKey( 'somedefault', $args );
+ $this->assertArrayHasKey( 'somearray', $args );
+ $this->assertArrayHasKey( 'someobject', $args );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_endpoint_args_for_item_schema_description() {
</span><span class="cx" style="display: block; padding: 0 10px"> $controller = new WP_REST_Test_Controller();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = $controller->get_endpoint_args_for_item_schema();
- $this->assertSame( 'A pretty string.', $args['somestring']['description'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = rest_get_endpoint_args_for_schema( $controller->get_item_schema() );
+
+ $this->assertEquals( 'A pretty string.', $args['somestring']['description'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( isset( $args['someinteger']['description'] ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -232,7 +255,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_endpoint_args_for_item_schema_arg_options() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $controller = new WP_REST_Test_Controller();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = $controller->get_endpoint_args_for_item_schema();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = rest_get_endpoint_args_for_schema( $controller->get_item_schema() );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $args['someargoptions']['required'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '__return_true', $args['someargoptions']['sanitize_callback'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,9 +264,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_endpoint_args_for_item_schema_default_value() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $controller = new WP_REST_Test_Controller();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = rest_get_endpoint_args_for_schema( $controller->get_item_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">- $args = $controller->get_endpoint_args_for_item_schema();
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'a', $args['somedefault']['default'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,7 +275,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_endpoint_args_for_item_schema_arg_properties() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $controller = new WP_REST_Test_Controller();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = $controller->get_endpoint_args_for_item_schema();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = rest_get_endpoint_args_for_schema( $controller->get_item_schema() );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( array( 'minLength', 'maxLength', 'pattern' ) as $property ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $property, $args['somestring'] );
</span></span></pre>
</div>
</div>
</body>
</html>