resume_plugin

Advertisement

Summery Summery

Tries to resume a single plugin.

Syntax Syntax

resume_plugin( string $plugin, string $redirect = '' )

Description Description

If a redirect was provided, we first ensure the plugin does not throw fatal errors anymore.

The way it works is by setting the redirection to the error before trying to include the plugin file. If the plugin fails, then the redirection will not be overwritten with the success message and the plugin will not be resumed.

Parameters Parameters

$plugin

(string) (Required) Single plugin to resume.

$redirect

(string) (Optional) URL to redirect to.

Default value: ''

Return Return

(bool|WP_Error) True on success, false if $plugin was not paused, WP_Error on failure.

Source Source

File: wp-admin/includes/plugin.php

function resume_plugin( $plugin, $redirect = '' ) {
	/*
	 * We'll override this later if the plugin could be resumed without
	 * creating a fatal error.
	 */
	if ( ! empty( $redirect ) ) {
		wp_redirect(
			add_query_arg(
				'_error_nonce',
				wp_create_nonce( 'plugin-resume-error_' . $plugin ),
				$redirect
			)
		);

		// Load the plugin to test whether it throws a fatal error.
		ob_start();
		plugin_sandbox_scrape( $plugin );
		ob_clean();
	}

	list( $extension ) = explode( '/', $plugin );

	$result = wp_paused_plugins()->delete( $extension );

	if ( ! $result ) {
		return new WP_Error(
			'could_not_resume_plugin',
			__( 'Could not resume the plugin.' )
		);
	}

	return true;
}

Advertisement

Changelog Changelog

Changelog
Version Description
5.2.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.