WP_Upgrader::download_package( string $package, bool $check_signatures = false, array $hook_extra = array() ): string|WP_Error
Download a package.
Parameters
-
$package
string Required -
The URI of the package. If this is the full path to an existing local file, it will be returned untouched.
-
$check_signatures
bool Optional -
Whether to validate file signatures.
Default:
false
-
$hook_extra
array Optional -
Extra arguments to pass to the filter hooks.
Default:
array()
Return
string|WP_Error The full path to the downloaded package file, or a WP_Error object.
Source
File: wp-admin/includes/class-wp-upgrader.php
.
View all references
public function download_package( $package, $check_signatures = false, $hook_extra = array() ) {
/**
* Filters whether to return the package.
*
* @since 3.7.0
* @since 5.5.0 Added the `$hook_extra` parameter.
*
* @param bool $reply Whether to bail without returning the package.
* Default false.
* @param string $package The package file name.
* @param WP_Upgrader $upgrader The WP_Upgrader instance.
* @param array $hook_extra Extra arguments passed to hooked filters.
*/
$reply = apply_filters( 'upgrader_pre_download', false, $package, $this, $hook_extra );
if ( false !== $reply ) {
return $reply;
}
if ( ! preg_match( '!^(http|https|ftp)://!i', $package ) && file_exists( $package ) ) { // Local file or remote?
return $package; // Must be a local file.
}
if ( empty( $package ) ) {
return new WP_Error( 'no_package', $this->strings['no_package'] );
}
$this->skin->feedback( 'downloading_package', $package );
$download_file = download_url( $package, 300, $check_signatures );
if ( is_wp_error( $download_file ) && ! $download_file->get_error_data( 'softfail-filename' ) ) {
return new WP_Error( 'download_failed', $this->strings['download_failed'], $download_file->get_error_message() );
}
return $download_file;
}
Hooks
-
apply_filters( 'upgrader_pre_download',
bool $reply ,string $package ,WP_Upgrader $upgrader ,array $hook_extra ) -
Filters whether to return the package.
Changelog
Version | Description |
---|---|
5.5.0 | Added the $hook_extra parameter. |
5.2.0 | Added the $check_signatures parameter. |
2.8.0 | Introduced. |