wp_theme_update_row()

💡 云策文档标注

概述

wp_theme_update_row() 函数用于在主题列表表格中显示主题的更新信息。它检查主题是否有可用更新，并根据用户权限和系统兼容性输出相应的更新提示和操作链接。

关键要点

函数接受两个参数：$theme_key（主题样式表名称）和 $theme（WP_Theme 对象），返回 void 或 false。
通过 get_site_transient('update_themes') 获取主题更新数据，若无更新则返回 false。
根据用户权限（如 update_themes）和兼容性（WordPress 和 PHP 版本）动态生成更新消息，包括查看详情和更新链接。
使用 Hook do_action("in_theme_update_message-{$theme_key}", $theme, $response) 允许开发者自定义更新消息。
依赖多个辅助函数，如 is_wp_version_compatible()、current_user_can() 和 esc_url() 等。

代码示例

function wp_theme_update_row( $theme_key, $theme ) {
    $current = get_site_transient( 'update_themes' );
    if ( ! isset( $current->response[ $theme_key ] ) ) {
        return false;
    }
    // 更多代码处理更新显示逻辑
}

注意事项

此函数主要用于后台主题管理界面，开发者可钩入 in_theme_update_message-{$theme_key} 来自定义消息。
确保传递正确的 $theme_key 和 $theme 参数，否则可能无法正确显示更新信息。

📄 原文内容

Displays update information for a theme.

Parameters

$theme_keystringrequired: Theme stylesheet.
$themeWP_Themerequired: Theme object.

Return

void|false

Source

function wp_theme_update_row( $theme_key, $theme ) {
	$current = get_site_transient( 'update_themes' );

	if ( ! isset( $current->response[ $theme_key ] ) ) {
		return false;
	}

	$response = $current->response[ $theme_key ];

	$details_url = add_query_arg(
		array(
			'TB_iframe' => 'true',
			'width'     => 1024,
			'height'    => 800,
		),
		$current->response[ $theme_key ]['url']
	);

	/** @var WP_MS_Themes_List_Table $wp_list_table */
	$wp_list_table = _get_list_table( 'WP_MS_Themes_List_Table' );

	$active = $theme->is_allowed( 'network' ) ? ' active' : '';

	$requires_wp  = isset( $response['requires'] ) ? $response['requires'] : null;
	$requires_php = isset( $response['requires_php'] ) ? $response['requires_php'] : null;

	$compatible_wp  = is_wp_version_compatible( $requires_wp );
	$compatible_php = is_php_version_compatible( $requires_php );

	printf(
		'<tr class="plugin-update-tr%s" id="%s" data-slug="%s">' .
		'<td colspan="%s" class="plugin-update colspanchange">' .
		'<div class="update-message notice inline notice-warning notice-alt"><p>',
		$active,
		esc_attr( $theme->get_stylesheet() . '-update' ),
		esc_attr( $theme->get_stylesheet() ),
		$wp_list_table->get_column_count()
	);

	if ( $compatible_wp && $compatible_php ) {
		if ( ! current_user_can( 'update_themes' ) ) {
			printf(
				/* translators: 1: Theme name, 2: Details URL, 3: Additional link attributes, 4: Version number. */
				__( 'There is a new version of %1$s available. <a href="%2$s" %3$s>View version %4$s details</a>.' ),
				$theme['Name'],
				esc_url( $details_url ),
				sprintf(
					'class="thickbox open-plugin-details-modal" aria-label="%s"',
					/* translators: 1: Theme name, 2: Version number. */
					esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $theme['Name'], $response['new_version'] ) )
				),
				$response['new_version']
			);
		} elseif ( empty( $response['package'] ) ) {
			printf(
				/* translators: 1: Theme name, 2: Details URL, 3: Additional link attributes, 4: Version number. */
				__( 'There is a new version of %1$s available. <a href="%2$s" %3$s>View version %4$s details</a>. <em>Automatic update is unavailable for this theme.</em>' ),
				$theme['Name'],
				esc_url( $details_url ),
				sprintf(
					'class="thickbox open-plugin-details-modal" aria-label="%s"',
					/* translators: 1: Theme name, 2: Version number. */
					esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $theme['Name'], $response['new_version'] ) )
				),
				$response['new_version']
			);
		} else {
			printf(
				/* translators: 1: Theme name, 2: Details URL, 3: Additional link attributes, 4: Version number, 5: Update URL, 6: Additional link attributes. */
				__( 'There is a new version of %1$s available. <a href="%2$s" %3$s>View version %4$s details</a> or <a href="%5$s" %6$s>update now</a>.' ),
				$theme['Name'],
				esc_url( $details_url ),
				sprintf(
					'class="thickbox open-plugin-details-modal" aria-label="%s"',
					/* translators: 1: Theme name, 2: Version number. */
					esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $theme['Name'], $response['new_version'] ) )
				),
				$response['new_version'],
				wp_nonce_url( self_admin_url( 'update.php?action=upgrade-theme&theme;=' ) . $theme_key, 'upgrade-theme_' . $theme_key ),
				sprintf(
					'class="update-link" aria-label="%s"',
					/* translators: %s: Theme name. */
					esc_attr( sprintf( _x( 'Update %s now', 'theme' ), $theme['Name'] ) )
				)
			);
		}
	} else {
		if ( ! $compatible_wp && ! $compatible_php ) {
			printf(
				/* translators: %s: Theme name. */
				__( 'There is a new version of %s available, but it does not work with your versions of WordPress and PHP.' ),
				$theme['Name']
			);
			if ( current_user_can( 'update_core' ) && current_user_can( 'update_php' ) ) {
				printf(
					/* translators: 1: URL to WordPress Updates screen, 2: URL to Update PHP page. */
					' ' . __( '<a href="%1$s">Please update WordPress</a>, and then <a href="%2$s">learn more about updating PHP</a>.' ),
					self_admin_url( 'update-core.php' ),
					esc_url( wp_get_update_php_url() )
				);
				wp_update_php_annotation( '</p><p><em>', '</em>' );
			} elseif ( current_user_can( 'update_core' ) ) {
				printf(
					/* translators: %s: URL to WordPress Updates screen. */
					' ' . __( '<a href="%s">Please update WordPress</a>.' ),
					self_admin_url( 'update-core.php' )
				);
			} elseif ( current_user_can( 'update_php' ) ) {
				printf(
					/* translators: %s: URL to Update PHP page. */
					' ' . __( '<a href="%s">Learn more about updating PHP</a>.' ),
					esc_url( wp_get_update_php_url() )
				);
				wp_update_php_annotation( '</p><p><em>', '</em>' );
			}
		} elseif ( ! $compatible_wp ) {
			printf(
				/* translators: %s: Theme name. */
				__( 'There is a new version of %s available, but it does not work with your version of WordPress.' ),
				$theme['Name']
			);
			if ( current_user_can( 'update_core' ) ) {
				printf(
					/* translators: %s: URL to WordPress Updates screen. */
					' ' . __( '<a href="%s">Please update WordPress</a>.' ),
					self_admin_url( 'update-core.php' )
				);
			}
		} elseif ( ! $compatible_php ) {
			printf(
				/* translators: %s: Theme name. */
				__( 'There is a new version of %s available, but it does not work with your version of PHP.' ),
				$theme['Name']
			);
			if ( current_user_can( 'update_php' ) ) {
				printf(
					/* translators: %s: URL to Update PHP page. */
					' ' . __( '<a href="%s">Learn more about updating PHP</a>.' ),
					esc_url( wp_get_update_php_url() )
				);
				wp_update_php_annotation( '</p><p><em>', '</em>' );
			}
		}
	}

	/**
	 * Fires at the end of the update message container in each
	 * row of the themes list table.
	 *
	 * The dynamic portion of the hook name, `$theme_key`, refers to
	 * the theme slug as found in the WordPress.org themes repository.
	 *
	 * @since 3.1.0
	 *
	 * @param WP_Theme $theme    The WP_Theme object.
	 * @param array    $response {
	 *     An array of metadata about the available theme update.
	 *
	 *     @type string $new_version New theme version.
	 *     @type string $url         Theme URL.
	 *     @type string $package     Theme update package URL.
	 * }
	 */
	do_action( "in_theme_update_message-{$theme_key}", $theme, $response ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

	echo '</p></div></td></tr>';
}

View all references View on Trac View on GitHub

Hooks

do_action( “in_theme_update_message-{$theme_key}”, WP_Theme $theme, array $response ): Fires at the end of the update message container in each row of the themes list table.

Uses	Description
is_wp_version_compatible()`wp-includes/functions.php`	Checks compatibility with the current WordPress version.
is_php_version_compatible()`wp-includes/functions.php`	Checks compatibility with the current PHP version.
wp_get_update_php_url()`wp-includes/functions.php`	Gets the URL to learn more about updating the PHP version the site is running on.
wp_update_php_annotation()`wp-includes/functions.php`	Prints the default annotation for the web host altering the “Update PHP” page URL.
WP_List_Table::get_column_count()`wp-admin/includes/class-wp-list-table.php`	Returns the number of visible columns.
_get_list_table()`wp-admin/includes/list-table.php`	Fetches an instance of a WP_List_Table class.
self_admin_url()`wp-includes/link-template.php`	Retrieves the URL to the admin area for either the current site or the network depending on context.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
_x()`wp-includes/l10n.php`	Retrieves translated string with gettext context.
esc_attr()`wp-includes/formatting.php`	Escaping for HTML attributes.
esc_url()`wp-includes/formatting.php`	Checks and cleans a URL.
wp_nonce_url()`wp-includes/functions.php`	Retrieves URL with nonce added to URL query.
add_query_arg()`wp-includes/functions.php`	Retrieves a modified URL query string.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
get_site_transient()`wp-includes/option.php`	Retrieves the value of a site transient.

Show 11 more Show less

Changelog

Version	Description
3.1.0	Introduced.

云策 WordPress 开发者社区

函数文档

wp_theme_update_row()

概述

关键要点

代码示例

注意事项

Parameters

Return

Source

Hooks

Changelog

函数文档

概述

关键要点

代码示例

注意事项

Parameters

Return

Source

Hooks

Related

Changelog