Add hook_extra parameter to upgrader_pre_download filter

[obliviousharmony]

Hello,

In trying to customize the no_package error for a plugin update, I came across the upgrade_pre_download filter as a really good fit. The only problem with this filter is that it does not contain any information except the path to the package (which is useless in my case as its an empty string) and the upgrader instance. It looks like most of the filters in the WC_Upgrader class are passed the hook_extra argument. I propose we add the parameter to the upgrader_pre_download filter, which does include a plugin key during upgrades!

This adds a parameter to the upgrader_pre_download filter that can be used to identify some information about the upgrade. The specific use-case this is being added for is so that we can use the plugin key to figure out which plugin is being updated.

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

[davidbaumwald]

@SergeyBiryukov IS this one still doable with Beta 1 landing in a few days? What else is needed to move this one forward?

[davidbaumwald]

Since this changes the filter signature, marking this for a call out on the Misc Dev Note.

[desrosj]

@obliviousharmony Thanks for this! I just reviewed the PR over on GitHub with some feedback.

[obliviousharmony]

Thanks for the feedback! I've gone ahead and flattened the parameter. For future reference, when responding to a ticket after I've addressed feedback, would I want to remove the needs-refresh keywork?

[prbot]

​ObliviousHarmony commented on ​PR #198:

Thanks for the feedback, I've flattened the array!

[desrosj]

Thanks! I'll take a look shortly and try to get this in for 5.5.

Ya, that works. There is currently no syncing for labels or anything between GitHub and Trac. I personally try to keep the Trac ticket updated to reflect the status of the ticket so there is less back and forth!

[desrosj]

In 48399:

Upgrade/Install: Add hook_extra parameter to the upgrader_pre_download filter.

This provides additional context to code running on this hook, including which plugin or theme update will be downloaded. It also brings consistency to this filter with others throughout the upgrade process.

Props obliviousharmony, desrosj.
Fixes #49686.

[obliviousharmony]

Thanks!

[prbot]

​ObliviousHarmony commented on ​PR #198:

Thanks for the feedback! I've gone ahead and flattened the parameter. No need to be so forward-looking :)

[prbot]

​ObliviousHarmony commented on ​PR #198:

Thanks for the feedback! I've gone ahead and flattened the parameter. No need to be so forward-looking :)

[SergeyBiryukov]

In 48449:

Docs: Add a @since entry for the $hook_extra parameter added to WP_Upgrader::download_package().

Follow-up to [48399].

See #49686.

[desrosj]

This received a call out in the Miscellaneous Developer Changes in 5.5 dev note: ​https://make.wordpress.org/core/2020/07/29/miscellaneous-developer-focused-changes-in-wordpress-5-5/.