Changeset 48399 for trunk/src/wp-admin/includes/class-wp-upgrader.php

Timestamp:

07/07/2020 07:13:30 PM (4 years ago)

Author:

desrosj

Message:

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.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -249 +249 @@
      *                                 existing local file, it will be returned untouched.
      * @param bool   $check_signatures Whether to validate file signatures. Default false.
+     * @param array  $hook_extra       Extra arguments to pass to the filter hooks. Default empty array.
      * @return string|WP_Error The full path to the downloaded package file, or a WP_Error object.
      */
-    public function download_package( $package, $check_signatures = false ) {
-
+    public function download_package( $package, $check_signatures = false, $hook_extra = array() ) {
         /**
          * Filters whether to return the package.
@@ -258 +258 @@
          * @since 3.7.0
          *
-         * @param bool        $reply   Whether to bail without returning the package.
-         *                             Default false.
-         * @param string      $package The package file name.
-         * @param WP_Upgrader $this    The WP_Upgrader instance.
+         * @param bool        $reply      Whether to bail without returning the package.
+         *                                Default false.
+         * @param string      $package    The package file name.
+         * @param WP_Upgrader $this       The WP_Upgrader instance.
+         * @param array       $hook_extra Extra arguments passed to hooked filters.
          */
-        $reply = apply_filters( 'upgrader_pre_download', false, $package, $this );
+        $reply = apply_filters( 'upgrader_pre_download', false, $package, $this, $hook_extra );
         if ( false !== $reply ) {
             return $reply;
@@ -738 +739 @@
          * of the file if the package is a local file)
          */
-        $download = $this->download_package( $options['package'], true );
+        $download = $this->download_package( $options['package'], true, $options['hook_extra'] );
 
         // Allow for signature soft-fail.