BackWPup

https://github.com/wp-media/backwpup
Admin
BackWPup is a comprehensive WordPress backup and restore plugin that enables users to create...
Tokens:256,428
Snippets:1,836
Trust Score:9.9
License:GPL-2.0
Update:14 hours ago
Show doc for...
Tokens:
Raw
### POST v1/startbackup

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/errors.md

Starts a backup. Returns errors for folder issues, missing destinations, or process start failures.

```APIDOC
## [POST] v1/startbackup

### Description
Starts a backup. Returns errors for folder issues, missing destinations, or process start failures.

### Method
POST

### Endpoint
v1/startbackup

### Error Conditions
- **Condition**: temp folder not writable/creatable
  - **HTTP Status**: 200 w/ `status:500`
  - **Error Payload**: `{"status":500,"message":"<folder error>"}`
- **Condition**: log folder not writable
  - **HTTP Status**: 200 w/ `status:500`
  - **Error Payload**: `{"status":500,"message":"<folder error>"}`
- **Condition**: no configured/available destination
  - **HTTP Status**: 200 w/ `status:500`
  - **Error Payload**: `{"status":500,"message":"No backup destination available for \"<name>\" or properly configured!"}`
- **Condition**: `.backwpup_job_started` marker missing
  - **HTTP Status**: 200 w/ `status:500`
  - **Error Payload**: `{"status":500,"message":"The backup process could not be started! Please try to contact our support."}`
- **Condition**: second `first_backup` call
  - **HTTP Status**: 200 w/ `status:301`
  - **Error Payload**: `{"status":301,"url":"<admin url>"}`
```

--------------------------------

### Using WpHttpClient to send a GET request

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/http-client.md

Shows how to instantiate WpHttpClient with a ResponseFactory, StreamFactory, and options, then send a GET request and handle network, request, and option exceptions.

```php
use Inpsyde\BackWPup\Infrastructure\Http\Client\WpHttpClient;
use Inpsyde\BackWPup\Infrastructure\Http\Message\{RequestFactory, ResponseFactory, StreamFactory};

$client = new WpHttpClient( new ResponseFactory(), new StreamFactory(), [ 'timeout' => 30 ] );

try {
	$request  = ( new RequestFactory() )->createRequest( 'GET', 'https://api.example.com/status' );
	$response = $client->sendRequest( $request );
	echo $response->getStatusCode() . ' ' . $response->getBody()->__toString();
} catch ( \Psr\Http\Client\NetworkExceptionInterface $e ) {
	error_log( 'Network error for ' . (string) $e->getRequest()->getUri() );
} catch ( \Psr\Http\Client\RequestExceptionInterface $e ) {
	error_log( 'Request rejected: ' . $e->getMessage() ); // e.g. empty/invalid URI
} catch ( \Symfony\Component\OptionsResolver\Exception\NoSuchOptionException $e ) {
	error_log( 'Bad client option: ' . $e->getMessage() );
}
```

--------------------------------

### Start a backup now with wp backwpup run --now

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Starts a backup immediately using the `--now` option. The command outputs progress information and a success message.

```bash
# Start a backup now job.
$ wp backwpup run --now
[INFO] BackWPup 5.6.0; A project of WP Media
...
Job done in 10 seconds.
Successes: Job runs successfully.
```

--------------------------------

### Start a backup job with wp backwpup start

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli-old.md

Starts a backup job with the specified job ID. Outputs error or success messages line by line from the running job.

```bash
wp backwpup start 1
```

--------------------------------

### POST v1/startbackup

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-backups.md

Starts a backup job. Handles first-backup onboarding, job selection, folder and destination checks, and triggers the backup process via WP-Cron. Returns a status and message indicating whether the job started or executed.

```APIDOC
## POST v1/startbackup

### Description
Starts a backup job. Handles first-backup onboarding, job selection, folder and destination checks, and triggers the backup process via WP-Cron. Returns a status and message indicating whether the job started or executed.

### Method
POST

### Endpoint
v1/startbackup

### Parameters
#### Request Body
- **first_backup** (boolean) - Optional - If truthy and the `backwpup_first_backup` transient is already set, returns a redirect response. Otherwise sets the transient (1 hour) and proceeds.
- **job_id** (integer) - Optional - The ID of the job to run. If not provided, the system will select a job with `backup_now` enabled or create a default job.

### Request Example
{
  "first_backup": true,
  "job_id": 123
}

### Response
#### Success Response (200)
- **status** (integer) - HTTP-like status code (200, 201, 301, 500).
- **message** (string) - Human-readable message describing the result.
- **url** (string) - Present when status is 301, containing the network admin URL.

#### Response Example
{
  "status": 200,
  "message": "Job \"My Backup\" started."
}
```

--------------------------------

### wp backwpup run - start jobs

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Starts backup jobs. Supports a positional job ID, --job_id, --now, and --background. The examples show running a single job in the background, running multiple jobs sequentially, and starting a one-shot backup to FOLDER.

```bash
$ wp backwpup run 1 --background          # Run job 1 in the background.
$ wp backwpup run 1,2,3                  # Run jobs 1-3 sequentially.
$ wp backwpup run --now                  # One-shot files+db backup to FOLDER.
```

--------------------------------

### wp backwpup start

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli-old.md

Starts a backup job with the specified job ID. Outputs error or success messages line by line from the running job.

```APIDOC
## wp backwpup start

### Description
Starts a backup job with the specific job id.

### Command
`wp backwpup start <job_id>`

### Parameters
- **job_id** (integer) - Required - Id of job that should be started.

### Example
```
wp backwpup start 1
```

### Output
_error|success_ Messages line by line from the running job when it runs.
```

--------------------------------

### Start multiple jobs sequentially with wp backwpup run

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Starts multiple jobs by providing a comma-separated list of job IDs. The jobs run one after the other, and the command outputs progress information and a success message.

```bash
# Start jobs with ID 1, 2 and 3. Jobs will run one after the other.
$ wp backwpup run 1,2,3
[INFO] BackWPup 5.6.0; A project of WP Media
...
Job done in 2 seconds.
Successes: Job runs successfully.
```

--------------------------------

### wp backwpup backup-download command example

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Downloads an archive. Use --storage to specify the storage. Overwrites prompt when the local file exists.

```bash
$ wp backwpup backup-download backwpup_1_2024-04-23_10-30-00_ABC123.zip --storage=FOLDER
```

--------------------------------

### POST /backwpup/v1/startbackup

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-backups.md

Starts a backup for a specific job. The response payload includes a status field that indicates whether the backup was executed (201), started (200), redirected due to first-backup gate (301), or failed (500).

```APIDOC
## POST /backwpup/v1/startbackup

### Description
Starts a backup for a specific job. The response payload includes a status field that indicates whether the backup was executed (201), started (200), redirected due to first-backup gate (301), or failed (500).

### Method
POST

### Endpoint
/backwpup/v1/startbackup

### Parameters
#### Request Body
- **job_id** (integer) - Required - The ID of the job to start.

### Request Example
{
  "job_id": 3
}

### Response
#### Success Response (200)
- **status** (integer) - Status code indicating the result: 201 (executed), 200 (started), 301 (first-backup gate redirect), 500 (failure).
- **url** (string) - Redirect URL when status is 301.
- **message** (string) - Error message when status is 500.

#### Response Example
{
  "status": 200
}
```

--------------------------------

### Start a job in background with wp backwpup run

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Starts a single job in the background using the `--background` option. The command outputs a success message indicating the job is running.

```bash
# Start a job with ID 1 in background.
$ wp backwpup run 1 --background
Success: Job "File" runs now in background.
```

--------------------------------

### wp backwpup version command example

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Prints the plugin version. Use --debug to print debug information and settings.

```bash
$ wp backwpup version
BackWPup 5.6.0
```

--------------------------------

### wp backwpup log-show command example

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Shows a log as plain text. Use --lines to tail the log. Exits with an error if the file is not found.

```bash
$ wp backwpup log-show backwpup_log_8a8bee_2025-11-03_06-30-29.html --lines=50
```

--------------------------------

### Schedule job using adapters

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/adapters.md

Example usage of OptionAdapter, JobAdapter, and CronAdapter to enable and schedule a job, set cron options, and return the next run date. Throws RuntimeException if the cron expression cannot be parsed.

```php
use WPMedia\BackWPup\Adapters\OptionAdapter;
use WPMedia\BackWPup\Adapters\JobAdapter;
use WPMedia\BackWPup\Adapters\CronAdapter;

function schedule_job_from_adapter( OptionAdapter $options, JobAdapter $jobs, CronAdapter $cron, int $job_id ): string {
	$jobs->enable_job( $job_id );
	$jobs->schedule_job( $job_id );

	$expression = $cron->get_basic_cron_expression( 'daily', 3, 0 ); // 03:00 daily
	$options->update( $job_id, 'cron', $expression );
	$options->update( $job_id, 'activetype', 'wpcron' );

	$next = $cron->cron_next( $expression );
	if ( PHP_INT_MAX === $next ) {
		throw new RuntimeException( 'Cron expression could not be parsed.' );
	}
	return wp_date( get_option( 'date_format' ), $next );
}
```

--------------------------------

### Options and Renderer Usage

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/options.md

Shows how to instantiate Options with a prefix, set, check, get, and delete an option, then use a renderer extending AbstractRender to generate a view and render an action button. The renderer is created with a view directory and the template name is relative to that path.

```php
use WPMedia\BackWPup\Admin\Options\Options;
use WPMedia\BackWPup\Common\AbstractRender;

// Option store with prefix.
$store = new Options( 'backwpup_' );
$store->set( 'loglevel', 'normal_translated' );
if ( $store->has( 'loglevel' ) ) {
	$level = $store->get( 'loglevel', 'normal' );
}
$store->delete( 'loglevel' );

// Renderer.
$renderer = new class( __DIR__ . '/views' ) extends AbstractRender {};
echo $renderer->generate( 'settings', [ 'loglevel' => $level ] );
$renderer->render_action_button( 'link', '', [ 'url' => admin_url( 'admin.php?page=backwpup' ), 'label' => 'Go to BackWPup' ] );
```

--------------------------------

### GET /wp-json/backwpup/v1/storagelistcompact

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/endpoints.md

Renders the storage-list-compact component for the first job's destinations. Returns HTML or an error alert.

```APIDOC
## GET /wp-json/backwpup/v1/storagelistcompact

### Description
Renders the storage-list-compact component for the first job's destinations. Returns HTML on success or an info-alert component on error.

### Method
GET

### Endpoint
/wp-json/backwpup/v1/storagelistcompact

### Parameters
None

### Response
#### Success Response (200)
- Body: HTML of the storage-list-compact component

#### Error Response (500)
- Body: HTML info-alert component (when no backup jobs are set)
```

--------------------------------

### wp backwpup backup-delete command example

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Deletes an archive. Use --yes to skip confirmation. Errors/confirmation handled via WP-CLI prompts.

```bash
$ wp backwpup backup-delete backwpup_1_2024-04-23_10-30-00_ABC123.zip --yes
```

--------------------------------

### wp backwpup run

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Starts backup jobs. Supports running a specific job, multiple jobs sequentially, or the 'Backup Now' job in the background.

```APIDOC
## wp backwpup run

### Description
Starts backup jobs. Supports running a specific job, multiple jobs sequentially, or the 'Backup Now' job in the background.

### Method
CLI

### Command
`wp backwpup run [<job_id>]`

### Options
- `<job_id>` (integer) - Optional - Job ID to run
- `--job_id=<ids>` (comma-separated) - Optional - Comma-separated list of job IDs to run
- `--now` (flag) - Optional - Start the "Backup Now" job
- `--background` (flag) - Optional - Run in background (single job only, via `get_jobrun_url('runnow', …)`)

### Behavior
- Errors with `A job is already running.` if the `running_file` exists.
- Errors with `No job ID(s) or pram specified!` if nothing given.
- Errors with `Background job run not works with more than one job_id!` if multiple job IDs with `--background`.
- Errors with `Job ID does not exist!` if none matched.
- Filter `backwpup_job_not_started_error_message` (string, receives `$job_id`) can veto a background start.
- Sequential (foreground) runs use `JobAdapter::start_cli()` per job and report accumulated errors/warnings from `read_log_header()` (`There are %d errors due to job execution please chack the logs!`, `%d wearings` — sic, from source).
- `--now` creates/reuses job stored in site option `backwpup_backup_now_job_id`.

### Examples
```bash
$ wp backwpup run 1 --background          # Run job 1 in the background.
$ wp backwpup run 1,2,3                  # Run jobs 1-3 sequentially.
$ wp backwpup run --now                  # One-shot files+db backup to FOLDER.
```
```

--------------------------------

### Example usage of GetJobsList ability

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/mcp-abilities.md

Shows how to retrieve and display the list of backup jobs using the 'get_jobs_list_ability' from the container. It checks permissions first, then executes and prints each job's ID, name, and destinations.

```php
$ability = $container->get( 'get_jobs_list_ability' );
if ( ! $ability->check_permissions() ) {
	// current_user_can('backwpup') failed
	return;
}
$result = $ability->execute();
foreach ( $result['jobs'] as $job ) {
	printf( "#%d %s -> %s\n", $job['id'], $job['name'], implode( ', ', $job['destinations'] ) );
}
```

--------------------------------

### Start a backup for a specific job and interpret the payload status field

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-backups.md

Sends a POST request to /backwpup/v1/startbackup with a job_id parameter. The response status field is interpreted: 201/200 indicate success, 301 triggers a redirect, and 500 logs an error message.

```php
// Start a backup for a specific job and interpret the payload status field.
$request = new WP_REST_Request( 'POST', '/backwpup/v1/startbackup' );
$request->set_body_params( [ 'job_id' => 3 ] );
$response = rest_do_request( $request );

$data   = $response->get_data();
$status = is_array( $data ) ? (int) ( $data['status'] ?? 0 ) : 0;
switch ( $status ) {
	case 201: // "executed"
	case 200: // "started"
		break;
	case 301: // first-backup gate redirect
		wp_redirect( $data['url'] ); exit;
	case 500: // folder/destination/start failure
		error_log( $data['message'] );
		break;
}
```

--------------------------------

### Display backups as a table with `wp backwpup backup`

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Runs the command without options to display a table of backups with default fields (name, time, size, storage, type). The output shows example rows with archive names, timestamps, sizes, storage locations, and types.

```bash
$ wp backwpup backup
+------------------------------------------------------------+-----------------------------+-----------+---------+------------------------+
| name                                                       | time                        | size      | storage | type                   |
+------------------------------------------------------------+-----------------------------+-----------+---------+------------------------+
| 2025-11-10_13-24-36_SDIUOYJN09_FILE-DBDUMP-WPPLUGIN.tar    | November 10, 2025 @ 1:24 pm | 278.50 MB | folder  | file, dbdump, wpplugin |
| 2025-11-10_13-23-08_FHIUOYK706_FILE-DBDUMP-WPPLUGIN.tar.gz | November 10, 2025 @ 1:24 pm | 181.57 MB | hidrive | file, dbdump, wpplugin |
| 2025-11-10_13-23-08_FHIUOYK706_FILE-DBDUMP-WPPLUGIN.tar.gz | November 10, 2025 @ 1:23 pm | 181.57 MB | folder  | file, dbdump, wpplugin |
| 2025-11-07_09-22-51_U7IUOYKR09_FILE-DBDUMP-WPPLUGIN.tar    | November 7, 2025 @ 9:22 am  | 278.48 MB | folder  | file, dbdump, wpplugin |
| 2025-11-07_09-22-34_DXIUOYMY06_FILE-DBDUMP-WPPLUGIN.tar.gz | November 7, 2025 @ 9:22 am  | 181.56 MB | folder  | file, dbdump, wpplugin |
| 2025-11-07_08-57-28_YHIUOYNL06_FILE-DBDUMP-WPPLUGIN.tar.gz | November 7, 2025 @ 8:58 am  | 88.00 MB  | hidrive | file, dbdump, wpplugin |
| 2025-11-07_08-57-28_YHIUOYNL06_FILE-DBDUMP-WPPLUGIN.tar.gz | November 7, 2025 @ 8:57 am  | 181.56 MB | folder  | file, dbdump, wpplugin |
| 2025-11-07_08-57-11_IDIUOYPB09_FILE-DBDUMP-WPPLUGIN.tar    | November 7, 2025 @ 8:57 am  | 278.48 MB | folder  | file, dbdump, wpplugin |
| 2025-11-07_08-56-03_HLIUOYPE06_FILE-DBDUMP-WPPLUGIN.tar.gz | November 7, 2025 @ 8:57 am  | 112.00 MB | hidrive | file, dbdump, wpplugin |
| 2025-11-07_08-56-03_HLIUOYPE06_FILE-DBDUMP-WPPLUGIN.tar.gz | November 7, 2025 @ 8:56 am  | 181.56 MB | folder  | file, dbdump, wpplugin |
```

--------------------------------

### wp backwpup log-delete command example

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Deletes logs. Use --older-than to specify a relative time and --yes to skip confirmation.

```bash
$ wp backwpup log-delete --older-than="30 days" --yes
```

--------------------------------

### Rest class for storage list compact endpoint

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-storage-cloud.md

Implements RestInterface with a constructor taking BackWPupHelpersAdapter and OptionAdapter. Provides has_permission() checking current_user_can('backwpup'), register_routes() for GET v1/storagelistcompact, and get_storage_list_compact() which renders the storage-list-compact component. Throws 'No backup jobs set.' exception when FIRST_JOB_ID is missing, resulting in HTTP 500 and an alert component. Content type is text/html.

```php
class Rest implements RestInterface {

	public function __construct( BackWPupHelpersAdapter $helper_adapter, OptionAdapter $option_adapter );
	public function has_permission(): bool;      // current_user_can('backwpup')
	public function register_routes(): void;     // GET v1/storagelistcompact
	public function get_storage_list_compact();
}
```

--------------------------------

### wp backwpup backup - list backup archives

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/wp-cli.md

Lists backup archives across all jobs and destinations. Supports global format options like --format and --fields. The first example shows a table of all backups; the second shows only file names and storage as JSON.

```bash
# Table of all backups across destinations.
$ wp backwpup backup

# Only file names + storage as JSON.
$ wp backwpup backup --fields=storage,name --format=json
```

--------------------------------

### ContextSnapshotBuilder class definition

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/options.md

Defines ContextSnapshotBuilder with constructor taking BackWPupAdapter, ErrorSignalsStore, and Optin. build(int $signals_limit = 20) returns a support-context snapshot array with keys: backwpup_version, wp_version, domain, php_version, active_theme, active_plugins, recent_error_signals, backwpup_mixpanel_optin, plugin, and generated_at. This payload is stored by POST v1/chatbot-context and returned by the token-gated GET variant.

```php
class ContextSnapshotBuilder {
	public function __construct( BackWPupAdapter $backwpup_adapter, ErrorSignalsStore $signals_store, Optin $optin );
	public function build( int $signals_limit = 20 ): array;
}
```

--------------------------------

### GET /wp-json/backwpup/v1/getjobslist

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/endpoints.md

Retrieves a list of jobs as HTML components. Requires the 'backwpup' permission. Returns job-item components for all non-temp, non-backup_now, non-legacy jobs.

```APIDOC
## GET /wp-json/backwpup/v1/getjobslist

### Description
Retrieves a list of jobs as HTML components. Requires the 'backwpup' permission. Returns job-item components for all non-temp, non-backup_now, non-legacy jobs.

### Method
GET

### Endpoint
/wp-json/backwpup/v1/getjobslist

### Parameters
None

### Response
#### Success Response (200)
- **body** (string) - HTML of job-item components

#### Response Example
<!-- HTML content of job-item components -->
```

--------------------------------

### Rest class interface for Backups API

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-backups.md

Shows the public interface of the Rest class implementing RestInterface. The constructor takes adapters for backups, options, jobs, files, job types, and a backup database. Methods include permission checks, route registration, and handlers for starting backups, checking abort status, and processing bulk actions.

```php
class Rest implements RestInterface {

	public function __construct(
		BackWPupAdapter $backups_adapter,
		OptionAdapter $option_adapter,
		JobAdapter $job_adapter,
		FileAdapter $file_adapter,
		JobTypesAdapter $job_types_adapter,
		BackupDatabase $backup_database
	);
	public function has_permission(): bool;      // current_user_can('backwpup')
	public function register_routes(): void;
	public function start_backup( WP_REST_Request $request );
	public function get_job_abort_status( WP_REST_Request $request ): WP_REST_Response;
	public function process_bulk_actions( WP_REST_Request $request ): \WP_REST_Response;
}
```

--------------------------------

### Filter BackWPup logs by text with wp backwpup logs --search

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Filters logs using the `--search` option to match a pattern. This example searches for 'backup' and displays the matching log in a table format.

```bash
# Filter logs by text:
$ wp backwpup logs --search=backup
+----------------------------------------------+-----------------------------+------------+------------------------+-----------+---------+--------+
| name                                         | time                        | job        | type                   | size      | runtime | status |
+----------------------------------------------+-----------------------------+------------+------------------------+-----------+---------+--------+
| backwpup_log_ac7889_2025-11-01_10-16-28.html | November 1, 2025 @ 10:16 am | Backup Now | file, dbdump, wpplugin | 282.68 MB | 5 s     | O.K.   |
+----------------------------------------------+-----------------------------+------------+------------------------+-----------+---------+--------+
```

--------------------------------

### Display backups in JSON with `wp backwpup backup --fields=storage,name --format=json`

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Uses the `--fields` and `--format` options to output only the storage and name fields in JSON format. The example shows a JSON array of objects with storage and name properties.

```bash
$ wp backwpup backup --fields=storage,name --format=json
[{"storage":"folder","name":"2025-11-10_13-24-36_SDIUOYJN09_FILE-DBDUMP-WPPLUGIN.tar"},{"storage":"hidrive","name":"2025-11-10_13-23-08_FHIUOYK706_FILE-DBDUMP-WPPLUGIN.tar.gz"},{"storage":"folder","name":"2025-11-10_13-23-08_FHIUOYK706_FILE-DBDUMP-WPPLUGIN.tar.gz"}]
```

--------------------------------

### Show only the last N lines with --lines option

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Displays only the last N lines of a BackWPup log using the `--lines` option. The example uses `--lines=14` and shows the tail of the log with archive and encryption details.

```bash
$ wp backwpup log-show --file=backwpup_log_... --lines=14
[07-Nov-2025 08:57:36] Archiving Folder: /var/www/html/.ddev/wordpress/wp-includes/sodium_compat/src/Core32/SecretStream/
[07-Nov-2025 08:57:36] Archiving Folder: /var/www/html/.ddev/wordpress/wp-includes/sodium_compat/src/PHP52/
[07-Nov-2025 08:57:36] Archiving Folder: /var/www/html/.ddev/wordpress/wp-includes/style-engine/
[07-Nov-2025 08:57:36] Archiving Folder: /var/www/html/.ddev/wordpress/wp-includes/theme-compat/
[07-Nov-2025 08:57:36] Archiving Folder: /var/www/html/.ddev/wordpress/wp-includes/widgets/
[07-Nov-2025 08:57:36] Backup archive created.
[07-Nov-2025 08:57:36] Archive size is 181.56 MB.
[07-Nov-2025 08:57:36] 8657 Files with 272.06 MB in Archive.
[07-Nov-2025 08:57:36] Restart after 8 seconds.
[07-Nov-2025 08:57:36] 1. Trying to encrypt archive …
[07-Nov-2025 08:57:37] Encrypted 181.63 MB of data.
[07-Nov-2025 08:57:37] Archive has been successfully encrypted.
[07-Nov-2025 08:57:37] 1. Try to send backup file to HiDrive …
[07-Nov-2025 08:58:04] Restart after 28 seconds.
```

--------------------------------

### Register custom ability with wp_register_ability

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/mcp-abilities.md

Example of a custom ability class implementing AbilitiesInterface. It registers an ability 'backwpup/status-echo' with label, category, callbacks, output schema, and MCP meta. Register it on 'wp_abilities_api_init' and add it to MCP\ServiceProvider if it needs container dependencies.

```php
use WPMedia\BackWPup\Abilities\AbilitiesInterface;

class BackupStatusAbility implements AbilitiesInterface {
	public function register(): void {
		if ( ! function_exists( 'wp_register_ability' ) ) {
			return;
		}
		wp_register_ability(
			'backwpup/status-echo',
			[
				'label'               => 'Echo Backup Status',
				'category'            => 'backwpup-jobs',
				'execute_callback'    => [ $this, 'execute' ],
				'permission_callback' => [ $this, 'check_permissions' ],
				'output_schema'       => [ 'type' => 'object', 'properties' => [ 'ok' => [ 'type' => 'boolean' ] ] ],
				'meta'                => [ 'show_in_rest' => true, 'mcp' => [ 'public' => true ] ],
			]
		);
	}

	public function check_permissions(): bool { return current_user_can( 'backwpup' ); }
	public function execute() { return [ 'ok' => true ]; }
}
```

--------------------------------

### View BackWPup logs as a table with wp backwpup log

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Lists logs in a table format by default. The output includes fields such as name, time, job, type, size, runtime, and status. This example shows the default output without any filters.

```bash
# View logs as a table (default):
$ wp backwpup log
+----------------------------------------------+-----------------------------+-----------------------+------------------------+-----------+---------+----------+
| name                                         | time                        | job                   | type                   | size      | runtime | status   |
+----------------------------------------------+-----------------------------+-----------------------+------------------------+-----------+---------+----------+
| backwpup_log_440bd7_2025-11-10_13-24-36.html | November 10, 2025 @ 1:24 pm | Files & Database      | file, dbdump, wpplugin | 278.50 MB | 2 s     | O.K.     |
| backwpup_log_e5672b_2025-11-10_13-23-08.html | November 10, 2025 @ 1:23 pm | Files & Database      | file, dbdump, wpplugin | 181.57 MB | 74 s    | 2 ERRORS |
| backwpup_log_e68e31_2025-11-07_09-22-51.html | November 7, 2025 @ 9:22 am  | Files & Database      | file, dbdump, wpplugin | 278.48 MB | 3 s     | O.K.     |
| backwpup_log_05a7f7_2025-11-07_09-22-34.html | November 7, 2025 @ 9:22 am  | Files & Database      | file, dbdump, wpplugin |           | 0 s     | O.K.     |
| backwpup_log_459409_2025-11-07_08-57-28.html | November 7, 2025 @ 8:57 am  | Files & Database      | file, dbdump, wpplugin |           | 0 s     | O.K.     |
| backwpup_log_6f3f67_2025-11-07_08-57-11.html | November 7, 2025 @ 8:57 am  | Files & Database      | file, dbdump, wpplugin | 278.48 MB | 2 s     | O.K.     |
| backwpup_log_fa5f45_2025-11-07_08-56-03.html | November 7, 2025 @ 8:56 am  | Files & Database      | file, dbdump, wpplugin | 181.56 MB | 47 s    | 2 ERRORS |
+----------------------------------------------+-----------------------------+-----------------------+------------------------+-----------+---------+----------+
```

--------------------------------

### Instantiate and use DropboxProvider with CloudProviderManager

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/storage-providers.md

Shows how to create a DropboxProvider with OptionAdapter and BackWPupHelpersAdapter, register it with CloudProviderManager, and call methods like is_authenticated, delete_auth, and authenticate. get_provider throws \Exception for unknown names; authenticate returns null for Dropbox.

```php
use WPMedia\BackWPup\StorageProviders\CloudProviderManager;
use WPMedia\BackWPup\StorageProviders\Dropbox\DropboxProvider;
use WPMedia\BackWPup\Adapters\{OptionAdapter, BackWPupHelpersAdapter};

$provider = new DropboxProvider(
	new OptionAdapter(),
	new BackWPupHelpersAdapter()
);

$manager = new CloudProviderManager( [ $provider ] );

$dropbox = $manager->get_provider( 'dropbox' );       // throws \Exception if unknown
$html    = $dropbox->is_authenticated( 1 );           // alert/info component HTML
$html    = $dropbox->delete_auth( $request );         // WP_REST_Request with job_id
var_dump( $dropbox->authenticate( $request ) );       // null for Dropbox
```

--------------------------------

### GET v1/chatbot-context

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/errors.md

Retrieves chatbot context. Returns an error if the transient is missing or expired.

```APIDOC
## [GET] v1/chatbot-context

### Description
Retrieves chatbot context. Returns an error if the transient is missing or expired.

### Method
GET

### Endpoint
v1/chatbot-context

### Error Conditions
- **Condition**: transient missing/expired
  - **HTTP Status**: 404
  - **Error Payload**: `{"message":"Context not found or expired."}`
```

--------------------------------

### GET v1/getjobslist

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-jobs.md

Returns the HTML for the jobs list, including job-item components for eligible jobs.

```APIDOC
## GET v1/getjobslist

### Description
Returns the HTML for the jobs list. The HTML concatenates `job-item` components for every non-temp, non-`backup_now`, non-legacy job (jobs with missing `jobid` or `legacy === true` are excluded).

### Method
GET

### Endpoint
`v1/getjobslist`

### Permissions
- Requires `backwpup` capability.

### Response
#### Success Response (200)
- `body` (string) - HTML containing the job items.

#### Response Example
`rest_ensure_response($html)`
```

--------------------------------

### Restore with pre-backup and --yes

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Creates a safety snapshot (DB export + wp-content copy) before restoring, using --pre-backup. The --yes flag skips confirmation prompts. The file is specified with --file.

```bash
# Backup data before overwriting with Restore from a file without prompts.
$ wp backwpup restore --file=/path/to/backup.zip --pre-backup --yes
...
Success: Restore completed successfully.
```

--------------------------------

### GET v1/cloud_is_authenticated

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-storage-cloud.md

Checks if a cloud provider is authenticated for a given job. Returns HTML indicating authentication status.

```APIDOC
## GET v1/cloud_is_authenticated

### Description
Checks if a cloud provider is authenticated for a given job. Returns HTML indicating authentication status.

### Method
GET

### Endpoint
v1/cloud_is_authenticated

### Parameters
#### Query Parameters
- **job_id** (integer) - Optional - The job ID. Defaults to `Plugin::FIRST_JOB_ID`. If absent, throws exception 'No backup jobs set.'.
- **cloud_name** (string) - Required - The cloud provider name. If absent, throws exception 'No cloud name set.'.

### Response
#### Success Response (200)
- Returns HTML from `$provider->is_authenticated($job_id)`.

#### Error Response (500)
- Returns an alert component with HTTP 500 on any exception.

### Response Example
```html
<!-- HTML content from provider -->
```
```

--------------------------------

### GET /wp-json/backwpup/v1/cloud_is_authenticated

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/endpoints.md

Checks if a cloud provider is authenticated for a given job. Returns an alert component indicating authentication status.

```APIDOC
## GET /wp-json/backwpup/v1/cloud_is_authenticated

### Description
Resolves the cloud provider via CloudProviderManager and returns whether the provider is authenticated for the specified job. The response is an HTML alert component.

### Method
GET

### Endpoint
/wp-json/backwpup/v1/cloud_is_authenticated

### Parameters
#### Query Parameters
- **job_id** (int|'') - Optional - Defaults to the first backup job; if false, an exception is thrown
- **cloud_name** (string) - Required - The cloud provider name

### Response
#### Success Response (200)
- Content-Type: text/html
- Body: HTML alert component indicating authentication status

#### Error Response (500)
- Body: HTML info-alert component (unknown provider, missing cloud name, or no backup jobs)
```

--------------------------------

### GET /wp-json/backwpup/v1/job-abort-status

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/endpoints.md

Checks whether the background process has finished its abort cleanup for a given job. Requires the `backwpup` capability.

```APIDOC
## GET /wp-json/backwpup/v1/job-abort-status

### Description
Checks whether the background process has finished its abort cleanup for a given job. Returns `true` once the cleanup is complete.

### Method
GET

### Endpoint
`/wp-json/backwpup/v1/job-abort-status`

### Parameters
#### Query Parameters
- **job_id** (int) - Required - Numeric value greater than 0 (absint).

### Response
#### Success Response (200)
- **is_done** (bool) - Indicates whether the abort cleanup is complete.

#### Response Example
```json
{"is_done": true}
```
```

--------------------------------

### GET v1/job-abort-status

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-backups.md

Returns the abort status for a given job. Polled by the abort UI to determine when a backup abort has completed.

```APIDOC
## GET v1/job-abort-status

### Description
Returns the abort status for a given job. Polled by the abort UI to determine when a backup abort has completed.

### Method
GET

### Endpoint
v1/job-abort-status

### Parameters
#### Query Parameters
- **job_id** (integer) - Required - The ID of the job to check.

### Request Example
GET v1/job-abort-status?job_id=123

### Response
#### Success Response (200)
- **is_done** (boolean) - Whether the abort process has completed.

#### Response Example
{
  "is_done": true
}
```

--------------------------------

### GET /backwpup/v1/job-abort-status

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-backups.md

Polls the abort status of a specific job. The response includes an is_done field that indicates whether the abort has completed.

```APIDOC
## GET /backwpup/v1/job-abort-status

### Description
Polls the abort status of a specific job. The response includes an is_done field that indicates whether the abort has completed.

### Method
GET

### Endpoint
/backwpup/v1/job-abort-status

### Parameters
#### Query Parameters
- **job_id** (integer) - Required - The ID of the job to check.

### Request Example
GET /backwpup/v1/job-abort-status?job_id=3

### Response
#### Success Response (200)
- **is_done** (boolean) - Whether the abort has completed.

#### Response Example
{
  "is_done": true
}
```

--------------------------------

### Show log by filename using --file option

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Displays a BackWPup log using the `--file` option to specify the file basename. The output shows the log header and INFO lines.

```bash
$ wp backwpup log-show --file=backwpup_log_8a8bee_2025-11-03_06-30-29.html
[INFO] BackWPup 5.6.0; A project of WP Media
[INFO] WordPress 6.8.3 on https://backwpup-pro.ddev.site/
[INFO] Log Level: Debug
[INFO] BackWPup job: Files & Database; FILE+DBDUMP+WPPLUGIN
[INFO] Runs with user:  (0)
```

--------------------------------

### Encrypt a file using the key from settings

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Encrypts a file with the key stored in BackWPup settings. Outputs 'Success: Archive has been successfully encrypted.' on success.

```bash
$ wp backwpup backup-encrypt archiv.tar.gz
Success: Archive has been successfully encrypted.
```

--------------------------------

### Rest class skeleton with constructor and methods

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/rest-storage-cloud.md

Shows the class declaration, constructor signature, permission methods, and route handler method signatures for the storage providers API Rest controller.

```php
class Rest implements RestInterface {

	public function __construct(
		BackWPupHelpersAdapter $helpers_adapter,
		BackWPupAdapter $backwpup_adapter,
		OptionAdapter $option_adapter,
		CloudProviderManager $cloud_provider_manager
	);
	public function has_permission(): bool;        // current_user_can('backwpup')
	public function has_edit_permission(): bool;   // current_user_can(Capability::JOBS_EDIT)
	public function register_routes(): void;
	public function cloud_is_authenticated( WP_REST_Request $request );
	public function authenticate_cloud( WP_REST_Request $request );
	public function delete_auth_cloud( WP_REST_Request $request );
	public function cloud_save_and_test( WP_REST_Request $request );
	public function update_job_storage_options( WP_REST_Request $request );
}
```

--------------------------------

### AbstractOptions class signature

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/options.md

Abstract base class defining the option store interface. Only concrete method is has(), which returns null !== $this->get($name).

```php
abstract class AbstractOptions {

	abstract public function get( string $name, $default = null );
	abstract public function set( string $name, $value );
	abstract public function delete( string $name );
	public function has( string $name ): bool;
}
```

--------------------------------

### Options class signature

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/options.md

Concrete WordPress-option store with configurable prefix. Registered in the container as 'options_api' with prefix 'backwpup_'. Methods: get, get_option_name, set, delete.

```php
class Options extends AbstractOptions {

	public function __construct( string $prefix = '' );
	public function get( string $name, $default = null );
	public function get_option_name( string $name );
	public function set( string $name, $value );
	public function delete( string $name );
}
```

--------------------------------

### Deactivate job with wp backwpup job-activate --type=disable

Source: https://github.com/wp-media/backwpup/blob/master/src/Cli/wp-cli.md

Deactivates a job by setting the type to disable. The example shows deactivating job with ID 3.

```bash
# Deactivate job with ID 3
$ wp backwpup job-activate --job_id=3 --type=disable
Successes: Job with ID 3 deactivated
```

--------------------------------

### Enable and schedule a job, compute next run

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/api-reference/backwpup-core.md

Mirrors the REST updatejob path. Uses BackWPup_Job::enable_job and schedule_job, then computes the next run via BackWPup_Cron::cron_next. Logs an error if the cron expression is malformed (PHP_INT_MAX).

```php
// Enable a job and compute its next run (mirror of the REST updatejob path).
use WPMedia\BackWPup\Adapters\{JobAdapter, OptionAdapter, CronAdapter};

$jobs   = BackWPup_Job::get_jobs();
$job_id = (int) $jobs[0]['jobid'];

BackWPup_Job::enable_job( $job_id );
BackWPup_Job::schedule_job( $job_id );

$cron    = BackWPup_Option::get( $job_id, 'cron' );
$next    = BackWPup_Cron::cron_next( $cron );
$label   = sprintf(
	'%1$s at %2$s',
	wp_date( get_option( 'date_format' ), $next ),
	wp_date( get_option( 'time_format' ), $next )
);

if ( PHP_INT_MAX === $next ) {
	// Malformed cron expression — the job would never run.
	error_log( 'BackWPup: invalid cron expression for job ' . $job_id );
}
```

--------------------------------

### GET /wp-json/backwpup/v2/messages

Source: https://github.com/wp-media/backwpup/blob/master/_autodocs/endpoints.md

Reads the site option 'backwpup_messages' (default []) and immediately resets it to [] (fire-and-forget message queue). Requires the 'backwpup' permission. Returns the raw message array.

```APIDOC
## GET /wp-json/backwpup/v2/messages

### Description
Reads the site option 'backwpup_messages' (default []) and immediately resets it to [] (fire-and-forget message queue). Requires the 'backwpup' permission. Returns the raw message array.

### Method
GET

### Endpoint
/wp-json/backwpup/v2/messages

### Response
#### Success Response (200)
Raw message array.

```
Tokens:
Raw