WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

validate_plugin()

validate_plugin( string $plugin ): int|WP_Error

In this article

Back to top

Validates the plugin path.

Description

Checks that the main plugin file exists and is a valid plugin. See validate_file() .

Parameters

$pluginstringrequired
Path to the plugin file relative to the plugins directory.

Return

int|WP_Error 0 on success, WP_Error on failure.

Source

function validate_plugin( $plugin ) {
	if ( validate_file( $plugin ) ) {
		return new WP_Error( 'plugin_invalid', __( 'Invalid plugin path.' ) );
	}
	if ( ! file_exists( WP_PLUGIN_DIR . '/' . $plugin ) ) {
		return new WP_Error( 'plugin_not_found', __( 'Plugin file does not exist.' ) );
	}

	$installed_plugins = get_plugins();
	if ( ! isset( $installed_plugins[ $plugin ] ) ) {
		return new WP_Error( 'no_plugin_header', __( 'The plugin does not have a valid header.' ) );
	}
	return 0;
}

View all references View on Trac View on GitHub

UsesDescription
get_plugins()wp-admin/includes/plugin.php

Checks the plugins directory and retrieve all plugin files with plugin data.

validate_file()wp-includes/functions.php

Validates a file name and path against an allowed set of rules.

__()wp-includes/l10n.php

Retrieves the translation of $text.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 2 moreShow less
Used byDescription
activate_plugin()wp-admin/includes/plugin.php

Attempts activation of plugin in a “sandbox” and redirects on success.

validate_active_plugins()wp-admin/includes/plugin.php

Validates active plugins.

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.