wp_get_plugin_action_button( string $name, array|object $data, bool $compatible_php, bool $compatible_wp ): string

Parameters

$namestring

Plugin name.

$dataarray|object

An array or object of plugin data. Can be retrieved from the API.

• $slugstring

  The plugin slug.

• $requires_pluginsstring[]

  An array of plugin dependency slugs.

• $versionstring

  The plugin's version string. Used when getting the install status.

$compatible_phpbool

The result of a PHP compatibility check.

$compatible_wpbool

The result of a WP compatibility check.

Return

string

The markup for the dependency row button. An empty string if the user does not have capabilities.

Uses · 13

• install_plugin_install_status()Determines the status we can perform on a plugin.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• get_option()Retrieves an option value based on an option name.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• current_user_can()Returns whether the current user has the specified capability.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.
• _x()Retrieves translated string with gettext context.
• is_plugin_active()Determines whether a plugin is active.
• add_query_arg()Retrieves a modified URL query string.
• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• network_admin_url()Retrieves the URL to the admin area for the network.

Used by · 2

• WP_Plugin_Install_List_Table::display_rows()Generates the list table rows.
• install_plugin_information()Displays plugin information in dialog box form.

Source

View on Trac ↗View on GitHub ↗

909function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) {910	$button           = '';911	$data             = (object) $data;912	$status           = install_plugin_install_status( $data );913	$requires_plugins = $data->requires_plugins ?? array();914 915	// Determine the status of plugin dependencies.916	$installed_plugins                   = get_plugins();917	$active_plugins                      = get_option( 'active_plugins', array() );918	$plugin_dependencies_count           = count( $requires_plugins );919	$installed_plugin_dependencies_count = 0;920	$active_plugin_dependencies_count    = 0;921	foreach ( $requires_plugins as $dependency ) {922		foreach ( array_keys( $installed_plugins ) as $installed_plugin_file ) {923			if ( str_contains( $installed_plugin_file, '/' ) && explode( '/', $installed_plugin_file )[0] === $dependency ) {924				++$installed_plugin_dependencies_count;925			}926		}927 928		foreach ( $active_plugins as $active_plugin_file ) {929			if ( str_contains( $active_plugin_file, '/' ) && explode( '/', $active_plugin_file )[0] === $dependency ) {930				++$active_plugin_dependencies_count;931			}932		}933	}934	$all_plugin_dependencies_installed = $installed_plugin_dependencies_count === $plugin_dependencies_count;935	$all_plugin_dependencies_active    = $active_plugin_dependencies_count === $plugin_dependencies_count;936 937	if ( current_user_can( 'install_plugins' ) || current_user_can( 'update_plugins' ) ) {938		switch ( $status['status'] ) {939			case 'install':940				if ( $status['url'] ) {941					if ( $compatible_php && $compatible_wp && $all_plugin_dependencies_installed && ! empty( $data->download_link ) ) {942						$button = sprintf(943							'<a class="install-now button" data-slug="%s" href="%s" aria-label="%s" data-name="%s" role="button">%s</a>',944							esc_attr( $data->slug ),945							esc_url( $status['url'] ),946							/* translators: %s: Plugin name and version. */947							esc_attr( sprintf( _x( 'Install %s now', 'plugin' ), $name ) ),948							esc_attr( $name ),949							_x( 'Install Now', 'plugin' )950						);951					} else {952						$button = sprintf(953							'<button type="button" class="install-now button button-disabled" disabled="disabled">%s</button>',954							_x( 'Install Now', 'plugin' )955						);956					}957				}958				break;959 960			case 'update_available':961				if ( $status['url'] ) {962					if ( $compatible_php && $compatible_wp ) {963						$button = sprintf(964							'<a class="update-now button aria-button-if-js" data-plugin="%s" data-slug="%s" href="%s" aria-label="%s" data-name="%s" role="button">%s</a>',965							esc_attr( $status['file'] ),966							esc_attr( $data->slug ),967							esc_url( $status['url'] ),968							/* translators: %s: Plugin name and version. */969							esc_attr( sprintf( _x( 'Update %s now', 'plugin' ), $name ) ),970							esc_attr( $name ),971							_x( 'Update Now', 'plugin' )972						);973					} else {974						$button = sprintf(975							'<button type="button" class="button button-disabled" disabled="disabled">%s</button>',976							_x( 'Update Now', 'plugin' )977						);978					}979				}980				break;981 982			case 'latest_installed':983			case 'newer_installed':984				if ( is_plugin_active( $status['file'] ) ) {985					$button = sprintf(986						'<button type="button" class="button button-disabled" disabled="disabled">%s</button>',987						_x( 'Active', 'plugin' )988					);

History

Introduced in 6.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/plugin-install.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.