validate_plugin_requirements( string $plugin ): true|WP_Error

Description

Parameters

$pluginstring

Path to the plugin file relative to the plugins directory.

Return

true|WP_Error

True if requirements are met, WP_Error on failure.

Uses · 21

• get_plugin_data()Parses the plugin contents to retrieve plugin's metadata.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• wp_get_update_php_url()Gets the URL to learn more about updating the PHP version the site is running on.
• wp_get_update_php_annotation()Returns the default annotation for the web hosting altering the "Update PHP" page URL.
• _x()Retrieves translated string with gettext context.
• get_bloginfo()Retrieves information about the current site.
• is_plugin_inactive()Determines whether the plugin is inactive.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• wp_get_list_item_separator()Retrieves the list item separator based on the locale.

Used by · 1

• activate_plugin()Attempts activation of plugin in a "sandbox" and redirects on success.

Source

View on Trac ↗View on GitHub ↗

1139function validate_plugin_requirements( $plugin ) {1140	$plugin_headers = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );1141 1142	$requirements = array(1143		'requires'         => ! empty( $plugin_headers['RequiresWP'] ) ? $plugin_headers['RequiresWP'] : '',1144		'requires_php'     => ! empty( $plugin_headers['RequiresPHP'] ) ? $plugin_headers['RequiresPHP'] : '',1145		'requires_plugins' => ! empty( $plugin_headers['RequiresPlugins'] ) ? $plugin_headers['RequiresPlugins'] : '',1146	);1147 1148	$compatible_wp  = is_wp_version_compatible( $requirements['requires'] );1149	$compatible_php = is_php_version_compatible( $requirements['requires_php'] );1150 1151	$php_update_message = '</p><p>' . sprintf(1152		/* translators: %s: URL to Update PHP page. */1153		__( '<a href="%s">Learn more about updating PHP</a>.' ),1154		esc_url( wp_get_update_php_url() )1155	);1156 1157	$annotation = wp_get_update_php_annotation();1158 1159	if ( $annotation ) {1160		$php_update_message .= '</p><p><em>' . $annotation . '</em>';1161	}1162 1163	if ( ! $compatible_wp && ! $compatible_php ) {1164		return new WP_Error(1165			'plugin_wp_php_incompatible',1166			'<p>' . sprintf(1167				/* translators: 1: Current WordPress version, 2: Current PHP version, 3: Plugin name, 4: Required WordPress version, 5: Required PHP version. */1168				_x( '<strong>Error:</strong> Current versions of WordPress (%1$s) and PHP (%2$s) do not meet minimum requirements for %3$s. The plugin requires WordPress %4$s and PHP %5$s.', 'plugin' ),1169				get_bloginfo( 'version' ),1170				PHP_VERSION,1171				$plugin_headers['Name'],1172				$requirements['requires'],1173				$requirements['requires_php']1174			) . $php_update_message . '</p>'1175		);1176	} elseif ( ! $compatible_php ) {1177		return new WP_Error(1178			'plugin_php_incompatible',1179			'<p>' . sprintf(1180				/* translators: 1: Current PHP version, 2: Plugin name, 3: Required PHP version. */1181				_x( '<strong>Error:</strong> Current PHP version (%1$s) does not meet minimum requirements for %2$s. The plugin requires PHP %3$s.', 'plugin' ),1182				PHP_VERSION,1183				$plugin_headers['Name'],1184				$requirements['requires_php']1185			) . $php_update_message . '</p>'1186		);1187	} elseif ( ! $compatible_wp ) {1188		return new WP_Error(1189			'plugin_wp_incompatible',1190			'<p>' . sprintf(1191				/* translators: 1: Current WordPress version, 2: Plugin name, 3: Required WordPress version. */1192				_x( '<strong>Error:</strong> Current WordPress version (%1$s) does not meet minimum requirements for %2$s. The plugin requires WordPress %3$s.', 'plugin' ),1193				get_bloginfo( 'version' ),1194				$plugin_headers['Name'],1195				$requirements['requires']1196			) . '</p>'1197		);1198	}1199 1200	WP_Plugin_Dependencies::initialize();1201 1202	if ( WP_Plugin_Dependencies::has_unmet_dependencies( $plugin ) ) {1203		$dependency_names       = WP_Plugin_Dependencies::get_dependency_names( $plugin );1204		$unmet_dependencies     = array();1205		$unmet_dependency_names = array();1206 1207		foreach ( $dependency_names as $dependency => $dependency_name ) {1208			$dependency_file = WP_Plugin_Dependencies::get_dependency_filepath( $dependency );1209 1210			if ( false === $dependency_file ) {1211				$unmet_dependencies['not_installed'][ $dependency ] = $dependency_name;1212				$unmet_dependency_names[]                           = $dependency_name;1213			} elseif ( is_plugin_inactive( $dependency_file ) ) {1214				$unmet_dependencies['inactive'][ $dependency ] = $dependency_name;1215				$unmet_dependency_names[]                      = $dependency_name;1216			}1217		}1218

History

Introduced in 5.2.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.7.7 tag, from src/wp-admin/includes/plugin.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.