类文档

Plugin_Upgrader_Skin

💡 云策文档标注

概述

Plugin_Upgrader_Skin 是 WordPress 中用于插件升级的皮肤类,继承自 WP_Upgrader_Skin,提供特定于插件升级的界面和功能。

关键要点

  • 继承自 WP_Upgrader_Skin,专为插件升级设计
  • 包含属性如 $plugin、$plugin_active 和 $plugin_network_active 来管理插件状态
  • 提供 __construct 构造函数用于初始化插件信息
  • after 方法在单个插件更新后执行操作,包括激活链接和过滤器应用

代码示例

public function __construct( $args = array() ) {
    $defaults = array(
        'url'    => '',
        'plugin' => '',
        'nonce'  => '',
        'title'  => __( 'Update Plugin' ),
    );
    $args     = wp_parse_args( $args, $defaults );

    $this->plugin = $args['plugin'];

    $this->plugin_active         = is_plugin_active( $this->plugin );
    $this->plugin_network_active = is_plugin_active_for_network( $this->plugin );

    parent::__construct( $args );
}

注意事项

  • 使用 update_plugin_complete_actions 过滤器可自定义更新后的操作链接
  • after 方法会根据插件状态和用户权限动态调整激活链接

📄 原文内容

Plugin Upgrader Skin for WordPress Plugin Upgrades.

Description

See also

Methods

Name Description
Plugin_Upgrader_Skin::__construct Constructor.
Plugin_Upgrader_Skin::after Performs an action following a single plugin update.

Source

class Plugin_Upgrader_Skin extends WP_Upgrader_Skin {

	/**
	 * Holds the plugin slug in the Plugin Directory.
	 *
	 * @since 2.8.0
	 *
	 * @var string
	 */
	public $plugin = '';

	/**
	 * Whether the plugin is active.
	 *
	 * @since 2.8.0
	 *
	 * @var bool
	 */
	public $plugin_active = false;

	/**
	 * Whether the plugin is active for the entire network.
	 *
	 * @since 2.8.0
	 *
	 * @var bool
	 */
	public $plugin_network_active = false;

	/**
	 * Constructor.
	 *
	 * Sets up the plugin upgrader skin.
	 *
	 * @since 2.8.0
	 *
	 * @param array $args Optional. The plugin upgrader skin arguments to
	 *                    override default options. Default empty array.
	 */
	public function __construct( $args = array() ) {
		$defaults = array(
			'url'    => '',
			'plugin' => '',
			'nonce'  => '',
			'title'  => __( 'Update Plugin' ),
		);
		$args     = wp_parse_args( $args, $defaults );

		$this->plugin = $args['plugin'];

		$this->plugin_active         = is_plugin_active( $this->plugin );
		$this->plugin_network_active = is_plugin_active_for_network( $this->plugin );

		parent::__construct( $args );
	}

	/**
	 * Performs an action following a single plugin update.
	 *
	 * @since 2.8.0
	 */
	public function after() {
		$this->plugin = $this->upgrader->plugin_info();
		if ( ! empty( $this->plugin ) && ! is_wp_error( $this->result ) && $this->plugin_active ) {
			// Currently used only when JS is off for a single plugin update?
			printf(
				'<iframe title="%s" style="border:0;overflow:hidden" width="100%%" height="170" src="%s"></iframe>',
				esc_attr__( 'Update progress' ),
				wp_nonce_url( 'update.php?action=activate-plugin&networkwide;=' . $this->plugin_network_active . '&plugin;=' . urlencode( $this->plugin ), 'activate-plugin_' . $this->plugin )
			);
		}

		$this->decrement_update_count( 'plugin' );

		$update_actions = array(
			'activate_plugin' => sprintf(
				'<a href="%s" target="_parent">%s</a>',
				wp_nonce_url( 'plugins.php?action=activate&plugin=' . urlencode( $this->plugin ), 'activate-plugin_' . $this->plugin ),
				__( 'Activate Plugin' )
			),
			'plugins_page'    => sprintf(
				'<a href="%s" target="_parent">%s</a>',
				self_admin_url( 'plugins.php' ),
				__( 'Go to Plugins page' )
			),
		);

		if ( $this->plugin_active || ! $this->result || is_wp_error( $this->result ) || ! current_user_can( 'activate_plugin', $this->plugin ) ) {
			unset( $update_actions['activate_plugin'] );
		}

		/**
		 * Filters the list of action links available following a single plugin update.
		 *
		 * @since 2.7.0
		 *
		 * @param string[] $update_actions Array of plugin action links.
		 * @param string   $plugin         Path to the plugin file relative to the plugins directory.
		 */
		$update_actions = apply_filters( 'update_plugin_complete_actions', $update_actions, $this->plugin );

		if ( ! empty( $update_actions ) ) {
			$this->feedback( implode( ' | ', (array) $update_actions ) );
		}
	}
}

Changelog

Version Description
4.6.0 Moved to its own file from wp-admin/includes/class-wp-upgrader-skins.php.
2.8.0 Introduced.