Introduce new filter "render_block_core_navigation_link_allowed_post_status"

[Chrico]

This PR introduces a new Filter for rendering the "Navigation Link"-Block to whitelist post_status to not restrict the output to only "public" post_status.

See more information in: #33215

Why?

Since Gutenberg 9.8.0 (see commit: 1936a04 | issue: #27207) the "Navigation Link"-Block limits the output to only "public" post_status.

While it is possible to hook into WP_Query and the WP_REST_Post_Search_Handler via rest_post_search_query to extend the $query_args with custom post_status in the REST Response, the rendering part will still limit to post_status = "publish.

With this new filter render_block_core_navigation_link_allowed_post_status it is now possible to also whitelist multiple post_status for rendering in frontend.

Testing Instructions

0. You need to have at least 1 Post which is post_status = "private".
1. Add a new mu-plugin which hooks into following:

add_filter( 
    'render_block_core_navigation_link_allowed_post_status', 
    static function(array $postStatus): array {
        $postStatus[] = 'private';

        return $postStatus;
} );

add_filter( 
    'rest_post_search_query', 
    static function( array $queryArgs): array {
        $postStatus = $queryArgs['post_status'] ?? [];
        $postStatus[] = 'private';

        $queryArgs['post_status'] = $postStatus;

        return $queryArgs;
} );

2. Create a new Page with "Navigation Block" and search for 0. the Post with post_status = "private" and insert
3. Save Page and go to frontend -> "private Post"-link is rendered.

[github-actions]

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: Chrico <[email protected]>
Co-authored-by: getdave <[email protected]>
Co-authored-by: draganescu <[email protected]>

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

[getdave]

Apologies I missed this ping. I'll add this to my list of things to test. Seems reasonable to bring this in.

[getdave]

Thank you for this PR.

I tested it and it works as described.

I had to adjust the testing instructions to account for post status being a string and I also included "Draft" posts so I could check it worked for more statuses:

add_filter(
	'rest_post_search_query',
	static function( array $queryArgs ): array {
		$postStatus = $queryArgs['post_status'] ?? array();

		if ( is_string( $postStatus ) ) {
			$postStatus = array( $postStatus );
		}

		$postStatus[] = 'private';
		$postStatus[] = 'draft';

		$queryArgs['post_status'] = $postStatus;

		return $queryArgs;
	}
);

Overall I'd say it's useful to open up this flexibility for developers.

@draganescu How do you feel about this one?

[getdave]

Added the "Needs Dev Note" label as when it comes to WP 6.8 it will be useful to highlight this in the miscellaneous section.

[Chrico]

@getdave any action from my end needed to complete this? :-)

[draganescu]

This looks good to me as well and is in line with where the discussion ended 👏🏻 well done.

[getdave]

@draganescu This appears to be stalling on the 8.3 check. I think that check was probably added after the PR was created or something. I don't think that should block this PR.

Are you ok to green light me force merging this one?

[getdave]

@Chrico I wonder if you be able to rebase this PR branch against upstream trunk? That should allow all the tests to go green without us having to force anything.

[getdave]

All the tests are passing here with the exception of React Native tests which I know to be currently problematic and have been disabled on trunk. Therefore I'm going to go ahead and force merge.

[getdave]

Dev Note

The Navigation block now supports filtering of the post statuses of Posts shown in the Navigation on the front of the site. The new filter render_block_core_navigation_link_allowed_post_status defaults to publish but that list can be extended via the hook:

add_filter( 
    'render_block_core_navigation_link_allowed_post_status', 
    static function(array $postStatus): array {
        $postStatus[] = 'private'; // append statuses to the array of default statuses.
        return $postStatus;
} );