Remove variable that is globally accessible #2663

[raftaar1191]

Description

PR to fix #2663

How Has This Been Tested?

Manually Tested

Types of changes

Bug fix (non-breaking change which fixes an issue)

Checklist:

• My code is tested.
• My code follows the WordPress code style.
• My code follows has proper inline documentation.

[raftaar1191]

@DevinWalker @ravinderk

Need to Create a blog post and inform all the developer about this ( That we are removing the second parameter from the do_action of give_checkout_error_checks as this is accessible from the $_POST directly )

[kevinwhoffman]

We should not remove the parameter altogether since it would break functionality for any developer relying on it. We should instead follow WordPress core's lead by renaming the deprecated parameter and noting it in the DocBlock.

/**
 * Fires after validating donation form fields.
 *
 * Allow you to hook to donation form errors.
 *
 * @since 1.0
 * @since 2.0.2 Second parameter deprecated in favor of $_POST.
 *
 * @param bool|array $valid_data Validated fields.
 * @param array      $deprecated Deprecated. Use $_POST instead.
 */
do_action( 'give_checkout_error_checks', $valid_data, $deprecated );

[DevinWalker]

Let's deprecate this in core like @kevinwhoffman describes in the comments rather than remove it entirely. I see that breaking folks who don't update add-ons.

[raftaar1191]

Thanks, @kevinwhoffman ya I love the example.

@DevinWalker @kevinwhoffman
Just one question what I supposed to passed in $deprecated should I pass NULL to it

do_action( 'give_checkout_error_checks', $valid_data, $deprecated = NULL );

[DevinWalker]

@raftaar1191 no don't pass null that would basically be the same thing as removing it. Preserve the passed value so it doesn't break things.

[raftaar1191]

Thanks @DevinWalker for you reply updated the PR

[kevinwhoffman]

Good catch on keeping $deprecated = $_POST so that data is still available within any hooked functions.