W3cubDocs

/WordPress

wp_plugin_update_row( string $file, array $plugin_data )

Displays update information for a plugin.

Parameters

$file

(string) (Required) Plugin basename.

$plugin_data

(array) (Required) Plugin information.

Return

(void|false)

Source

File: wp-admin/includes/update.php 

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 );
	$details_url = self_admin_url( 'plugin-install.php?tab=plugin-information&plugin=' . $response->slug . '&section=changelog&TB_iframe=true&width=600&height=800' );

	/** @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( $response->slug . '-update' ),
			esc_attr( $response->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 doesn&#8217;t 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.
		 *
		 *     @type string $name        The human-readable name of the plugin.
		 *     @type string $plugin_uri  Plugin URI.
		 *     @type string $version     Plugin version.
		 *     @type string $description Plugin description.
		 *     @type string $author      Plugin author.
		 *     @type string $author_uri  Plugin author URI.
		 *     @type string $text_domain Plugin text domain.
		 *     @type string $domain_path Relative path to the plugin's .mo file(s).
		 *     @type bool   $network     Whether the plugin can only be activated network wide.
		 *     @type string $title       The human-readable title of the plugin.
		 *     @type string $author_name Plugin author's name.
		 *     @type bool   $update      Whether there's an available update. Default null.
		 * }
		 * @param array $response {
		 *     An array of metadata about the available plugin update.
		 *
		 *     @type int    $id          Plugin ID.
		 *     @type string $slug        Plugin slug.
		 *     @type string $new_version New plugin version.
		 *     @type string $url         Plugin URL.
		 *     @type string $package     Plugin update package URL.
		 * }
		 */
		do_action( "in_plugin_update_message-{$file}", $plugin_data, $response ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

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

Uses

Uses Description
wp-includes/functions.php: is_php_version_compatible()

Checks compatibility with the current PHP version.
wp-includes/functions.php: wp_get_update_php_url()

Gets the URL to learn more about updating the PHP version the site is running on.
wp-includes/functions.php: wp_update_php_annotation()

Prints the default annotation for the web host altering the “Update PHP” page URL.
wp-admin/includes/screen.php: get_current_screen()

Get the current screen object
wp-admin/includes/class-wp-list-table.php: WP_List_Table::get_column_count()

Returns the number of visible columns.
wp-admin/includes/update.php: in_plugin_update_message-{$file}

Fires at the end of the update message container in each row of the plugins list table.
wp-admin/includes/plugin.php: is_plugin_active_for_network()

Determines whether the plugin is active for the entire network.
wp-admin/includes/plugin.php: is_plugin_active()

Determines whether a plugin is active.
wp-admin/includes/list-table.php: _get_list_table()

Fetches an instance of a WP_List_Table class.
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/l10n.php: _x()

Retrieve translated string with gettext context.
wp-includes/formatting.php: esc_attr()

Escaping for HTML attributes.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/kses.php: wp_kses()

Filters text content and strips out disallowed HTML.
wp-includes/load.php: is_network_admin()

Whether the current request is for the network administrative interface.
wp-includes/load.php: is_multisite()

If Multisite is enabled.
wp-includes/functions.php: wp_nonce_url()

Retrieve URL with nonce added to URL query.
wp-includes/link-template.php: self_admin_url()

Retrieves the URL to the admin area for either the current site or the network depending on context.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: get_site_transient()

Retrieves the value of a site transient.

Changelog

Version Description
2.3.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_plugin_update_row