Hooks & Filters in BackupEase

BackupEase is built to be extended. Add-ons, including BackupEase Pro itself, register new storage providers, inject admin UI, and react to backup events entirely through standard WordPress action and filter hooks, without modifying the plugin’s source. This reference lists the hooks BackupEase fires and shows how to use them.

How extension works

BackupEase exposes two kinds of hooks:

• Actions (do_action) let you run code at a point in the lifecycle, or output markup into the admin UI.
• Filters (apply_filters) let you change a value: register a provider, relabel a destination, veto a backup, swap the archive builder, and so on.

A typical add-on hangs its logic off plugins_loaded and checks that BackupEase is present first:

add_action( 'plugins_loaded', function () {
    if ( ! defined( 'BACKUPEASE_VERSION' ) ) {
        return; // BackupEase is not active.
    }
    // Register your hooks here.
}, 20 );

Backup lifecycle

React to backups as they run, or block them from starting.

add_action( 'backupease_after_backup_complete', function ( $backup_id, $state ) {
    error_log( "BackupEase finished backup #{$backup_id}" );
}, 10, 2 );

Storage providers

The storage system is fully pluggable. These hooks are how Pro adds FTP, SFTP, OneDrive, Dropbox, and S3, and how you would add your own destination.

// Register a custom "myhost" storage provider.
add_filter( 'backupease_valid_storage_providers', function ( $slugs ) {
    $slugs[] = 'myhost';
    return $slugs;
} );

add_filter( 'backupease_storage_labels', function ( $labels ) {
    $labels['myhost'] = 'My Host';
    return $labels;
} );

add_filter( 'backupease_upload_to_destination', function ( $result, $destination, $state ) {
    if ( 'myhost' !== $destination ) {
        return $result; // Not ours, leave it untouched.
    }
    // ... upload $state['zip_file'] / $state['db_file'] to your service ...
    return true; // true on success, or a WP_Error on failure.
}, 10, 3 );

Admin UI

Inject tabs, storage cards, credential sections, and settings into the BackupEase dashboard. These action hooks simply echo markup where they fire.

// Add a custom tab to the BackupEase dashboard.
add_action( 'backupease_tabs_nav', function () {
    echo '<a href="#myaddon" class="backupease-tab-link tab-item" data-tab="myaddon">My Add-on</a>';
} );

add_action( 'backupease_tabs_content', function () {
    echo '<div id="myaddon" class="backupease-tab-content">…</div>';
} );

Scheduling

Compression & other filters

WP-CLI

BackupEase also ships a WP-CLI command for scripting backups outside the admin UI:

wp backupease run                       # full backup with saved settings
wp backupease run --database-only
wp backupease run --files-only
wp backupease run --schedule=<id>        # run a specific saved schedule
wp backupease run --storage=googledrive