deactivated_plugins_notice()

Description

Compatibility

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

Performance profile

How much work a call to deactivated_plugins_notice() 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 stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

4–57

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

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

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 · 20 distinct outcomes

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

Uses · 10

• current_user_can()Returns whether the current user has the specified capability.
• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.
• is_multisite()Determines whether Multisite is enabled.
• get_site_option()Retrieve an option value for the current network based on name of option.
• update_site_option()Updates the value of an option that was already added for the current network.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• admin_url()Retrieves the URL to the admin area for the current site.
• wp_admin_notice()Outputs an admin notice.

Source code

View on Trac ↗View on GitHub ↗

2594function deactivated_plugins_notice() {2595	if ( 'plugins.php' === $GLOBALS['pagenow'] ) {2596		return;2597	}2598 2599	if ( ! current_user_can( 'activate_plugins' ) ) {2600		return;2601	}2602 2603	$blog_deactivated_plugins = get_option( 'wp_force_deactivated_plugins' );2604	$site_deactivated_plugins = array();2605 2606	if ( false === $blog_deactivated_plugins ) {2607		// Option not in database, add an empty array to avoid extra DB queries on subsequent loads.2608		update_option( 'wp_force_deactivated_plugins', array(), false );2609	}2610 2611	if ( is_multisite() ) {2612		$site_deactivated_plugins = get_site_option( 'wp_force_deactivated_plugins' );2613		if ( false === $site_deactivated_plugins ) {2614			// Option not in database, add an empty array to avoid extra DB queries on subsequent loads.2615			update_site_option( 'wp_force_deactivated_plugins', array() );2616		}2617	}2618 2619	if ( empty( $blog_deactivated_plugins ) && empty( $site_deactivated_plugins ) ) {2620		// No deactivated plugins.2621		return;2622	}2623 2624	$deactivated_plugins = array_merge( $blog_deactivated_plugins, $site_deactivated_plugins );2625 2626	foreach ( $deactivated_plugins as $plugin ) {2627		if ( ! empty( $plugin['version_compatible'] ) && ! empty( $plugin['version_deactivated'] ) ) {2628			$explanation = sprintf(2629				/* translators: 1: Name of deactivated plugin, 2: Plugin version deactivated, 3: Current WP version, 4: Compatible plugin version. */2630				__( '%1$s %2$s was deactivated due to incompatibility with WordPress %3$s, please upgrade to %1$s %4$s or later.' ),2631				$plugin['plugin_name'],2632				$plugin['version_deactivated'],2633				$GLOBALS['wp_version'],2634				$plugin['version_compatible']2635			);2636		} else {2637			$explanation = sprintf(2638				/* translators: 1: Name of deactivated plugin, 2: Plugin version deactivated, 3: Current WP version. */2639				__( '%1$s %2$s was deactivated due to incompatibility with WordPress %3$s.' ),2640				$plugin['plugin_name'],2641				! empty( $plugin['version_deactivated'] ) ? $plugin['version_deactivated'] : '',2642				$GLOBALS['wp_version'],2643				$plugin['version_compatible']2644			);2645		}2646 2647		$message = sprintf(2648			'<strong>%s</strong><br>%s</p><p><a href="%s">%s</a>',2649			sprintf(2650				/* translators: %s: Name of deactivated plugin. */2651				__( '%s plugin deactivated during WordPress upgrade.' ),2652				$plugin['plugin_name']2653			),2654			$explanation,2655			esc_url( admin_url( 'plugins.php?plugin_status=inactive' ) ),2656			__( 'Go to the Plugins screen' )2657		);2658		wp_admin_notice( $message, array( 'type' => 'warning' ) );2659	}2660 2661	// Empty the options.2662	update_option( 'wp_force_deactivated_plugins', array(), false );2663	if ( is_multisite() ) {2664		update_site_option( 'wp_force_deactivated_plugins', array() );2665	}2666}

Changelog

Introduced in 5.8.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 7.1.0 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.