Changeset 60986

Timestamp:

10/20/2025 07:04:44 PM (11 months ago)

Author:

westonruter

Message:

Posts, Post Types: Add post_states_string filter for HTML string of post states.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10000

Props paulbonneau, mukesh27, westonruter, SirLouen, dmsnell, brandbrilliance, shsajalchowdhury, aialvi, ugyensupport.
Fixes #51403.

Location:

trunk

Files:

• src/wp-admin/includes/template.php (modified) (1 diff)
• tests/phpunit/tests/post/getPostStatus.php (modified) (1 diff)

trunk/src/wp-admin/includes/template.php

@@ -2266 +2266 @@
         }
 
+        /**
+         * Filters the HTML string of post states.
+         *
+         * @since 6.9.0
+         *
+         * @param string   $post_states_string The post states HTML string.
+         * @param string[] $post_states        The post states.
+         * @param WP_Post  $post               The current post object.
+         */
+        $post_states_string = apply_filters( 'post_states_string', $post_states_string, $post_states, $post );
+
         if ( $display ) {
                 echo $post_states_string;

trunk/tests/phpunit/tests/post/getPostStatus.php

@@ -165 +165 @@
                 );
         }
+
+        /**
+         * Ensure the `post_states_string` filter works to modify post state output.
+         *
+         * @ticket 51403
+         *
+         * @dataProvider data_filter_post_states_string_should_enable_post_state_html_output_modification
+         *
+         * @covers ::_post_states
+         *
+         * @param string $post_state The post state to test.
+         */
+        public function test_filter_post_states_string_should_enable_post_state_html_output_modification( $post_state ) {
+                $post = get_post( self::$post_ids[ $post_state ] );
+
+                $original_output = _post_states( $post, false );
+
+                if ( count( get_post_states( $post ) ) === 0 ) {
+                        $text_to_append = '&mdash; <span class="post-state">Sample state</span>';
+                } else {
+                        $text_to_append = '<span class="post-state">, Sample state</span>';
+                }
+
+                add_filter(
+                        'post_states_string',
+                        function ( $post_states_string, $post_states, $filtered_post ) use ( $text_to_append, $post ) {
+                                $this->assertIsString( $post_states_string, 'Expected first filter arg to be a string.' );
+                                $this->assertIsArray( $post_states, 'Expected second filter arg to be an array.' );
+                                $this->assertInstanceOf( WP_Post::class, $filtered_post, 'Expected third filter arg to be a WP_Post' );
+                                $this->assertSame( $post->ID, $filtered_post->ID, 'Expected the third filter arg to be the same as the current post.' );
+                                return $post_states_string . $text_to_append;
+                        },
+                        10,
+                        3
+                );
+
+                $output = _post_states( $post, false );
+
+                $this->assertSame( $original_output . $text_to_append, $output, 'Expected text to be appended to the original output.' );
+        }
+
+        /**
+         * Data provider for test_filter_post_states_string_should_enable_post_state_html_output_modification().
+         *
+         * @return array[] {
+         *     @type string $post_state The post state to test.
+         * }
+         */
+        public static function data_filter_post_states_string_should_enable_post_state_html_output_modification() {
+                return array(
+                        array( 'publish' ),
+                        array( 'future' ),
+                        array( 'draft' ),
+                        array( 'auto-draft' ),
+                        array( 'trash' ),
+                        array( 'private' ),
+                );
+        }
 }