validate_plugin() WordPress Function

The validate_plugin() function is used to check whether a plugin is valid or not. This function is important because it helps to ensure that only valid plugins are installed on a WordPress site. The function takes two parameters: the plugin folder and the plugin file. If the plugin folder and file are both valid, then the function will return true. Otherwise, it will return false.

validate_plugin( string $plugin ) #

Validates the plugin path.


Description

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


Top ↑

Parameters

$plugin

(string)(Required)Path to the plugin file relative to the plugins directory.


Top ↑

Return

(int|WP_Error) 0 on success, WP_Error on failure.


Top ↑

Source

File: wp-admin/includes/plugin.php

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;
}


Top ↑

Changelog

Changelog
VersionDescription
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.