类文档

Bulk_Theme_Upgrader_Skin

💡 云策文档标注

概述

Bulk_Theme_Upgrader_Skin 是 WordPress 中用于批量主题升级的皮肤类,继承自 Bulk_Upgrader_Skin,提供自定义字符串、前后操作和页脚显示功能。

关键要点

  • 继承自 Bulk_Upgrader_Skin,专门处理批量主题升级的界面反馈
  • 包含 $theme_info 属性,存储主题信息对象(WP_Theme 或 false)
  • 重写 add_strings() 方法以设置更新过程中的字符串,如翻译占位符
  • 重写 before() 和 after() 方法,在批量更新前后执行操作,包括递减更新计数
  • 重写 bulk_footer() 方法,显示更新后的操作链接,并应用 update_bulk_theme_complete_actions 过滤器
  • 自 WordPress 3.0.0 引入,4.6.0 版本移至独立文件

代码示例

class Bulk_Theme_Upgrader_Skin extends Bulk_Upgrader_Skin {
    public $theme_info = false;

    public function add_strings() {
        parent::add_strings();
        $this->upgrader->strings['skin_before_update_header'] = __( 'Updating Theme %1$s (%2$d/%3$d)' );
    }

    public function before( $title = '' ) {
        parent::before( $this->theme_info->display( 'Name' ) );
    }

    public function after( $title = '' ) {
        parent::after( $this->theme_info->display( 'Name' ) );
        $this->decrement_update_count( 'theme' );
    }

    public function bulk_footer() {
        parent::bulk_footer();
        $update_actions = array(
            'themes_page'  => sprintf( '%s', self_admin_url( 'themes.php' ), __( 'Go to Themes page' ) ),
            'updates_page' => sprintf( '%s', self_admin_url( 'update-core.php' ), __( 'Go to WordPress Updates page' ) ),
        );
        if ( ! current_user_can( 'switch_themes' ) && ! current_user_can( 'edit_theme_options' ) ) {
            unset( $update_actions['themes_page'] );
        }
        $update_actions = apply_filters( 'update_bulk_theme_complete_actions', $update_actions, $this->theme_info );
        if ( ! empty( $update_actions ) ) {
            $this->feedback( implode( ' | ', (array) $update_actions ) );
        }
    }
}

注意事项

  • $theme_info 属性由 Theme_Upgrader::bulk_upgrade() 填充,基于 wp_get_theme() 获取主题信息
  • bulk_footer() 中的操作链接会根据用户权限(如 switch_themes 或 edit_theme_options)动态调整
  • 使用 update_bulk_theme_complete_actions 过滤器允许开发者自定义更新后的操作链接

📄 原文内容

Bulk Theme Upgrader Skin for WordPress Theme Upgrades.

Description

See also

Methods

Name Description
Bulk_Theme_Upgrader_Skin::add_strings Sets up the strings used in the update process.
Bulk_Theme_Upgrader_Skin::after Performs an action following a bulk theme update.
Bulk_Theme_Upgrader_Skin::before Performs an action before a bulk theme update.
Bulk_Theme_Upgrader_Skin::bulk_footer Displays the footer following the bulk update process.

Source

class Bulk_Theme_Upgrader_Skin extends Bulk_Upgrader_Skin {

	/**
	 * Theme info.
	 *
	 * The Theme_Upgrader::bulk_upgrade() method will fill this in
	 * with info retrieved from the Theme_Upgrader::theme_info() method,
	 * which in turn calls the wp_get_theme() function.
	 *
	 * @since 3.0.0
	 * @var WP_Theme|false The theme's info object, or false.
	 */
	public $theme_info = false;

	/**
	 * Sets up the strings used in the update process.
	 *
	 * @since 3.0.0
	 */
	public function add_strings() {
		parent::add_strings();
		/* translators: 1: Theme name, 2: Number of the theme, 3: Total number of themes being updated. */
		$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Theme %1$s (%2$d/%3$d)' );
	}

	/**
	 * Performs an action before a bulk theme update.
	 *
	 * @since 3.0.0
	 *
	 * @param string $title
	 */
	public function before( $title = '' ) {
		parent::before( $this->theme_info->display( 'Name' ) );
	}

	/**
	 * Performs an action following a bulk theme update.
	 *
	 * @since 3.0.0
	 *
	 * @param string $title
	 */
	public function after( $title = '' ) {
		parent::after( $this->theme_info->display( 'Name' ) );
		$this->decrement_update_count( 'theme' );
	}

	/**
	 * Displays the footer following the bulk update process.
	 *
	 * @since 3.0.0
	 */
	public function bulk_footer() {
		parent::bulk_footer();

		$update_actions = array(
			'themes_page'  => sprintf(
				'<a href="%s" target="_parent">%s</a>',
				self_admin_url( 'themes.php' ),
				__( 'Go to Themes page' )
			),
			'updates_page' => sprintf(
				'<a href="%s" target="_parent">%s</a>',
				self_admin_url( 'update-core.php' ),
				__( 'Go to WordPress Updates page' )
			),
		);

		if ( ! current_user_can( 'switch_themes' ) && ! current_user_can( 'edit_theme_options' ) ) {
			unset( $update_actions['themes_page'] );
		}

		/**
		 * Filters the list of action links available following bulk theme updates.
		 *
		 * @since 3.0.0
		 *
		 * @param string[] $update_actions Array of theme action links.
		 * @param WP_Theme $theme_info     Theme object for the last-updated theme.
		 */
		$update_actions = apply_filters( 'update_bulk_theme_complete_actions', $update_actions, $this->theme_info );

		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.
3.0.0 Introduced.