<!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>[43648] branches/4.9: REST API: Support pagination, order, search and other common query parameters for revisions.</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/43648">43648</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/43648","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>2018-09-18 03:54:20 +0000 (Tue, 18 Sep 2018)</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: Support pagination, order, search and other common query parameters for revisions.
The original REST API revisions controller relied on `wp_get_post_revisions()`, getting all revisions of a post without any possibility to restrict the result. This changeset replaces that function call with a proper `WP_Query` setup, replicating how `wp_get_post_revisions()` works while offering parameters to alter the default behavior.
Props adamsilverstein, birgire, flixos90.
Merges [43584-43586], <a href="https://core.trac.wordpress.org/changeset/43647">[43647]</a> to the 4.9 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/40510">#40510</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches49srcwpincludesrestapiendpointsclasswprestpostscontrollerphp">branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#branches49srcwpincludesrestapiendpointsclasswprestrevisionscontrollerphp">branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php</a></li>
<li><a href="#branches49testsphpunittestsrestapirestrevisionscontrollerphp">branches/4.9/tests/phpunit/tests/rest-api/rest-revisions-controller.php</a></li>
<li><a href="#branches49testsqunitfixtureswpapigeneratedjs">branches/4.9/tests/qunit/fixtures/wp-api-generated.js</a></li>
<li><a href="#branches49testsqunitwpincludesjswpapijs">branches/4.9/tests/qunit/wp-includes/js/wp-api.js</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches49">branches/4.9/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.9
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.9 2018-09-18 03:44:57 UTC (rev 43647)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.9 2018-09-18 03:54:20 UTC (rev 43648)
</ins><a id="branches49"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.9</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42256-42261,42350,42358,42362,42364-42368,42374,42388,42390,42401,42417,42421,42423-42425,42430,42432-42433,42437,42441,42443,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42648,42652-42653,42665,42676,42687,42697,42711,42713,42719,42722,42726,42728,42739-42740,42744,42758,42772,42791-42792,42801,42814-42815,42817-42818,42823,42830,42837,42839,42841,42844,42851-42852,42860,42864,42881,42888-42889,42892-42894
,42930,42964,42967,42971-42972,42977-42978,42980-42982,42985-42987,42989,42992,42994-42995,42998-42999,43001-43004,43007-43008,43011-43012,43014-43015,43025,43027,43030,43032,43034,43036,43039,43042,43044-43049,43051-43063,43065,43081,43085,43087-43089,43091,43104,43116,43118,43120-43121,43123,43125-43126,43131-43132,43135,43137,43139,43145-43148,43150,43154-43155,43158,43160,43162,43166,43168,43170,43172,43175,43180-43181,43183-43185,43189,43191,43193,43195,43197,43199,43201,43203,43206,43208,43210-43212,43216,43218,43220,43222-43223,43226,43228,43230,43232,43234,43236,43238,43242-43243,43245-43246,43248-43251,43256,43259-43260,43263,43265,43267,43269,43274-43275,43278-43279,43282,43284,43286,43290-43293,43299,43303-43304,43313,43315,43317,43331,43337,43343,43350,43353,43356,43361-43363,43365,43367,43370-43371,43373-43376,43379,43388,43390,43435,43437,43439-43440,43446-43447,43451,43454,43457,43460,43462-43467,43469,43471,43475,43477-43478,43480,43486,43491,43493,43495,43499,43504,
43506,43508,43511-43513,43518,43525,43527,43529,43531,43535,43541,43550,43558-43559,43561,43567-43568,43574,43578,43580,43593,43597,43599,43601,43605-43606,43609,43616,43623,43631,43636,43638
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42256-42261,42350,42358,42362,42364-42368,42374,42388,42390,42401,42417,42421,42423-42425,42430,42432-42433,42437,42441,42443,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42648,42652-42653,42665,42676,42687,42697,42711,42713,42719,42722,42726,42728,42739-42740,42744,42758,42772,42791-42792,42801,42814-42815,42817-42818,42823,42830,42837,42839,42841,42844,42851-42852,42860,42864,42881,42888-42889,42892-42894
,42930,42964,42967,42971-42972,42977-42978,42980-42982,42985-42987,42989,42992,42994-42995,42998-42999,43001-43004,43007-43008,43011-43012,43014-43015,43025,43027,43030,43032,43034,43036,43039,43042,43044-43049,43051-43063,43065,43081,43085,43087-43089,43091,43104,43116,43118,43120-43121,43123,43125-43126,43131-43132,43135,43137,43139,43145-43148,43150,43154-43155,43158,43160,43162,43166,43168,43170,43172,43175,43180-43181,43183-43185,43189,43191,43193,43195,43197,43199,43201,43203,43206,43208,43210-43212,43216,43218,43220,43222-43223,43226,43228,43230,43232,43234,43236,43238,43242-43243,43245-43246,43248-43251,43256,43259-43260,43263,43265,43267,43269,43274-43275,43278-43279,43282,43284,43286,43290-43293,43299,43303-43304,43313,43315,43317,43331,43337,43343,43350,43353,43356,43361-43363,43365,43367,43370-43371,43373-43376,43379,43388,43390,43435,43437,43439-43440,43446-43447,43451,43454,43457,43460,43462-43467,43469,43471,43475,43477-43478,43480,43486,43491,43493,43495,43499,43504,
43506,43508,43511-43513,43518,43525,43527,43529,43531,43535,43541,43550,43558-43559,43561,43567-43568,43574,43578,43580,43584-43586,43593,43597,43599,43601,43605-43606,43609,43616,43623,43631,43636,43638,43647
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches49srcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2018-09-18 03:44:57 UTC (rev 43647)
+++ branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2018-09-18 03:54:20 UTC (rev 43648)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -864,7 +864,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $value The query_var value.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
</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"> if ( 'post' !== $this->post_type || ! isset( $query_args['ignore_sticky_posts'] ) ) {
</span></span></pre></div>
<a id="branches49srcwpincludesrestapiendpointsclasswprestrevisionscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php 2018-09-18 03:44:57 UTC (rev 43647)
+++ branches/4.9/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php 2018-09-18 03:54:20 UTC (rev 43648)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -197,14 +197,122 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $parent;
</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">- $revisions = wp_get_post_revisions( $request['parent'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure a search string is set in case the orderby is set to 'relevance'.
+ if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {
+ return new WP_Error( 'rest_no_search_term_defined', __( 'You need to define a search term to order by relevance.' ), array( 'status' => 400 ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure an include parameter is set in case the orderby is set to 'include'.
+ if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {
+ return new WP_Error( 'rest_orderby_include_missing_include', __( 'You need to define an include parameter to order by include.' ), array( 'status' => 400 ) );
+ }
+
+ if ( wp_revisions_enabled( $parent ) ) {
+ $registered = $this->get_collection_params();
+ $args = array(
+ 'post_parent' => $parent->ID,
+ 'post_type' => 'revision',
+ 'post_status' => 'inherit',
+ 'posts_per_page' => -1,
+ 'orderby' => 'date ID',
+ 'order' => 'DESC',
+ 'suppress_filters' => true,
+ );
+
+ $parameter_mappings = array(
+ 'exclude' => 'post__not_in',
+ 'include' => 'post__in',
+ 'offset' => 'offset',
+ 'order' => 'order',
+ 'orderby' => 'orderby',
+ 'page' => 'paged',
+ 'per_page' => 'posts_per_page',
+ 'search' => 's',
+ );
+
+ foreach ( $parameter_mappings as $api_param => $wp_param ) {
+ if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {
+ $args[ $wp_param ] = $request[ $api_param ];
+ }
+ }
+
+ // For backward-compatibility, 'date' needs to resolve to 'date ID'.
+ if ( isset( $args['orderby'] ) && 'date' === $args['orderby'] ) {
+ $args['orderby'] = 'date ID';
+ }
+
+ /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
+ $args = apply_filters( 'rest_revision_query', $args, $request );
+ $query_args = $this->prepare_items_query( $args, $request );
+
+ $revisions_query = new WP_Query();
+ $revisions = $revisions_query->query( $query_args );
+ $offset = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;
+ $page = (int) $query_args['paged'];
+ $total_revisions = $revisions_query->found_posts;
+
+ if ( $total_revisions < 1 ) {
+ // Out-of-bounds, run the query again without LIMIT for total count.
+ unset( $query_args['paged'], $query_args['offset'] );
+
+ $count_query = new WP_Query();
+ $count_query->query( $query_args );
+
+ $total_revisions = $count_query->found_posts;
+ }
+
+ if ( $revisions_query->query_vars['posts_per_page'] > 0 ) {
+ $max_pages = ceil( $total_revisions / (int) $revisions_query->query_vars['posts_per_page'] );
+ } else {
+ $max_pages = $total_revisions > 0 ? 1 : 0;
+ }
+
+ if ( $total_revisions > 0 ) {
+ if ( $offset >= $total_revisions ) {
+ return new WP_Error( 'rest_revision_invalid_offset_number', __( 'The offset number requested is larger than or equal to the number of available revisions.' ), array( 'status' => 400 ) );
+ } elseif ( ! $offset && $page > $max_pages ) {
+ return new WP_Error( 'rest_revision_invalid_page_number', __( 'The page number requested is larger than the number of pages available.' ), array( 'status' => 400 ) );
+ }
+ }
+ } else {
+ $revisions = array();
+ $total_revisions = 0;
+ $max_pages = 0;
+ $page = (int) $request['page'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $revisions as $revision ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $this->prepare_item_for_response( $revision, $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $response[] = $this->prepare_response_for_collection( $data );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return rest_ensure_response( $response );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $response = rest_ensure_response( $response );
+
+ $response->header( 'X-WP-Total', (int) $total_revisions );
+ $response->header( 'X-WP-TotalPages', (int) $max_pages );
+
+ $request_params = $request->get_query_params();
+ $base = add_query_arg( $request_params, rest_url( sprintf( '%s/%s/%d/%s', $this->namespace, $this->parent_base, $request['parent'], $this->rest_base ) ) );
+
+ if ( $page > 1 ) {
+ $prev_page = $page - 1;
+
+ if ( $prev_page > $max_pages ) {
+ $prev_page = $max_pages;
+ }
+
+ $prev_link = add_query_arg( 'page', $prev_page, $base );
+ $response->link_header( 'prev', $prev_link );
+ }
+ if ( $max_pages > $page ) {
+ $next_page = $page + 1;
+ $next_link = add_query_arg( 'page', $next_page, $base );
+
+ $response->link_header( 'next', $next_link );
+ }
+
+ return $response;
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -318,6 +426,41 @@
</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">+ * Determines the allowed query_vars for a get_items() response and prepares
+ * them for WP_Query.
+ *
+ * @since 5.0.0
+ *
+ * @param array $prepared_args Optional. Prepared WP_Query arguments. Default empty array.
+ * @param WP_REST_Request $request Optional. Full details about the request.
+ * @return array Items query arguments.
+ */
+ protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+ $query_args = array();
+
+ foreach ( $prepared_args as $key => $value ) {
+ /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
+ $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+ }
+
+ // Map to proper WP_Query orderby param.
+ if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {
+ $orderby_mappings = array(
+ 'id' => 'ID',
+ 'include' => 'post__in',
+ 'slug' => 'post_name',
+ 'include_slugs' => 'post_name__in',
+ );
+
+ if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {
+ $query_args['orderby'] = $orderby_mappings[ $request['orderby'] ];
+ }
+ }
+
+ return $query_args;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Prepares the revision for the REST response.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -537,9 +680,58 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Collection parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_collection_params() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return array(
- 'context' => $this->get_context_param( array( 'default' => 'view' ) ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query_params = parent::get_collection_params();
+
+ $query_params['context']['default'] = 'view';
+
+ unset( $query_params['per_page']['default'] );
+
+ $query_params['exclude'] = array(
+ 'description' => __( 'Ensure result set excludes specific IDs.' ),
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'integer',
+ ),
+ 'default' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $query_params['include'] = array(
+ 'description' => __( 'Limit result set to specific IDs.' ),
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'integer',
+ ),
+ 'default' => array(),
+ );
+
+ $query_params['offset'] = array(
+ 'description' => __( 'Offset the result set by a specific number of items.' ),
+ 'type' => 'integer',
+ );
+
+ $query_params['order'] = array(
+ 'description' => __( 'Order sort attribute ascending or descending.' ),
+ 'type' => 'string',
+ 'default' => 'desc',
+ 'enum' => array( 'asc', 'desc' ),
+ );
+
+ $query_params['orderby'] = array(
+ 'description' => __( 'Sort collection by object attribute.' ),
+ 'type' => 'string',
+ 'default' => 'date',
+ 'enum' => array(
+ 'date',
+ 'id',
+ 'include',
+ 'relevance',
+ 'slug',
+ 'include_slugs',
+ 'title',
+ ),
+ );
+
+ return $query_params;
</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="branches49testsphpunittestsrestapirestrevisionscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/tests/phpunit/tests/rest-api/rest-revisions-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/tests/phpunit/tests/rest-api/rest-revisions-controller.php 2018-09-18 03:44:57 UTC (rev 43647)
+++ branches/4.9/tests/phpunit/tests/rest-api/rest-revisions-controller.php 2018-09-18 03:54:20 UTC (rev 43648)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @subpackage REST API
</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">- /**
- * @group restapi
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * @group restapi
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_Test_REST_Revisions_Controller extends WP_Test_REST_Controller_Testcase {
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $post_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $page_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -30,6 +30,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$editor_id );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_post( array( 'post_content' => 'This content is better.', 'ID' => self::$post_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_post( array( 'post_content' => 'This content is marvelous.', 'ID' => self::$post_id ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_update_post(
+ array(
+ 'post_content' => 'This content is fantastic.',
+ 'ID' => self::$post_id,
+ )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( 0 );
</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">@@ -45,11 +51,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function setUp() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $revisions = wp_get_post_revisions( self::$post_id );
- $this->revision_1 = array_pop( $revisions );
- $this->revision_id1 = $this->revision_1->ID;
- $this->revision_2 = array_pop( $revisions );
- $this->revision_id2 = $this->revision_2->ID;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $revisions = wp_get_post_revisions( self::$post_id );
+ $this->total_revisions = count( $revisions );
+ $this->revisions = $revisions;
+ $this->revision_1 = array_pop( $revisions );
+ $this->revision_id1 = $this->revision_1->ID;
+ $this->revision_2 = array_pop( $revisions );
+ $this->revision_id2 = $this->revision_2->ID;
+ $this->revision_3 = array_pop( $revisions );
+ $this->revision_id3 = $this->revision_3->ID;
</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"> public function test_register_routes() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,14 +91,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 200, $response->get_status() );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertCount( 2, $data );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( $this->total_revisions, $data );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Reverse chron
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $this->revision_id2, $data[0]['id'] );
- $this->check_get_revision_response( $data[0], $this->revision_2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $this->revision_id3, $data[0]['id'] );
+ $this->check_get_revision_response( $data[0], $this->revision_3 );
</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->assertEquals( $this->revision_id1, $data[1]['id'] );
- $this->check_get_revision_response( $data[1], $this->revision_1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $this->revision_id2, $data[1]['id'] );
+ $this->check_get_revision_response( $data[1], $this->revision_2 );
+
+ $this->assertEquals( $this->revision_id1, $data[2]['id'] );
+ $this->check_get_revision_response( $data[2], $this->revision_1 );
</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"> public function test_get_items_no_permission() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -361,4 +374,361 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $parent_post_id, self::$post_id );
</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">+ /**
+ * Test the pagination header of the first page.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_pagination_header_of_the_first_page() {
+ wp_set_current_user( self::$editor_id );
+
+ $rest_route = '/wp/v2/posts/' . self::$post_id . '/revisions';
+ $per_page = 2;
+ $total_pages = (int) ceil( $this->total_revisions / $per_page );
+ $page = 1; // First page.
+
+ $request = new WP_REST_Request( 'GET', $rest_route );
+ $request->set_query_params(
+ array(
+ 'per_page' => $per_page,
+ 'page' => $page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $headers = $response->get_headers();
+ $this->assertSame( $this->total_revisions, $headers['X-WP-Total'] );
+ $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+ $next_link = add_query_arg(
+ array(
+ 'per_page' => $per_page,
+ 'page' => $page + 1,
+ ),
+ rest_url( $rest_route )
+ );
+ $this->assertFalse( stripos( $headers['Link'], 'rel="prev"' ) );
+ $this->assertContains( '<' . $next_link . '>; rel="next"', $headers['Link'] );
+ }
+
+ /**
+ * Test the pagination header of the last page.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_pagination_header_of_the_last_page() {
+ wp_set_current_user( self::$editor_id );
+
+ $rest_route = '/wp/v2/posts/' . self::$post_id . '/revisions';
+ $per_page = 2;
+ $total_pages = (int) ceil( $this->total_revisions / $per_page );
+ $page = 2; // Last page.
+
+ $request = new WP_REST_Request( 'GET', $rest_route );
+ $request->set_query_params(
+ array(
+ 'per_page' => $per_page,
+ 'page' => $page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $headers = $response->get_headers();
+ $this->assertSame( $this->total_revisions, $headers['X-WP-Total'] );
+ $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+ $prev_link = add_query_arg(
+ array(
+ 'per_page' => $per_page,
+ 'page' => $page - 1,
+ ),
+ rest_url( $rest_route )
+ );
+ $this->assertContains( '<' . $prev_link . '>; rel="prev"', $headers['Link'] );
+ }
+
+ /**
+ * Test that invalid 'per_page' query should error.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_invalid_per_page_should_error() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = -1; // Invalid number.
+ $expected_error = 'rest_invalid_param';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_param( 'per_page', $per_page );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test that out of bounds 'page' query should error.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_out_of_bounds_page_should_error() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $total_pages = (int) ceil( $this->total_revisions / $per_page );
+ $page = $total_pages + 1; // Out of bound page.
+ $expected_error = 'rest_revision_invalid_page_number';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'per_page' => $per_page,
+ 'page' => $page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test that impossibly high 'page' query should error.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_invalid_max_pages_should_error() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $page = REST_TESTS_IMPOSSIBLY_HIGH_NUMBER; // Invalid number.
+ $expected_error = 'rest_revision_invalid_page_number';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'per_page' => $per_page,
+ 'page' => $page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test the search query.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_search_query() {
+ wp_set_current_user( self::$editor_id );
+
+ $search_string = 'better';
+ $expected_count = 1;
+ $expected_content = 'This content is better.';
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_param( 'search', $search_string );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertCount( $expected_count, $data );
+ $this->assertContains( $expected_content, $data[0]['content']['rendered'] );
+ }
+
+ /**
+ * Test that the default query should fetch all revisions.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_default_query_should_fetch_all_revisons() {
+ wp_set_current_user( self::$editor_id );
+
+ $expected_count = $this->total_revisions;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertCount( $expected_count, $response->get_data() );
+ }
+
+ /**
+ * Test that 'offset' query shouldn't work without 'per_page' (fallback -1).
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_offset_should_not_work_without_per_page() {
+ wp_set_current_user( self::$editor_id );
+
+ $offset = 1;
+ $expected_count = $this->total_revisions;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_param( 'offset', $offset );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertCount( $expected_count, $response->get_data() );
+ }
+
+ /**
+ * Test that 'offset' query should work with 'per_page'.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_offset_should_work_with_per_page() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $offset = 1;
+ $expected_count = 2;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => $offset,
+ 'per_page' => $per_page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertCount( $expected_count, $response->get_data() );
+ }
+
+ /**
+ * Test that 'offset' query should take priority over 'page'.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_offset_should_take_priority_over_page() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $offset = 1;
+ $page = 1;
+ $expected_count = 2;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => $offset,
+ 'per_page' => $per_page,
+ 'page' => $page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertCount( $expected_count, $response->get_data() );
+ }
+
+ /**
+ * Test that 'offset' query, as the total revisions count, should return empty data.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_total_revisions_offset_should_return_empty_data() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $offset = $this->total_revisions;
+ $expected_error = 'rest_revision_invalid_offset_number';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => $offset,
+ 'per_page' => $per_page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test that out of bound 'offset' query should error.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_out_of_bound_offset_should_error() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $offset = $this->total_revisions + 1;
+ $expected_error = 'rest_revision_invalid_offset_number';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => $offset,
+ 'per_page' => $per_page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test that impossible high number for 'offset' query should error.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_impossible_high_number_offset_should_error() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $offset = REST_TESTS_IMPOSSIBLY_HIGH_NUMBER;
+ $expected_error = 'rest_revision_invalid_offset_number';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => $offset,
+ 'per_page' => $per_page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test that invalid 'offset' query should error.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_invalid_offset_should_error() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $offset = 'moreplease';
+ $expected_error = 'rest_invalid_param';
+ $expected_status = 400;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => $offset,
+ 'per_page' => $per_page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( $expected_error, $response, $expected_status );
+ }
+
+ /**
+ * Test that out of bounds 'page' query should not error when offset is provided,
+ * because it takes precedence.
+ *
+ * @ticket 40510
+ */
+ public function test_get_items_out_of_bounds_page_should_not_error_if_offset() {
+ wp_set_current_user( self::$editor_id );
+
+ $per_page = 2;
+ $total_pages = (int) ceil( $this->total_revisions / $per_page );
+ $page = $total_pages + 1; // Out of bound page.
+ $expected_count = 2;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+ $request->set_query_params(
+ array(
+ 'offset' => 1,
+ 'per_page' => $per_page,
+ 'page' => $page,
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertCount( $expected_count, $response->get_data() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches49testsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/tests/qunit/fixtures/wp-api-generated.js 2018-09-18 03:44:57 UTC (rev 43647)
+++ branches/4.9/tests/qunit/fixtures/wp-api-generated.js 2018-09-18 03:54:20 UTC (rev 43648)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -721,6 +721,70 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Scope under which the request is made; determines fields present in response.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+ "page": {
+ "required": false,
+ "default": 1,
+ "description": "Current page of the collection.",
+ "type": "integer"
+ },
+ "per_page": {
+ "required": false,
+ "description": "Maximum number of items to be returned in result set.",
+ "type": "integer"
+ },
+ "search": {
+ "required": false,
+ "description": "Limit results to those matching a string.",
+ "type": "string"
+ },
+ "exclude": {
+ "required": false,
+ "default": [],
+ "description": "Ensure result set excludes specific IDs.",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "include": {
+ "required": false,
+ "default": [],
+ "description": "Limit result set to specific IDs.",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "offset": {
+ "required": false,
+ "description": "Offset the result set by a specific number of items.",
+ "type": "integer"
+ },
+ "order": {
+ "required": false,
+ "default": "desc",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "description": "Order sort attribute ascending or descending.",
+ "type": "string"
+ },
+ "orderby": {
+ "required": false,
+ "default": "date",
+ "enum": [
+ "date",
+ "id",
+ "include",
+ "relevance",
+ "slug",
+ "include_slugs",
+ "title"
+ ],
+ "description": "Sort collection by object attribute.",
+ "type": "string"
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -1263,6 +1327,70 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Scope under which the request is made; determines fields present in response.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+ "page": {
+ "required": false,
+ "default": 1,
+ "description": "Current page of the collection.",
+ "type": "integer"
+ },
+ "per_page": {
+ "required": false,
+ "description": "Maximum number of items to be returned in result set.",
+ "type": "integer"
+ },
+ "search": {
+ "required": false,
+ "description": "Limit results to those matching a string.",
+ "type": "string"
+ },
+ "exclude": {
+ "required": false,
+ "default": [],
+ "description": "Ensure result set excludes specific IDs.",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "include": {
+ "required": false,
+ "default": [],
+ "description": "Limit result set to specific IDs.",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "offset": {
+ "required": false,
+ "description": "Offset the result set by a specific number of items.",
+ "type": "integer"
+ },
+ "order": {
+ "required": false,
+ "default": "desc",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "description": "Order sort attribute ascending or descending.",
+ "type": "string"
+ },
+ "orderby": {
+ "required": false,
+ "default": "date",
+ "enum": [
+ "date",
+ "id",
+ "include",
+ "relevance",
+ "slug",
+ "include_slugs",
+ "title"
+ ],
+ "description": "Sort collection by object attribute.",
+ "type": "string"
</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="branches49testsqunitwpincludesjswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/tests/qunit/wp-includes/js/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/tests/qunit/wp-includes/js/wp-api.js 2018-09-18 03:44:57 UTC (rev 43647)
+++ branches/4.9/tests/qunit/wp-includes/js/wp-api.js 2018-09-18 03:54:20 UTC (rev 43648)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -400,9 +400,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get the main endpoint.
</span><span class="cx" style="display: block; padding: 0 10px"> var endpoint = theModels.at(0);
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var expectedMetas = '{"meta_key":"meta_value"}';
+ if ( 'Tags' === modelType ) {
+ expectedMetas = '{"test_single":"","test_multi":[],"meta_key":"meta_value","test_tag_meta":""}';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify the meta object returned correctly from `getMetas()`.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- assert.equal( JSON.stringify( endpoint.getMetas() ), '{"meta_key":"meta_value"}', 'Full meta key/values object should be readable.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ assert.equal( JSON.stringify( endpoint.getMetas() ), expectedMetas, 'Full meta key/values object should be readable.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify single meta returned correctly from `getMeta()`
</span><span class="cx" style="display: block; padding: 0 10px"> assert.equal( endpoint.getMeta( 'meta_key' ), 'meta_value', 'Single meta should be readable by key.' );
</span></span></pre>
</div>
</div>
</body>
</html>