[Twenty Twenty-One] Incorrect use of `the_password_form` filter argument

[burhandodhy]

the_password_form filter function has only one parameter $output that is html output of from. Where Twenty Twenty-One theme tries to use it as $post object.

​https://github.com/WordPress/wordpress-develop/blob/master/src/wp-content/themes/twentytwentyone/inc/template-functions.php#L395

Trac ticket:
https://core.trac.wordpress.org/ticket/53091#ticket

[burhandodhy]

Replying to burhandodhy:

the_password_form filter function has only one parameter $output that is hthml output of from. Where Twenty Twenty-One theme tries to use it as $post object.

​https://github.com/WordPress/wordpress-develop/blob/master/src/wp-content/themes/twentytwentyone/inc/template-functions.php#L395

Filter definition https://core.trac.wordpress.org/browser/tags/5.7.1/src/wp-includes/post-template.php#L1740

PR link: ​https://github.com/WordPress/wordpress-develop/pull/1208

[mukesh27]

Hi there!

Thank you for the ticket and patch.

The ​PR #1208 looks fine to me.

Can you please add doc for global $post; like below?

* @global WP_Post $post Global post object.

[burhandodhy]

@mukesh27 feedback implemented.

[SergeyBiryukov]

Just noting that there should be an empty line between @global and @return and ideally after global $post too, looks good to me otherwise.

On a related note, it might be a good idea to pass the $post argument to the_password_form filter. Looks like it was previously suggested in #29008, but never implemented. Reopening that ticket.

[mukesh27]

As per @SergeyBiryukov quick update and Changeset 50791 we have to change the patch.

[burhandodhy]

@mukesh27 changes are done.

[davidbaumwald]

@SergeyBiryukov With [50791] in place, what would you like to see done on this ticket?

Option 1: Add the global for $post and adding to the docblock, with twenty_twenty_one_password_form accepting no params.

Option 2: Update the filter to pass the second arg for the $post and update twenty_twenty_one_password_form to use both params.

[SergeyBiryukov]

Replying to davidbaumwald:

With [50791] in place, what would you like to see done on this ticket?

Good question :) My initial thought was option 1, since we want the theme to remain compatible with WP 5.6 and 5.7.

But it looks like if we set a default value for $post, that would also be compatible with older WP versions:

/**
 * Retrieve protected post password form content.
 *
 * @since Twenty Twenty-One 1.0
 * @since Twenty Twenty-One 1.4 Corrected parameter name for `$output`,
 *                              added the `$post` parameter.
 *
 * @param string      $output The password form HTML output.
 * @param int|WP_Post $post   Optional. Post ID or WP_Post object. Default is global $post.
 * @return string HTML content for password form for password protected post.
 */
function twenty_twenty_one_password_form( $output, $post = 0 ) {
	$post   = get_post( $post );
	...
	return $output;
}
add_filter( 'the_password_form', 'twenty_twenty_one_password_form', 10, 2 );

So both options are technically interchangeable. I guess option 2 might be a bit cleaner, as it keeps the current behavior on WP 5.6 and 5.7, and offers better compatibility with WP 5.8.

[davidbaumwald]

@SergeyBiryukov Thanks! I like option #2 better as well.

@burhandodhy Do you can to re-work your PR to include Sergey's suggestions?

[burhandodhy]

@davidbaumwald I have updated my PR.

[mukesh27]

Updated PR looks good to me.

@davidbaumwald Do we need to update Milestone to 5.8 because we do not update the bundled theme in minor versions or @SergeyBiryukov backport those [50791] these changes to the 5.7 branches?

[burhandodhy]

@mukesh27 this patch depends on https://core.trac.wordpress.org/ticket/29008 patch. So this will probably go with 5.8

[SergeyBiryukov]

Yes, a new theme version can technically be released earlier, but we might want to include some other fixes in the update as well, so I think this can be moved to 5.8. Thanks for the PR, it looks good to me too :)

[burhandodhy]

Any update on this ?

cc: @SergeyBiryukov @davidbaumwald @mukesh27

[SergeyBiryukov]

Marking for commit.

[davidbaumwald]

In 50841:

Bundled Theme: Update twenty_twenty_one_password_form function to actually use a $post parameter.

The twentytwentyone filtered the_password_form with a twenty_twenty_one_password_form callback that, by default, passed only one parameter that was assumed to be the post or post ID. However, the first parameter for the_password_form is the filtered output value. This fix updates both the filter reference and callback to use two parameters: $output and $post.

Props burhandodhy, mukesh27.
Fixes #53091.

Thanks for the PR! This was merged in r50841.