W3cubDocs

/WordPress

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

Tries to resume a single plugin.

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

$plugin

(string) (Required) Single plugin to resume.

$redirect

(string) (Optional) URL to redirect to.

Default value: ''

Return

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

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

Uses

Uses Description
wp-includes/error-protection.php: wp_paused_plugins()

Get the instance for storing paused plugins.
wp-admin/includes/plugin.php: plugin_sandbox_scrape()

Load a given plugin attempt to generate errors.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/pluggable.php: wp_create_nonce()

Creates a cryptographic token tied to a specific action, user, user session, and window of time.
wp-includes/pluggable.php: wp_redirect()

Redirects to another page.
wp-includes/functions.php: add_query_arg()

Retrieves a modified URL query string.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
5.2.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/resume_plugin