[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/includes/ -> class-plugin-upgrader.php (summary)

Upgrade API: Plugin_Upgrader class

File Size: 487 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Plugin_Upgrader:: (9 methods):
  upgrade_strings()
  install_strings()
  install()
  upgrade()
  bulk_upgrade()
  check_package()
  plugin_info()
  deactivate_plugin_before_upgrade()
  delete_old_plugin()


Class: Plugin_Upgrader  - X-Ref

Core class used for upgrading/installing plugins.

It is designed to upgrade/install plugins from a local zip, remote zip URL,
or uploaded zip file.

upgrade_strings()   X-Ref
Initialize the upgrade strings.

since: 2.8.0

install_strings()   X-Ref
Initialize the installation strings.

since: 2.8.0

install( $package, $args = array()   X-Ref
Install a plugin package.

since: 2.8.0
since: 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
param: string $package The full local path or URI of the package.
param: array  $args {
return: bool|WP_Error True if the installation was successful, false or a WP_Error otherwise.

upgrade( $plugin, $args = array()   X-Ref
Upgrade a plugin.

since: 2.8.0
since: 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
param: string $plugin Path to the plugin file relative to the plugins directory.
param: array  $args {
return: bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.

bulk_upgrade( $plugins, $args = array()   X-Ref
Bulk upgrade several plugins at once.

since: 2.8.0
since: 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
param: string[] $plugins Array of paths to plugin files relative to the plugins directory.
param: array    $args {
return: array|false An array of results indexed by plugin file, or false if unable to connect to the filesystem.

check_package( $source )   X-Ref
Check a source package to be sure it contains a plugin.

This function is added to the {@see 'upgrader_source_selection'} filter by
Plugin_Upgrader::install().

since: 3.3.0
param: string $source The path to the downloaded package source.
return: string|WP_Error The source as passed, or a WP_Error object

plugin_info()   X-Ref
Retrieve the path to the file that contains the plugin info.

This isn't used internally in the class, but is called by the skins.

since: 2.8.0
return: string|false The full path to the main plugin file, or false.

deactivate_plugin_before_upgrade( $return, $plugin )   X-Ref
Deactivates a plugin before it is upgraded.

Hooked to the {@see 'upgrader_pre_install'} filter by Plugin_Upgrader::upgrade().

since: 2.8.0
since: 4.1.0 Added a return value.
param: bool|WP_Error  $return Upgrade offer return.
param: array          $plugin Plugin package arguments.
return: bool|WP_Error The passed in $return param or WP_Error.

delete_old_plugin( $removed, $local_destination, $remote_destination, $plugin )   X-Ref
Delete the old plugin during an upgrade.

Hooked to the {@see 'upgrader_clear_destination'} filter by
Plugin_Upgrader::upgrade() and Plugin_Upgrader::bulk_upgrade().

since: 2.8.0
param: bool|WP_Error $removed
param: string        $local_destination
param: string        $remote_destination
param: array         $plugin
return: bool|WP_Error



Generated: Mon Nov 18 01:00:04 2019 Cross-referenced by PHPXref 0.7.1