<!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>[58065] trunk: REST API: allow overriding excerpt length.</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/58065">58065</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/58065","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-04-30 09:31:41 +0000 (Tue, 30 Apr 2024)</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: allow overriding excerpt length.
This can be used by the excerpt block in the editor to change the excerpt length without filtering `excerpt_length` in a conflicting way. This enhancement still needs a corresponding change on the Gutenberg side.
Props swissspidy, antonvlasenko, mukesh27, azaozz, andraganescu, timothyblynjacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/59043">#59043</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiwpRestMenuItemsControllerphp">trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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-posts-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-posts-controller.php 2024-04-30 08:53:51 UTC (rev 58064)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2024-04-30 09:31:41 UTC (rev 58065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,6 +97,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $get_item_args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => $this->get_context_param( array( 'default' => 'view' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $schema['properties']['excerpt'] ) ) {
+ $get_item_args['excerpt_length'] = array(
+ 'description' => __( 'Override the default excerpt length.' ),
+ 'type' => 'integer',
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $schema['properties']['password'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $get_item_args['password'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The password for the post if it is password protected.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1872,6 +1878,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( rest_is_field_included( 'excerpt', $fields ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $request['excerpt_length'] ) ) {
+ $excerpt_length = $request['excerpt_length'];
+ $override_excerpt_length = static function () use ( $excerpt_length ) {
+ return $excerpt_length;
+ };
+
+ add_filter(
+ 'excerpt_length',
+ $override_excerpt_length,
+ 20
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/post-template.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $excerpt = apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1883,6 +1902,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'rendered' => post_password_required( $post ) ? '' : $excerpt,
</span><span class="cx" style="display: block; padding: 0 10px"> 'protected' => (bool) $post->post_password,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( isset( $override_excerpt_length ) ) {
+ remove_filter(
+ 'excerpt_length',
+ $override_excerpt_length,
+ 20
+ );
+ }
</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 ( $has_password_filter ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestattachmentscontrollerphp"></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-attachments-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-attachments-controller.php 2024-04-30 08:53:51 UTC (rev 58064)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2024-04-30 09:31:41 UTC (rev 58065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -259,8 +259,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_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"> $keys = array_keys( $data['endpoints'][0]['args'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sort( $keys );
- $this->assertSame( array( 'context', 'id' ), $keys );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( array( 'context', 'id' ), $keys );
</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="trunktestsphpunittestsrestapirestpostscontrollerphp"></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-posts-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-posts-controller.php 2024-04-30 08:53:51 UTC (rev 58064)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2024-04-30 09:31:41 UTC (rev 58065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,8 +222,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_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"> $keys = array_keys( $data['endpoints'][0]['args'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sort( $keys );
- $this->assertSame( array( 'context', 'id', 'password' ), $keys );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( array( 'context', 'id', 'password', 'excerpt_length' ), $keys );
</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_registered_get_items_embed() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2363,6 +2362,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $filter_count );
</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 59043
+ *
+ * @covers WP_REST_Posts_Controller::prepare_item_for_response
+ */
+ public function test_prepare_item_override_excerpt_length() {
+ wp_set_current_user( self::$editor_id );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_excerpt' => '',
+ 'post_content' => 'Bacon ipsum dolor amet porchetta capicola sirloin prosciutto brisket shankle jerky. Ham hock filet mignon boudin ground round, prosciutto alcatra spare ribs meatball turducken pork beef ribs ham beef. Bacon pastrami short loin, venison tri-tip ham short ribs doner swine. Tenderloin pig tongue pork jowl doner. Pork loin rump t-bone, beef strip steak flank drumstick tri-tip short loin capicola jowl. Cow filet mignon hamburger doner rump. Short loin jowl drumstick, tongue tail beef ribs pancetta flank brisket landjaeger chuck venison frankfurter turkey.
+
+Brisket shank rump, tongue beef ribs swine fatback turducken capicola meatball picanha chicken cupim meatloaf turkey. Bacon biltong shoulder tail frankfurter boudin cupim turkey drumstick. Porchetta pig shoulder, jerky flank pork tail meatball hamburger. Doner ham hock ribeye tail jerky swine. Leberkas ribeye pancetta, tenderloin capicola doner turducken chicken venison ground round boudin pork chop. Tail pork loin pig spare ribs, biltong ribeye brisket pork chop cupim. Short loin leberkas spare ribs jowl landjaeger tongue kevin flank bacon prosciutto.
+
+Shankle pork chop prosciutto ribeye ham hock pastrami. T-bone shank brisket bacon pork chop. Cupim hamburger pork loin short loin. Boudin ball tip cupim ground round ham shoulder. Sausage rump cow tongue bresaola pork pancetta biltong tail chicken turkey hamburger. Kevin flank pork loin salami biltong. Alcatra landjaeger pastrami andouille kielbasa ham tenderloin drumstick sausage turducken tongue corned beef.',
+ )
+ );
+
+ $endpoint = new WP_REST_Posts_Controller( 'post' );
+ $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/posts/%d', $post_id ) );
+ $request->set_param( 'context', 'edit' );
+ $request->set_param( '_fields', 'excerpt' );
+ $request->set_param( 'excerpt_length', 43 );
+ $response = $endpoint->prepare_item_for_response( get_post( $post_id ), $request );
+ $data = $response->get_data();
+ $this->assertArrayHasKey( 'excerpt', $data, 'Response must contain an "excerpt" key.' );
+
+ // 43 words plus the ellipsis added via the 'excerpt_more' filter.
+ $this->assertCount(
+ 44,
+ explode( ' ', $data['excerpt']['rendered'] ),
+ 'Incorrect word count in the excerpt. Expected the excerpt to contain 44 words (43 words plus an ellipsis), but a different word count was found.'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item() {
</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">
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiwpRestMenuItemsControllerphp"></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/wpRestMenuItemsController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php 2024-04-30 08:53:51 UTC (rev 58064)
+++ trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php 2024-04-30 09:31:41 UTC (rev 58065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,8 +156,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_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"> $keys = array_keys( $data['endpoints'][0]['args'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sort( $keys );
- $this->assertSame( array( 'context', 'id' ), $keys );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( array( 'context', 'id' ), $keys );
</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="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2024-04-30 08:53:51 UTC (rev 58064)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2024-04-30 09:31:41 UTC (rev 58065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -886,6 +886,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": "view",
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "excerpt_length": {
+ "description": "Override the default excerpt length.",
+ "type": "integer",
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "password": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "The password for the post if it is password protected.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2051,6 +2056,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": "view",
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "excerpt_length": {
+ "description": "Override the default excerpt length.",
+ "type": "integer",
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "password": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "The password for the post if it is password protected.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string",
</span></span></pre>
</div>
</div>
</body>
</html>