TeamUpdraft

https://teamupdraft.com/documentation/
Admin
TeamUpdraft is a collection of WordPress plugins providing backup and restore (UpdraftPlus),...
Tokens:79,183
Snippets:1,670
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Create a WordPress-Only UpdraftClone

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Boot a blank clone with only WordPress installed by using the --wp-only flag. Defaults to False.

```bash
wp updraftplus updraftclone --user="USER NAME/EMAIL/ID" --clone-key="CLONE_KEY" --wp-only
```

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

### List Installed Plugins via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

View a list of all installed WordPress plugins using this command.

```bash
wp plugin list
```

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

### Install UpdraftPlus Plugin via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Use this command to install the free version of the UpdraftPlus plugin.

```bash
wp plugin install updraftplus
```

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

### Install and Activate UpdraftPlus Plugin via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

This command installs and activates the UpdraftPlus plugin in one step.

```bash
wp plugin install updraftplus --activate
```

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

### Configure WordPress multisite environment

Source: https://teamupdraft.com/documentation/updraftplus/topics/advanced-usage/faqs/can-i-run-backups-from-the-shell-cron

Sets server variables required for multisite installations before loading WordPress.

```php
$_SERVER['HTTP_HOST'] = 'site.localdomain';
$_SERVER['REQUEST_URI'] = '/';
```

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

### Get Help for AIOS WP-CLI Commands

Source: https://teamupdraft.com/documentation/all-in-one-security/faqs/what-are-the-plugin-commands-avaliable

Use these commands to view available AIOS plugin commands and their specific help information.

```bash
wp aios set --help
```

```bash
wp aios reset --help
```

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

### Perform Manual Incremental Backup via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-create-incremental-backups-in-wordpress

Use this command to create an incremental backup after a full backup has been established. Ensure WP-CLI is installed and configured.

```bash
wp updraftplus backup --incremental
```

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

### Identify AIOS database tables

Source: https://teamupdraft.com/documentation/all-in-one-security/faqs/remove-aios-plugin

Example of table naming conventions used by AIOS in the WordPress database.

```text
wp_aiowps_events
wp_aiowps_login_activity
```

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

### Example .htaccess Configuration for Litespeed

Source: https://teamupdraft.com/documentation/updraftplus/topics/restoration/troubleshooting/why-isnt-my-restoration-completing

This is a placeholder for .htaccess file modifications when using the Litespeed web server. Consult specific Litespeed documentation for the correct directives.

```apache
# Example Litespeed configuration directive
# RewriteEngine On
```

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

### View cache debug information in HTML source

Source: https://teamupdraft.com/documentation/wp-optimize/topics/caching/faqs/how-do-i-know-what-cache-file-is-being-used-for-displaying-a-page

Example of the debug output appended to the bottom of the HTML source after enabling debug mode.

```html
<!-- Cached by WP-Optimize (gzip) -https://getwpo.com- Last modified: Wed, 01 Dec 2021 10:47:38 GMT --><!-- WP Optimize page cache debug information -->
<!-- 
Extension: .html
Filename: index.html
 --->
```

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

### Example File Permission Error Log

Source: https://teamupdraft.com/documentation/updraftplus/topics/restoration/troubleshooting/why-isnt-my-restoration-completing

This error suggests that WordPress lacks the necessary file and folder permissions to complete the restoration. Contact your hosting provider for assistance with file permissions.

```log
Could not move the files into place
```

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

### Execute a full backup from shell or cron

Source: https://teamupdraft.com/documentation/updraftplus/topics/advanced-usage/faqs/can-i-run-backups-from-the-shell-cron

Initializes the WordPress environment and triggers a full backup including remote storage.

```php
<?php

define('UPDRAFTPLUS_CONSOLELOG', true);
define('DOING_CRON', true);
require_once('wp-load.php');
do_action('updraft_backupnow_backup_all', array('nocloud' => 0));
```

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

### List Available Optimizations

Source: https://teamupdraft.com/documentation/wp-optimize/topics/general/faqs/how-do-i-use-the-command-line-feature

Run this command to retrieve a list of all available optimization tasks that can be executed via WP-CLI.

```bash
wp optimize optimizations
```

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

### Initiate Full Backup via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-create-incremental-backups-in-wordpress

This command initiates a full backup of your WordPress system using WP-CLI. It serves as a prerequisite for creating incremental backups via the command line.

```bash
wp updraftplus backup
```

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

### Update All Plugins via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Update all installed WordPress plugins simultaneously with this command.

```bash
wp plugin update --all
```

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

### Create an UpdraftClone with WordPress Version

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Specify the WordPress version for the clone using the --wp parameter. Defaults to the WordPress version the site is currently running.

```bash
wp updraftplus updraftclone --user="USER NAME/EMAIL/ID" --clone-key="CLONE_KEY" --wp="5.8"
```

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

### Create an UpdraftClone with a Specific Package

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Select a specific clone package to use for the clone creation with the --package parameter. Defaults to the starter package.

```bash
wp updraftplus updraftclone --user="USER NAME/EMAIL/ID" --clone-key="CLONE_KEY" --package="size2"
```

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

### Basic Restore Command

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Use this command to initiate a backup restoration. Replace <nonce> with the unique identifier of the backup set.

```bash
wp updraftplus restore <nonce>
```

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

### Display Existing Backups

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Lists all existing backups for the site. This command helps in managing backup sets.

```bash
wp updraftplus existing_backups
```

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

### Identify Network Timeout Error Log

Source: https://teamupdraft.com/documentation/updraftplus/topics/backing-up/faqs/what-does-the-error-operation-timed-out-after-number-milliseconds-with-0-bytes-received-mean

Example of a log entry indicating a failed upload due to a network timeout.

```text
5226.206 (9) ERROR: Google Drive upload error: Operation timed out after 60004 milliseconds with 0 bytes received (line: 117, file: /home/leehawki/public_html/wp-content/plugins/updraftplus/includes/Google/IO/Curl.php)
```

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

### Resume an existing backup job

Source: https://teamupdraft.com/documentation/updraftplus/topics/advanced-usage/faqs/can-i-run-backups-from-the-shell-cron

Resumes a previously started backup job using its unique 12-digit hex identifier.

```php
do_action('updraft_backup_resume', 'fbb7e2919e0c', 1);
```

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

### Create an Admin-Only UpdraftClone

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Create a clone that only allows administrators to log in by using the --admin-only flag. Defaults to False.

```bash
wp updraftplus updraftclone --user="USER NAME/EMAIL/ID" --clone-key="CLONE_KEY" --admin-only
```

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

### Example Memory Exhaustion Error Log

Source: https://teamupdraft.com/documentation/updraftplus/topics/restoration/troubleshooting/why-isnt-my-restoration-completing

This error signifies that WordPress has exceeded its allocated memory limit. Increase the memory limit to resolve this.

```log
Allowed memory size of 268435456 bytes exhausted
```

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

### Example Corrupted Zip Error Log

Source: https://teamupdraft.com/documentation/updraftplus/topics/restoration/troubleshooting/why-isnt-my-restoration-completing

This log message indicates a corrupted zip file during restoration. Re-download and re-upload the files to resolve this.

```log
PCLZIP_ERR_BAD_FORMAT (-10)
```

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

### Identify Permission Denied Error Log

Source: https://teamupdraft.com/documentation/updraftplus/topics/general/troubleshooting/there-is-a-permission-denied-error-when-updraftplus-tries-to-contact-remote-storage

Example of the specific error message format indicating a server-side restriction on outgoing network connections.

```text
PHP event: code E_USER_NOTICE: Cannot connect to server.example.com:1234 Error 13. Permission denied
```

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

### Dummy Database Restore for Timeout Check

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Perform a dummy restore of the database with a random prefix to check for process timeouts. All dummy tables are deleted after completion. This is optional.

```bash
wp updraftplus restore [nonce] --components="db" --db-dummy-restore=true
```

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

### Exclude Directories with WordPress Filter - PHP

Source: https://teamupdraft.com/documentation/updraftplus/topics/backing-up/faqs/how-can-i-exclude-certain-files-and-directories-from-a-backup

Implement this filter in your mu-plugin or functions.php to exclude specific directories from backups. The example skips all .git directories.

```php
add_filter('updraftplus_exclude_directory', 'my_updraftplus_exclude_directory', 10, 2);
function my_updraftplus_exclude_directory($filter, $dir) {
return (basename($dir) == '.git') ? true : $filter;
}
```

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

### List Incremental Backups

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Displays a list of all available incremental backups. Useful for tracking changes over time.

```bash
wp updraftplus incremental_backups
```

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

### Take a Backup with UpdraftPlus via WP-CLI

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Initiate a backup of your WordPress site using the default settings. You can add parameters to customize the backup process.

```bash
wp updraftplus backup
```

```bash
wp updraftplus backup --label="UpdraftplusCLI Backup"
```

```bash
wp updraftplus backup --exclude-db=true
```

```bash
wp updraftplus backup --send-to-cloud=false
```

```bash
wp updraftplus backup --include-files= "plugins,themes,uploads"
```

```bash
wp updraftplus backup --include-tables= "wp_posts,wp_postmeta"
```

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

### Create an UpdraftClone

Source: https://teamupdraft.com/documentation/updraftplus/premium-features/how-to-operate-updraftplus-from-the-wp-cli

Use this command to create a clone of your WordPress site. You must provide a valid WordPress user and a clone key.

```bash
wp updraftplus updraftclone –user=”USER NAME/EMAIL/ID” –clone-key=”CLONE_KEY”
```

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

### Exclude Files with WordPress Filter - PHP

Source: https://teamupdraft.com/documentation/updraftplus/topics/backing-up/faqs/how-can-i-exclude-certain-files-and-directories-from-a-backup

Use this filter in your mu-plugin or functions.php to prevent specific files from being backed up. The example excludes any file named 'bertie.jpg'.

```php
add_filter('updraftplus_exclude_file', 'my_updraftplus_exclude_file', 10, 2);
function my_updraftplus_exclude_file($filter, $file) {
return (basename($file) == 'bertie.jpg') ? true : $filter;
}
```
Tokens:
Raw