wp_plugin_update_row()

💡 云策文档标注

概述

wp_plugin_update_row() 函数用于在插件列表页面显示插件更新信息，包括版本详情和更新操作链接。它根据插件更新状态和用户权限输出相应的 HTML 内容。

关键要点

函数参数：$file（插件基本名，字符串，必需）和 $plugin_data（插件信息数组，必需）。
返回值：void 或 false（若无更新则返回 false）。
核心逻辑：检查 update_plugins 瞬态中是否有更新，构建详情 URL，并根据用户权限和 PHP 兼容性输出更新消息。
钩子：使用 do_action() 触发 in_plugin_update_message-{$file} 钩子，允许开发者自定义更新消息。
相关函数：涉及 get_site_transient()、wp_kses()、is_php_version_compatible() 等，用于数据处理和安全检查。

代码示例

function wp_plugin_update_row( $file, $plugin_data ) {
    $current = get_site_transient( 'update_plugins' );
    if ( ! isset( $current->response[ $file ] ) ) {
        return false;
    }
    // 更多代码处理更新信息输出
}

注意事项

函数主要用于后台插件管理界面，开发者可钩入 in_plugin_update_message-{$file} 自定义消息显示。
需确保 $plugin_data 包含正确的插件元数据，如 Name 和 PluginURI。
输出内容包含 HTML 和翻译字符串，适合国际化环境。

📄 原文内容

Displays update information for a plugin.

Parameters

$filestringrequired: Plugin basename.
$plugin_dataarrayrequired: Plugin information.

Return

void|false

Source

function wp_plugin_update_row( $file, $plugin_data ) {
	$current = get_site_transient( 'update_plugins' );

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

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

	$plugins_allowedtags = array(
		'a'       => array(
			'href'  => array(),
			'title' => array(),
		),
		'abbr'    => array( 'title' => array() ),
		'acronym' => array( 'title' => array() ),
		'code'    => array(),
		'em'      => array(),
		'strong'  => array(),
	);

	$plugin_name = wp_kses( $plugin_data['Name'], $plugins_allowedtags );
	$plugin_slug = isset( $response->slug ) ? $response->slug : $response->id;

	if ( isset( $response->slug ) ) {
		$details_url = self_admin_url( 'plugin-install.php?tab=plugin-information&plugin;=' . $plugin_slug . '&section;=changelog' );
	} elseif ( isset( $response->url ) ) {
		$details_url = $response->url;
	} else {
		$details_url = $plugin_data['PluginURI'];
	}

	$details_url = add_query_arg(
		array(
			'TB_iframe' => 'true',
			'width'     => 600,
			'height'    => 800,
		),
		$details_url
	);

	/** @var WP_Plugins_List_Table $wp_list_table */
	$wp_list_table = _get_list_table(
		'WP_Plugins_List_Table',
		array(
			'screen' => get_current_screen(),
		)
	);

	if ( is_network_admin() || ! is_multisite() ) {
		if ( is_network_admin() ) {
			$active_class = is_plugin_active_for_network( $file ) ? ' active' : '';
		} else {
			$active_class = is_plugin_active( $file ) ? ' active' : '';
		}

		$requires_php   = isset( $response->requires_php ) ? $response->requires_php : null;
		$compatible_php = is_php_version_compatible( $requires_php );
		$notice_type    = $compatible_php ? 'notice-warning' : 'notice-error';

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

		if ( ! current_user_can( 'update_plugins' ) ) {
			printf(
				/* translators: 1: Plugin 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>.' ),
				$plugin_name,
				esc_url( $details_url ),
				sprintf(
					'class="thickbox open-plugin-details-modal" aria-label="%s"',
					/* translators: 1: Plugin name, 2: Version number. */
					esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $plugin_name, $response->new_version ) )
				),
				esc_attr( $response->new_version )
			);
		} elseif ( empty( $response->package ) ) {
			printf(
				/* translators: 1: Plugin 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 plugin.</em>' ),
				$plugin_name,
				esc_url( $details_url ),
				sprintf(
					'class="thickbox open-plugin-details-modal" aria-label="%s"',
					/* translators: 1: Plugin name, 2: Version number. */
					esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $plugin_name, $response->new_version ) )
				),
				esc_attr( $response->new_version )
			);
		} else {
			if ( $compatible_php ) {
				printf(
					/* translators: 1: Plugin 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>.' ),
					$plugin_name,
					esc_url( $details_url ),
					sprintf(
						'class="thickbox open-plugin-details-modal" aria-label="%s"',
						/* translators: 1: Plugin name, 2: Version number. */
						esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $plugin_name, $response->new_version ) )
					),
					esc_attr( $response->new_version ),
					wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin;=' ) . $file, 'upgrade-plugin_' . $file ),
					sprintf(
						'class="update-link" aria-label="%s"',
						/* translators: %s: Plugin name. */
						esc_attr( sprintf( _x( 'Update %s now', 'plugin' ), $plugin_name ) )
					)
				);
			} else {
				printf(
					/* translators: 1: Plugin name, 2: Details URL, 3: Additional link attributes, 4: Version number 5: URL to Update PHP page. */
					__( 'There is a new version of %1$s available, but it does not work with your version of PHP. <a href="%2$s" %3$s>View version %4$s details</a> or <a href="%5$s">learn more about updating PHP</a>.' ),
					$plugin_name,
					esc_url( $details_url ),
					sprintf(
						'class="thickbox open-plugin-details-modal" aria-label="%s"',
						/* translators: 1: Plugin name, 2: Version number. */
						esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $plugin_name, $response->new_version ) )
					),
					esc_attr( $response->new_version ),
					esc_url( wp_get_update_php_url() )
				);
				wp_update_php_annotation( '<br><em>', '</em>' );
			}
		}

		/**
		 * Fires at the end of the update message container in each
		 * row of the plugins list table.
		 *
		 * The dynamic portion of the hook name, `$file`, refers to the path
		 * of the plugin's primary file relative to the plugins directory.
		 *
		 * @since 2.8.0
		 *
		 * @param array  $plugin_data An array of plugin metadata. See get_plugin_data()
		 *                            and the 'plugin_row_meta' filter for the list
		 *                            of possible values.
		 * @param object $response {
		 *     An object of metadata about the available plugin update.
		 *
		 *     @type string   $id           Plugin ID, e.g. `w.org/plugins/[plugin-name]`.
		 *     @type string   $slug         Plugin slug.
		 *     @type string   $plugin       Plugin basename.
		 *     @type string   $new_version  New plugin version.
		 *     @type string   $url          Plugin URL.
		 *     @type string   $package      Plugin update package URL.
		 *     @type string[] $icons        An array of plugin icon URLs.
		 *     @type string[] $banners      An array of plugin banner URLs.
		 *     @type string[] $banners_rtl  An array of plugin RTL banner URLs.
		 *     @type string   $requires     The version of WordPress which the plugin requires.
		 *     @type string   $tested       The version of WordPress the plugin is tested against.
		 *     @type string   $requires_php The version of PHP which the plugin requires.
		 * }
		 */
		do_action( "in_plugin_update_message-{$file}", $plugin_data, $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_plugin_update_message-{$file}”, array $plugin_data, object $response ): Fires at the end of the update message container in each row of the plugins list table.

Uses	Description
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.
get_current_screen()`wp-admin/includes/screen.php`	Get the current screen object
WP_List_Table::get_column_count()`wp-admin/includes/class-wp-list-table.php`	Returns the number of visible columns.
is_plugin_active_for_network()`wp-admin/includes/plugin.php`	Determines whether the plugin is active for the entire network.
is_plugin_active()`wp-admin/includes/plugin.php`	Determines whether a plugin is active.
_get_list_table()`wp-admin/includes/list-table.php`	Fetches an instance of a WP_List_Table class.
wp_kses()`wp-includes/kses.php`	Filters text content and strips out disallowed HTML.
is_network_admin()`wp-includes/load.php`	Determines whether the current request is for the network administrative interface.
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.
is_multisite()`wp-includes/load.php`	Determines whether Multisite is enabled.
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 16 more Show less

Changelog

Version	Description
2.3.0	Introduced.

云策 WordPress 开发者社区

函数文档

wp_plugin_update_row()

概述

关键要点

代码示例

注意事项

Parameters

Return

Source

Hooks

Changelog

函数文档

概述

关键要点

代码示例

注意事项

Parameters

Return

Source

Hooks

Related

Changelog