Add filters to post states function by paulbonneau · Pull Request #10000 · WordPress/wordpress-develop

paulbonneau · 2025-09-22T21:52:18Z

This PR aim to implement a new filter in _post_states as asked in the ticket linked below

Trac ticket: https://core.trac.wordpress.org/ticket/51403

github-actions · 2025-09-22T21:52:28Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props paulbonneau, westonruter, mukesh27, sirlouen, dmsnell.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2025-09-22T22:08:31Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

src/wp-includes/compat-utf8.php

src/wp-admin/includes/template.php

tests/phpunit/tests/post/getPostStatus.php

mukeshpanchal27 · 2025-09-26T05:54:51Z

Thanks @paulbonneau, Left some final bit of feedbacks.

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

SirLouen

Remove the src/wp-includes/compat-utf8.php

paulbonneau · 2025-09-28T20:40:03Z

Remove the src/wp-includes/compat-utf8.php

done

dmsnell · 2025-10-20T18:20:26Z

tests/phpunit/tests/post/getPostStatus.php

+		$output = _post_states( $post, false );
+
+		$this->assertStringContainsString( $text_to_append, $output );
+		$this->assertStringContainsString( $original_output, $output );


should we consider using $this->assertStringStartsWith and $this->assertStringEndsWith here instead of contains?

Update: not a blocker, but also something that seems fine to change while merging if it’s useful.

Yeah, in dea8f00 I'm changing this to:

$this->assertSame( $original_output . $text_to_append, $output, 'Expected text to be appended to the original output.' );

When there are no post states, then the $original_output is an empty string.

…into add-filters-to-_post_states-function

src/wp-admin/includes/template.php

westonruter · 2025-10-20T18:37:13Z

src/wp-admin/includes/template.php

 *                         Default true.
 * @return string Post states string.
 */
 function _post_states( $post, $display = true ) {


The same changes seem like they should be done to _media_states().

Maybe later

… post states. Developed in #10000 Props paulbonneau, mukesh27, westonruter, SirLouen, dmsnell, brandbrilliance, shsajalchowdhury, aialvi, ugyensupport. Fixes #51403. git-svn-id: https://develop.svn.wordpress.org/trunk@60986 602fd350-edb4-49c9-b593-d223f7449a82

westonruter · 2025-10-20T19:07:40Z

Committed in r60986 (20b1cf6)

… post states. Developed in WordPress/wordpress-develop#10000 Props paulbonneau, mukesh27, westonruter, SirLouen, dmsnell, brandbrilliance, shsajalchowdhury, aialvi, ugyensupport. Fixes #51403. Built from https://develop.svn.wordpress.org/trunk@60986 git-svn-id: http://core.svn.wordpress.org/trunk@60322 1a063a9b-81f0-0310-95a4-ce76da25c4cd

… post states. Developed in WordPress/wordpress-develop#10000 Props paulbonneau, mukesh27, westonruter, SirLouen, dmsnell, brandbrilliance, shsajalchowdhury, aialvi, ugyensupport. Fixes #51403. Built from https://develop.svn.wordpress.org/trunk@60986 git-svn-id: https://core.svn.wordpress.org/trunk@60322 1a063a9b-81f0-0310-95a4-ce76da25c4cd

dmsnell · 2025-10-20T19:20:46Z

src/wp-admin/includes/template.php

+	 *
+	 * @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.


can follow-up after merge, but it would be really handy to have some examples here so people know what to expect. I find the combination of _string and HTML string confusing, plus I don’t know what to expect for this or the following array. Which post states are these?

/** * @param string $post_states_html All relevant post states combined into a an HTML string for display. * E.g. ' — <span class="post-state">draft</span> — <span class="post-state">private</span>' * @param string[] $post_states. All relevant posts states as an array of raw names. * E.g. `array( "draft", "private" )`.

@dmsnell Should we rename the filter to be post_states_html then too?

@westonruter originally started to share here, but moved it to #51403 because I feel like it applies to the design of the request rather the implementation.

Since this does provide the array of $post_states I think it does serve the questions I raised, but I do believe we could better communicate what’s going on with the naming.

I've opened #10360 to iterate on this.

paulbonneau added 3 commits September 22, 2025 23:37

Adding a filter in _post_states enabling post string modification

2a5f8f3

Adding a filter in _post_states enabling post string modification

2d4275e

Adding a filter in _post_states enabling post string modification

facdfd4

mukeshpanchal27 reviewed Sep 23, 2025

View reviewed changes

src/wp-includes/compat-utf8.php Show resolved Hide resolved

mukeshpanchal27 reviewed Sep 23, 2025

View reviewed changes

src/wp-admin/includes/template.php Outdated Show resolved Hide resolved

Adding tests and a doc block for the new filter

c3e2f0f

mukeshpanchal27 reviewed Sep 26, 2025

View reviewed changes

tests/phpunit/tests/post/getPostStatus.php Show resolved Hide resolved

mukeshpanchal27 reviewed Sep 26, 2025

View reviewed changes

tests/phpunit/tests/post/getPostStatus.php Outdated Show resolved Hide resolved

mukeshpanchal27 reviewed Sep 26, 2025

View reviewed changes

tests/phpunit/tests/post/getPostStatus.php Outdated Show resolved Hide resolved

mukeshpanchal27 reviewed Sep 26, 2025

View reviewed changes

tests/phpunit/tests/post/getPostStatus.php Outdated Show resolved Hide resolved

paulbonneau and others added 4 commits September 26, 2025 14:10

Update tests/phpunit/tests/post/getPostStatus.php

7ffc86b

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

Update tests/phpunit/tests/post/getPostStatus.php

975580f

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

Update tests/phpunit/tests/post/getPostStatus.php

9281fc6

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

Update tests/phpunit/tests/post/getPostStatus.php

c5a050e

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

SirLouen suggested changes Sep 28, 2025

View reviewed changes

Remove the src/wp-includes/compat-utf8.php

6486789

SirLouen approved these changes Sep 28, 2025

View reviewed changes

Merge branch 'WordPress:trunk' into add-filters-to-_post_states-function

e0ab8f6

westonruter requested a review from mukeshpanchal27 October 20, 2025 18:18

dmsnell reviewed Oct 20, 2025

View reviewed changes

Merge branch 'trunk' of https://github.com/WordPress/wordpress-develop …

3e8263f

…into add-filters-to-_post_states-function

westonruter reviewed Oct 20, 2025

View reviewed changes

src/wp-admin/includes/template.php Outdated Show resolved Hide resolved

westonruter reviewed Oct 20, 2025

View reviewed changes

Add post states array to filter as arg

dea8f00

westonruter closed this Oct 20, 2025

dmsnell reviewed Oct 20, 2025

View reviewed changes

westonruter mentioned this pull request Oct 20, 2025

Rename post_states_string to post_states_html and improve phpdoc #10360

Closed

Conversation

paulbonneau commented Sep 22, 2025

Uh oh!

github-actions bot commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 22, 2025

Test using WordPress Playground

Some things to be aware of

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mukeshpanchal27 commented Sep 26, 2025

Uh oh!

SirLouen left a comment

Choose a reason for hiding this comment

Uh oh!

paulbonneau commented Sep 28, 2025

Uh oh!

dmsnell Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

westonruter Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

westonruter Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter commented Oct 20, 2025

Uh oh!

dmsnell Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

dmsnell Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions bot commented Sep 22, 2025 •

edited

Loading

dmsnell Oct 20, 2025 •

edited

Loading