validate_plugin( string $plugin ): int|WP_Error

Description

Parameters

$pluginstring

Path to the plugin file relative to the plugins directory.

Return

int|WP_Error

0 on success, WP_Error on failure.

Uses · 4

• validate_file()Validates a file name and path against an allowed set of rules.
• __()Retrieves the translation of $text.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• WP_Error::__construct()Initializes the error.

Used by · 2

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

Source

View on Trac ↗View on GitHub ↗

1109function validate_plugin( $plugin ) {1110	if ( validate_file( $plugin ) ) {1111		return new WP_Error( 'plugin_invalid', __( 'Invalid plugin path.' ) );1112	}1113	if ( ! file_exists( WP_PLUGIN_DIR . '/' . $plugin ) ) {1114		return new WP_Error( 'plugin_not_found', __( 'Plugin file does not exist.' ) );1115	}1116 1117	$installed_plugins = get_plugins();1118	if ( ! isset( $installed_plugins[ $plugin ] ) ) {1119		return new WP_Error( 'no_plugin_header', __( 'The plugin does not have a valid header.' ) );1120	}1121	return 0;1122}

History

Introduced in 2.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.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.