Using WordPress ‘plugin_sandbox_scrape()’ PHP function

The plugin_sandbox_scrape() WordPress PHP function loads a given plugin and attempts to generate errors.

Usage

plugin_sandbox_scrape($plugin);

Example:

Input:

plugin_sandbox_scrape('my-plugin/my-plugin.php');

Parameters

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

More information

See WordPress Developer Resources: plugin_sandbox_scrape()

Examples

Basic Usage

Load a plugin named my-plugin and check for errors during activation:

// Load the plugin
plugin_sandbox_scrape('my-plugin/my-plugin.php');

Load Multiple Plugins

Load multiple plugins and check for errors during activation:

// Array of plugins
$plugins = array(
  'plugin-one/plugin-one.php',
  'plugin-two/plugin-two.php'
);

// Loop through plugins and load each one
foreach ($plugins as $plugin) {
  plugin_sandbox_scrape($plugin);
}

Check if Plugin File Exists

Before loading the plugin, check if the plugin file exists:

// Plugin path
$plugin = 'my-plugin/my-plugin.php';

// Check if the plugin file exists
if (file_exists(WP_PLUGIN_DIR . '/' . $plugin)) {
  plugin_sandbox_scrape($plugin);
} else {
  echo 'Plugin file not found.';
}

Load Plugin and Display a Message

Load a plugin and display a success or error message:

// Plugin path
$plugin = 'my-plugin/my-plugin.php';

// Load the plugin
$result = plugin_sandbox_scrape($plugin);

// Check for errors
if (is_wp_error($result)) {
  echo 'An error occurred during plugin activation: ' . $result->get_error_message();
} else {
  echo 'Plugin activated successfully.';
}

Deactivate Plugin before Loading

Deactivate a plugin before loading it to check for errors during activation:

// Plugin path
$plugin = 'my-plugin/my-plugin.php';

// Deactivate the plugin
deactivate_plugins($plugin);

// Load the plugin
plugin_sandbox_scrape($plugin);