Changeset 58065 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

04/30/2024 09:31:41 AM (14 months ago)

Author:

swissspidy

Message:

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 #59043.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -98 +98 @@
             'context' => $this->get_context_param( array( 'default' => 'view' ) ),
         );
+        if ( isset( $schema['properties']['excerpt'] ) ) {
+            $get_item_args['excerpt_length'] = array(
+                'description' => __( 'Override the default excerpt length.' ),
+                'type'        => 'integer',
+            );
+        }
         if ( isset( $schema['properties']['password'] ) ) {
             $get_item_args['password'] = array(
@@ -1873 +1879 @@
 
         if ( rest_is_field_included( 'excerpt', $fields ) ) {
+            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
+                );
+            }
+
             /** This filter is documented in wp-includes/post-template.php */
             $excerpt = apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
@@ -1884 +1903 @@
                 'protected' => (bool) $post->post_password,
             );
+
+            if ( isset( $override_excerpt_length ) ) {
+                remove_filter(
+                    'excerpt_length',
+                    $override_excerpt_length,
+                    20
+                );
+            }
         }