wp_get_active_and_valid_plugins(): string[]

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

string[]

Array of paths to plugin files relative to the plugins directory.

Performance profile

How much work a call to wp_get_active_and_valid_plugins() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

13–50

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 81.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• filesystemfilesystem accessfile_exists()called directly
• hookthird-party callbacksapply_filters()one call below wp_get_active_and_valid_plugins()
• cacheobject cachewp_cache_get()one call below wp_get_active_and_valid_plugins()
• serializeserialisationmaybe_unserialize()one call below wp_get_active_and_valid_plugins()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 18 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_active_and_valid_plugins() can have, taken from its control-flow graph on PHP 8.5.

Uses · 9

• get_option()Retrieves an option value based on an option name.
• _deprecated_file()Marks a file as deprecated and inform when it has been used.
• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• is_multisite()Determines whether Multisite is enabled.
• wp_get_active_network_plugins()Returns array of network plugin files to be included in global scope.
• validate_file()Validates a file name and path against an allowed set of rules.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• wp_is_recovery_mode()Determines whether WordPress is in Recovery Mode.
• wp_skip_paused_plugins()Filters a given list of plugins, removing any paused plugins from it.

Used by · 1

• WP_REST_Templates_Controller::get_wp_templates_author_text_field()Returns a human readable text for the author of the template.

Source code

View on Trac ↗View on GitHub ↗

984function wp_get_active_and_valid_plugins() {985	$plugins        = array();986	$active_plugins = (array) get_option( 'active_plugins', array() );987 988	// Check for hacks file if the option is enabled.989	if ( get_option( 'hack_file' ) && file_exists( ABSPATH . 'my-hacks.php' ) ) {990		_deprecated_file( 'my-hacks.php', '1.5.0' );991		array_unshift( $plugins, ABSPATH . 'my-hacks.php' );992	}993 994	if ( empty( $active_plugins ) || wp_installing() ) {995		return $plugins;996	}997 998	$network_plugins = is_multisite() ? wp_get_active_network_plugins() : false;999 1000	foreach ( $active_plugins as $plugin ) {1001		if ( ! validate_file( $plugin )                     // $plugin must validate as file.1002			&& str_ends_with( $plugin, '.php' )             // $plugin must end with '.php'.1003			&& file_exists( WP_PLUGIN_DIR . '/' . $plugin ) // $plugin must exist.1004			// Not already included as a network plugin.1005			&& ( ! $network_plugins || ! in_array( WP_PLUGIN_DIR . '/' . $plugin, $network_plugins, true ) )1006		) {1007			$plugins[] = WP_PLUGIN_DIR . '/' . $plugin;1008		}1009	}1010 1011	/*1012	 * Remove plugins from the list of active plugins when we're on an endpoint1013	 * that should be protected against WSODs and the plugin is paused.1014	 */1015	if ( wp_is_recovery_mode() ) {1016		$plugins = wp_skip_paused_plugins( $plugins );1017	}1018 1019	return $plugins;1020}

Changelog

Introduced in 3.0.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-includes/load.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.