Changeset 58783

Timestamp:

07/23/2024 07:49:54 AM (9 months ago)

Author:

youknowriad

Message:

REST API: Remove post status prefix from REST API responses.

When using the /posts or /pages endpoints, for private posts or pages, you get the following title property: { raw: "Some title", rendered: "Private: Some title" }
this commit removes the prefix from rendered private posts titles (just like what we do for protected posts)

Props youknowriad, swissspidy, timothyblynjacobs, sergeybiryukov, ramonopoly.
Fixes #61639.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php (modified) (2 diffs)
• tests/phpunit/includes/testcase-rest-post-type-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/wpRestMenuItemsController.php (modified) (1 diff)

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

@@ -328 +328 @@
         if ( rest_is_field_included( 'title.rendered', $fields ) ) {
             add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
 
             $data['title']['rendered'] = get_the_title( $post->ID );
 
             remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
         }
 

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

@@ -511 +511 @@
         if ( rest_is_field_included( 'title.rendered', $fields ) ) {
             add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
 
             /** This filter is documented in wp-includes/post-template.php */
@@ -518 +519 @@
 
             remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
         }
 

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

@@ -1845 +1845 @@
         if ( rest_is_field_included( 'title.rendered', $fields ) ) {
             add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
 
             $data['title']['rendered'] = get_the_title( $post->ID );
 
             remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
         }
 
@@ -2048 +2050 @@
 
     /**
-     * Overwrites the default protected title format.
-     *
-     * By default, WordPress will show password protected posts with a title of
-     * "Protected: %s", as the REST API communicates the protected status of a post
-     * in a machine-readable format, we remove the "Protected: " prefix.
-     *
-     * @since 4.7.0
-     *
-     * @return string Protected title format.
+     * Overwrites the default protected and private title format.
+     *
+     * By default, WordPress will show password protected or private posts with a title of
+     * "Protected: %s" or "Private: %s", as the REST API communicates the status of a post
+     * in a machine-readable format, we remove the prefix.
+     *
+     * @since 4.7.0
+     *
+     * @return string Title format.
      */
     public function protected_title_format() {

trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php

@@ -133 +133 @@
             if ( post_type_supports( $post->post_type, 'title' ) ) {
                 add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+                add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
                 $data[ WP_REST_Search_Controller::PROP_TITLE ] = get_the_title( $post->ID );
                 remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+                remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
             } else {
                 $data[ WP_REST_Search_Controller::PROP_TITLE ] = '';
@@ -184 +186 @@
 
     /**
-     * Overwrites the default protected title format.
-     *
-     * By default, WordPress will show password protected posts with a title of
-     * "Protected: %s". As the REST API communicates the protected status of a post
-     * in a machine-readable format, we remove the "Protected: " prefix.
-     *
-     * @since 5.0.0
-     *
-     * @return string Protected title format.
+     * Overwrites the default protected and private title format.
+     *
+     * By default, WordPress will show password protected or private posts with a title of
+     * "Protected: %s" or "Private: %s", as the REST API communicates the status of a post
+     * in a machine-readable format, we remove the prefix.
+     *
+     * @since 5.0.0
+     *
+     * @return string Title format.
      */
     public function protected_title_format() {

trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php

@@ -108 +108 @@
         if ( post_type_supports( $post->post_type, 'title' ) ) {
             add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
             $this->assertSame( get_the_title( $post->ID ), $data['title']['rendered'] );
             remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
             if ( 'edit' === $context ) {
                 $this->assertSame( $post->post_title, $data['title']['raw'] );

trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php

@@ -863 +863 @@
         if ( post_type_supports( self::POST_TYPE, 'title' ) ) {
             add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
             $this->assertSame( $post->title, $data['title']['rendered'] );
             remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
+            remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
             if ( 'edit' === $context ) {
                 $this->assertSame( $post->title, $data['title']['raw'] );