DOCSEARCHbyAlgolia
Submit Docs

WP Rollback Documentation

website·Indexed 32 days ago

https://docs.wprollback.com

Documentation for WP Rollback, a WordPress plugin used to revert plugins and themes to previous versions. Includes guides on plugin and theme rollbacks, WordPress Multisite support, and Pro features such as the Plugin Vault and WP-CLI support. Provides technical details on package validation, system requirements, and a developer guide for custom integrations.

Tokens
14.5K
Snippets
44
Records
133
Agent score
66%

What's inside WP Rollback

  1. Overview of WP Rollback Plugin Vault

    Plugin Vault is an exclusive feature for WP Rollback Pro users that provides access to a shared, cloud-hosted library of premium plugin and theme ZIP files. This allows developers to roll back premium assets even if they do not have a local archive of that specific version. The Vault is community-driven: when a Pro user updates a premium asset, WP Rollback automatically contributes that version to the Vault for other licensed Pro users to access.

    Key Security Features:

    • SHA-256 Verification: Every ZIP is verified by a checksum before storage and again before installation to prevent tampered or corrupted files.
    • Deduplication: Only one copy of a specific version is stored regardless of how many times it is contributed.
    • Secure Delivery: Files are delivered via signed, time-limited URLs and are never publicly accessible.

  2. Understand the WP Rollback package validation process

    WP Rollback automatically validates plugin and theme packages before installation to ensure file integrity and security. The process consists of five main stages:

    1. Download Check: Verifies the package was downloaded successfully.
    2. ZIP Integrity: Confirms the file is a valid, readable ZIP archive.
    3. WordPress Core Validation: Uses standard WordPress methods to check file types, respect upload size limits, and verify server file modification permissions.
    4. Package Structure Validation:
      • Plugins: Must have a main plugin file (e.g., my-plugin.php) with proper headers (Name, Version) and compatible PHP/WordPress versions.
      • Themes: Must have a style.css with theme headers and either an index.php or templates/index.html (for block themes).
    5. File Monitoring: Reports total file counts, counts PHP files, and flags files larger than 5MB (informational only).

  3. Review WP Rollback limitations and requirements

    When using WP Rollback, be aware of the following constraints:

    • WordPress Core: WP Rollback does not support rolling back WordPress core versions.
    • File Permissions: The web server must have write permissions to the plugin/theme directories.
    • Disk Space: Sufficient space is required for temporary files during the process.
    • Version Availability (Free): Limited strictly to versions currently available in the WordPress.org repository; if an author removes a version, it cannot be rolled back via the Repo source.

  4. Perform a plugin or theme rollback

    WP Rollback adds direct links to the WordPress admin interface for quick reverts:

    • Plugins: Navigate to Plugins > Installed Plugins and click the "Rollback" link next to the target plugin.
    • Themes: Navigate to Appearance > Themes and click "Rollback" on the target theme.
    • Centralized Management: Use Tools > WP Rollback for advanced management.

  5. Update payment methods and download invoices

    Billing information and tax documents are managed under the Billing section of the customer portal.

    To update payment: Navigate to Billing → Payment Methods → Add/Update card. To download invoices: Navigate to Billing → Invoice History → Click "Download PDF".

  6. Roll back a plugin or theme to a previous version

    WP Rollback allows you to replace current code files with a previous version. This process typically preserves settings and data as it only modifies files, not the database.

    For Plugins:

    1. Go to Plugins > Installed Plugins
    2. Click Rollback next to the plugin
    3. Select the version and click Rollback

    For Themes:

    1. Go to Appearance > Themes
    2. Click Theme Details on the theme
    3. Click the Rollback button
    4. Select the version and confirm

  7. Requirements for using Plugin Vault

    To use the Plugin Vault, the following conditions must be met:

    • WP Rollback Pro License: You must have an active WP Rollback Pro subscription.
    • Asset License: You must hold a valid, active license for the specific premium plugin or theme you are rolling back. Accessing the Vault does not grant a license to the software; using the Vault without a valid license for the asset is a violation of the author's terms.
    • Connectivity: The WordPress server must have internet access to reach the Vault API.

  8. WP Rollback system requirements

    To run WP Rollback, your environment must meet the following specifications:
    • WordPress 6.0 or higher
    • PHP 7.4 or higher
    • Write permissions to wp-content directory
    • Stable internet connection

  9. Follow best practices before performing a rollback

    To ensure site stability and prevent data loss, follow these steps before using WP Rollback:

    1. Create a full site backup.
    2. Test the rollback in a staging environment.
    3. Review the version changelog for the target version.
    4. Document the reason for the rollback.

  10. Create and register a custom rollback step

    To add custom logic to the rollback process, implement the RollbackStep interface and register the class via the wp_rollback_register_steps action.
    <?php

use WPRollback
Core
Contracts
RollbackStep;
use WPRollback
Core
Contracts
RollbackStepResult;

class CustomRollbackStep implements RollbackStep {
    public function get_id(): string { return 'custom_step'; }
    public function get_name(): string { return 'Custom Step'; }
    public function get_description(): string { return 'Performs custom rollback operations'; }
    
    public function execute(array $context): RollbackStepResult {
        // Custom step logic here
        return new RollbackStepResult(true, 'Custom step completed successfully', $context);
    }
    
    public function get_dependencies(): array { return ['backup']; }
}

// Register the custom step
add_action('wp_rollback_register_steps', function($registerer) {
    $registerer->register(new CustomRollbackStep());
});

  11. Roll back a WordPress theme via the WP Rollback Dashboard

    To revert a theme using the dedicated WP Rollback tool:

    1. Go to Tools > WP Rollback.
    2. Click the Rollback a Theme button.
    3. Locate the theme in the list and click Rollback.
    4. Select the version and confirm the rollback.

  12. Track and audit rollback activity in WP Rollback Pro

    WP Rollback Pro maintains comprehensive logs of all rollback events, including timestamps, the user who performed the action, version changes (from/to), and any admin notes left during the process.

    To access these logs:

    1. Navigate to Tools > WP Rollback.
    2. Select either the Plugin Activity or Theme Activity tabs to view, search, and filter activities.