Language_Pack_Upgrader_Skin
云策文档标注
概述
Language_Pack_Upgrader_Skin 是 WordPress 中用于处理语言包更新的皮肤类,继承自 WP_Upgrader_Skin,专门为翻译升级过程提供自定义界面和行为。
关键要点
- 继承自 WP_Upgrader_Skin,用于语言包更新的皮肤实现
- 包含构造函数、更新前后动作、错误处理和批量更新页脚等方法
- 支持通过 skip_header_footer 参数控制头部和页脚显示
- 使用 update_translations_complete_actions 过滤器自定义更新后动作链接
代码示例
class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin {
public $language_update = null;
public $done_header = false;
public $done_footer = false;
public $display_footer_actions = true;
public function __construct( $args = array() ) {
$defaults = array(
'url' => '',
'nonce' => '',
'title' => __( 'Update Translations' ),
'skip_header_footer' => false,
);
$args = wp_parse_args( $args, $defaults );
if ( $args['skip_header_footer'] ) {
$this->done_header = true;
$this->done_footer = true;
$this->display_footer_actions = false;
}
parent::__construct( $args );
}
public function before() {
$name = $this->upgrader->get_name_for_update( $this->language_update );
printf( '' . __( 'Updating translations for %1$s (%2$s)…' ) . '', $name, $this->language_update->language );
}
public function error( $errors ) {
echo '';
parent::error( $errors );
echo '';
}
public function after() {
echo '';
}
public function bulk_footer() {
$this->decrement_update_count( 'translation' );
$update_actions = array(
'updates_page' => sprintf(
'%s',
self_admin_url( 'update-core.php' ),
__( 'Go to WordPress Updates page' )
),
);
$update_actions = apply_filters( 'update_translations_complete_actions', $update_actions );
if ( $update_actions && $this->display_footer_actions ) {
$this->feedback( implode( ' | ', $update_actions ) );
}
}
}注意事项
- 该类自 WordPress 3.7.0 引入,4.6.0 版本移至独立文件
- error 方法在 5.9.0 版本将参数名从 $error 改为 $errors 以支持 PHP 8 命名参数
- 主要用于后台更新界面,开发者可扩展或直接使用以自定义翻译更新流程
原文内容
Translation Upgrader Skin for WordPress Translation Upgrades.
Description
See also
Methods
| Name | Description |
|---|---|
| Language_Pack_Upgrader_Skin::__construct | Constructor. |
| Language_Pack_Upgrader_Skin::after | Performs an action following a language pack update. |
| Language_Pack_Upgrader_Skin::before | Performs an action before a language pack update. |
| Language_Pack_Upgrader_Skin::bulk_footer | Displays the footer following the bulk update process. |
| Language_Pack_Upgrader_Skin::error | Displays an error message about the update. |
Source
class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin {
public $language_update = null;
public $done_header = false;
public $done_footer = false;
public $display_footer_actions = true;
/**
* Constructor.
*
* Sets up the language pack upgrader skin.
*
* @since 3.7.0
*
* @param array $args
*/
public function __construct( $args = array() ) {
$defaults = array(
'url' => '',
'nonce' => '',
'title' => __( 'Update Translations' ),
'skip_header_footer' => false,
);
$args = wp_parse_args( $args, $defaults );
if ( $args['skip_header_footer'] ) {
$this->done_header = true;
$this->done_footer = true;
$this->display_footer_actions = false;
}
parent::__construct( $args );
}
/**
* Performs an action before a language pack update.
*
* @since 3.7.0
*/
public function before() {
$name = $this->upgrader->get_name_for_update( $this->language_update );
echo '<div class="update-messages lp-show-latest">';
/* translators: 1: Project name (plugin, theme, or WordPress), 2: Language. */
printf( '<h2>' . __( 'Updating translations for %1$s (%2$s)…' ) . '</h2>', $name, $this->language_update->language );
}
/**
* Displays an error message about the update.
*
* @since 3.7.0
* @since 5.9.0 Renamed `$error` to `$errors` for PHP 8 named parameter support.
*
* @param string|WP_Error $errors Errors.
*/
public function error( $errors ) {
echo '<div class="lp-error">';
parent::error( $errors );
echo '</div>';
}
/**
* Performs an action following a language pack update.
*
* @since 3.7.0
*/
public function after() {
echo '</div>';
}
/**
* Displays the footer following the bulk update process.
*
* @since 3.7.0
*/
public function bulk_footer() {
$this->decrement_update_count( 'translation' );
$update_actions = array(
'updates_page' => sprintf(
'<a href="%s" target="_parent">%s</a>',
self_admin_url( 'update-core.php' ),
__( 'Go to WordPress Updates page' )
),
);
/**
* Filters the list of action links available following a translations update.
*
* @since 3.7.0
*
* @param string[] $update_actions Array of translations update links.
*/
$update_actions = apply_filters( 'update_translations_complete_actions', $update_actions );
if ( $update_actions && $this->display_footer_actions ) {
$this->feedback( implode( ' | ', $update_actions ) );
}
}
}