类文档

Theme_Upgrader_Skin

💡 云策文档标注

概述

Theme_Upgrader_Skin 是 WordPress 主题升级过程中使用的皮肤类,继承自 WP_Upgrader_Skin,用于自定义主题更新后的用户界面和操作。它主要处理单个主题更新后的动作链接生成和显示。

关键要点

  • 继承自 WP_Upgrader_Skin,专为主题升级设计,提供特定于主题的皮肤功能。
  • 包含构造函数 __construct,用于设置主题升级皮肤参数,如主题 slug 和默认选项。
  • 包含 after 方法,在单个主题更新后执行,生成激活、预览等动作链接,并应用 update_theme_complete_actions 过滤器。
  • 使用 $theme 属性存储主题目录中的主题 slug,便于后续操作。
  • 支持自定义动作链接,如跳转到主题页面、激活主题或实时预览,根据用户权限和当前主题状态动态调整。

代码示例

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

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

    parent::__construct( $args );
}

注意事项

  • 该类自 WordPress 2.8.0 引入,4.6.0 版本后移至独立文件,使用时需确保兼容性。
  • after 方法中生成的链接依赖于 upgrader 对象和主题信息,需确保这些数据在升级过程中正确传递。
  • 动作链接可通过 update_theme_complete_actions 过滤器进行自定义,开发者可扩展或修改默认行为。

📄 原文内容

Theme Upgrader Skin for WordPress Theme Upgrades.

Description

See also

Methods

Name Description
Theme_Upgrader_Skin::__construct Constructor.
Theme_Upgrader_Skin::after Performs an action following a single theme update.

Source

class Theme_Upgrader_Skin extends WP_Upgrader_Skin {

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

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

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

		parent::__construct( $args );
	}

	/**
	 * Performs an action following a single theme update.
	 *
	 * @since 2.8.0
	 */
	public function after() {
		$this->decrement_update_count( 'theme' );

		$update_actions = array();
		$theme_info     = $this->upgrader->theme_info();
		if ( $theme_info ) {
			$name       = $theme_info->display( 'Name' );
			$stylesheet = $this->upgrader->result['destination_name'];
			$template   = $theme_info->get_template();

			$activate_link = add_query_arg(
				array(
					'action'     => 'activate',
					'template'   => urlencode( $template ),
					'stylesheet' => urlencode( $stylesheet ),
				),
				admin_url( 'themes.php' )
			);
			$activate_link = wp_nonce_url( $activate_link, 'switch-theme_' . $stylesheet );

			$customize_url = add_query_arg(
				array(
					'theme'  => urlencode( $stylesheet ),
					'return' => urlencode( admin_url( 'themes.php' ) ),
				),
				admin_url( 'customize.php' )
			);

			if ( get_stylesheet() === $stylesheet ) {
				if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) {
					$update_actions['preview'] = sprintf(
						'<a href="%s" class="hide-if-no-customize load-customize">' .
						'<span aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></a>',
						esc_url( $customize_url ),
						__( 'Customize' ),
						/* translators: Hidden accessibility text. %s: Theme name. */
						sprintf( __( 'Customize “%s”' ), $name )
					);
				}
			} elseif ( current_user_can( 'switch_themes' ) ) {
				if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) {
					$update_actions['preview'] = sprintf(
						'<a href="%s" class="hide-if-no-customize load-customize">' .
						'<span aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></a>',
						esc_url( $customize_url ),
						__( 'Live Preview' ),
						/* translators: Hidden accessibility text. %s: Theme name. */
						sprintf( __( 'Live Preview “%s”' ), $name )
					);
				}

				$update_actions['activate'] = sprintf(
					'<a href="%s" class="activatelink">' .
					'<span aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></a>',
					esc_url( $activate_link ),
					_x( 'Activate', 'theme' ),
					/* translators: Hidden accessibility text. %s: Theme name. */
					sprintf( _x( 'Activate “%s”', 'theme' ), $name )
				);
			}

			if ( ! $this->result || is_wp_error( $this->result ) || is_network_admin() ) {
				unset( $update_actions['preview'], $update_actions['activate'] );
			}
		}

		$update_actions['themes_page'] = sprintf(
			'<a href="%s" target="_parent">%s</a>',
			self_admin_url( 'themes.php' ),
			__( 'Go to Themes page' )
		);

		/**
		 * Filters the list of action links available following a single theme update.
		 *
		 * @since 2.8.0
		 *
		 * @param string[] $update_actions Array of theme action links.
		 * @param string   $theme          Theme directory name.
		 */
		$update_actions = apply_filters( 'update_theme_complete_actions', $update_actions, $this->theme );

		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.