do_action_deprecated and apply_filters_deprecated $replacement param should default to null

[felipeelia]

_deprecated_hook, the function responsible for logging an error when an old hook is called, uses is_null to check if a $replacement was provided.

The problem is that $replacement defaults to false (instead of null) on apply_filters_deprecated and do_action_deprecated, displaying the Use %3$s instead.' message without any value.

[shaampk1]

Replying to felipeelia:

_deprecated_hook, the function responsible for logging an error when an old hook is called, uses is_null to check if a $replacement was provided.

The problem is that $replacement defaults to false (instead of null) on apply_filters_deprecated and do_action_deprecated, displaying the Use %3$s instead.' message without any value.

Hi,

This ticket looks interesting. Can you please provide any screenshot or the hook that is causing the issue?

Thanks.

[shaampk1]

sprintf function: fixed the missing comma for $replacement var in is_null check.

[shaampk1]

sprintf function: fixed the missing comma for $version var under ELSE check.

[SergeyBiryukov]

Hi @shaampk1, thanks for the patch! However, looks like that's not quite what the ticket meant.

Unlike arrays, sprint() calls don't require the extra comma and in fact will produce a syntax error with that change.

The suggested change is to switch $replacement = false in lines 626 and 653​ of wp-includes/plugin.php to $replacement = null, as that is the value being checked in _deprecated_hook() and other related functions, see line 4839​ in wp-includes/functions.php.

[shaampk1]

Reverted previous changes and assigned the default values to both of the functions as NULL

[shaampk1]

Hi, @SergeyBiryukov,

Thanks for the quick assistance. I have just submitted a new patch, could you also please take a quick look. Thanks : )

[felipeelia]

Hey @shaampk1! Yes, the last patch addresses what I was trying to highlight :)

I've noticed the problem while hooking a function to the delete_blog action and I guess that that and deleted_blog actions are the only ones that don't provide any replacement.

[SergeyBiryukov]

In 46792:

Plugins: Correct default value of $replacement parameter in do_action_deprecated() and apply_filters_deprecated().

This addresses an inconsistency with _deprecated_hook(), which uses is_null() to check if $replacement was provided, however the previous default value was false.

Props shaampk1, felipeelia.
Fixes #48817.

[shaampk1]

Sure @felipeelia. Thank you for pointing out the bug.

Thank you @SergeyBiryukov for all the help getting me through this and accepting my contribution. It means a lot ^_ really.