Réglages et périmètre avec WP-CLI

Avec wp cloneworx-backup settings, tu lis et modifies les réglages qui valent pour tout le site. Avec wp cloneworx-backup scope, tu vois ce qui fait partie de ton site et tu définis ce qui n’entre jamais dans une sauvegarde.

WP-CLI manque encore ? Le guide se trouve dans Installer WP-CLI. Toutes les commandes de l’extension sont présentées dans Les commandes en un coup d’œil.

Ce qui appartient à un plan de sauvegarde ou à une destination n’est pas ici : tu le modifies avec wp cloneworx-backup plan et wp cloneworx-backup target. Les sorties des commandes sont en anglais.

Afficher les réglages : settings list

settings list affiche tous les réglages avec leur valeur. Sans action, wp cloneworx-backup settings fait la même chose. L’action n’a pas de paramètres.

# Afficher tous les réglages
wp cloneworx-backup settings list

Chaque ligne indique une clé et sa valeur. (default) après la valeur signifie : la valeur est celle par défaut et n’a jamais été enregistrée. Les interrupteurs apparaissent comme on ou off. Si aucune adresse e-mail n’est saisie, la dernière ligne indique l’adresse d’administration du site : c’est là que vont les notifications.

Lire et définir un réglage : settings get, set

settings get affiche la valeur d’une clé. settings set enregistre une nouvelle valeur. La clé et la valeur figurent sans paramètre après l’action.

Clé	Dans l’interface	Valeurs autorisées	Par défaut
notify_emails	Adresses e-mail	jusqu’à 5 adresses comme une seule valeur, séparées par des virgules	vide : les notifications vont à l’adresse d’administration du site.
notify_errors	En cas d’erreurs et d’avertissements	on, off	on
notify_success	En cas de succès	on, off	off
notify_overdue	Quand la dernière bonne sauvegarde est plus ancienne que ne le permet le plan	on, off	on
step_max_seconds	Durée maximale par étape	5 à 20 (secondes)	20
step_pause_seconds	Pause entre les étapes	0 à 60 (secondes)	0
log_keep_days	Conserver les journaux pendant	7 à 365 (jours)	30
manual_retention	Sauvegardes max. sans plan	1 à 99	7
remove_all_on_delete	À la suppression de l’extension, retirer tous les réglages et l’index. Les sauvegardes sont conservées.	on, off	off

# Lire un réglage
wp cloneworx-backup settings get step_max_seconds

# Régler la durée maximale par étape à 10 secondes
wp cloneworx-backup settings set step_max_seconds 10

# Saisir deux destinataires pour les notifications
wp cloneworx-backup settings set notify_emails "eins@example.com, zwei@example.com"

# Activer l’e-mail après chaque sauvegarde réussie
wp cloneworx-backup settings set notify_success on

Après l’enregistrement, la commande confirme la clé et la valeur. Si l’extension n’accepte pas une valeur, elle n’enregistre rien. La commande se termine alors par une erreur et indique la raison entre parenthèses :

Raison	Signification
unknown	La clé n’existe pas.
type	La valeur est du mauvais type, par exemple du texte au lieu d’un nombre.
range	Le nombre est hors des limites. La commande indique les limites autorisées.
email	Une adresse n’est pas une adresse e-mail valide.
too_many	Il y a plus de 5 adresses.

L’effet de chaque réglage est expliqué dans La page « Réglages ».

remove_all_on_delete n’agit que lorsque tu supprimes l’extension dans WordPress. Avec on, l’extension demande alors d’abord à Dropbox de retirer l’accès de chaque destination de type Dropbox, puis supprime les réglages, les destinations, la liste des sauvegardes et les journaux. Avec off, tout reste dans la base de données, et l’extension ne retire rien. Les sauvegardes sont conservées dans les deux cas. Pour en savoir plus : Désinstaller l’extension.

Rétablir tous les réglages : settings reset

settings reset rétablit toutes les clés du tableau ci-dessus à leurs valeurs par défaut. Les exclusions et la liste des tables restent telles quelles.

# Rétablir tous les réglages aux valeurs par défaut
wp cloneworx-backup settings reset

Afficher le périmètre : scope

Le périmètre indique ce qui fait partie de ton site : quels dossiers, quelles tables de la base de données et ce qui est omis. scope l’affiche. La partie après scope choisit ce que tu vois :

Partie	Ce que la sortie affiche
roots	Les racines avec leur emplacement sur le serveur. Pour la base de données figure database. not found signifie : l’extension n’a pas trouvé l’emplacement. Entre parenthèses figurent des indications, par exemple inside pour une racine qui se trouve dans une autre, ou missing pour un dossier qui n’existe pas.
tables	Le préfixe et le nombre de tables, puis chaque table. view marque une vue, structure only une table dont seule la structure est sauvegardée. Un avertissement nomme les tables d’une autre installation WordPress dans la même base de données : ces tables ne sont pas sauvegardées.
exclusions	Les règles d’exclusion en vigueur. default dans le titre signifie : la valeur par défaut s’applique. stored signifie : tes propres règles s’appliquent. En dessous figurent les dossiers que d’autres extensions définissent pour leur cache ou leurs journaux, et ce qui est toujours exclu.
all	Les trois parties. C’est la valeur par défaut sans indication.

# Tout afficher
wp cloneworx-backup scope

# Afficher seulement les racines
wp cloneworx-backup scope roots

# Afficher seulement les tables
wp cloneworx-backup scope tables

Les racines

Une racine est une partie nommée du site. Tu as besoin des noms pour --roots lors d’une sauvegarde, d’un plan de sauvegarde et d’une restauration.

Racine	Contenu
db	Les tables de la base de données de ce site.
wp-config	Le fichier wp-config.php. L’extension sauvegarde le fichier, mais ne le restaure jamais lors d’une restauration.
wp-content	Tout ce qui, dans wp-content, n’appartient pas aux extensions, aux thèmes, aux mu-plugins ou aux téléversements : fichiers de langue, drop-ins, dossiers d’autres extensions.
wp-core	Le cœur de WordPress : les dossiers wp-admin et wp-includes et les fichiers que WordPress livre dans le dossier racine.
wp-mu-plugins	Le dossier des mu-plugins.
wp-plugins	Le dossier des extensions.
wp-themes	Le dossier des thèmes.
wp-uploads	Le dossier des téléversements.
wp-root	Tout le reste dans le dossier racine du site, par exemple .htaccess et robots.txt.

Définir les règles d’exclusion : scope exclusions

Les règles d’exclusion valent pour tout le site et pour chaque plan de sauvegarde. Ce qu’une règle touche n’entre dans aucune sauvegarde.

Paramètre	Signification	Valeurs autorisées
--set	Remplace toute la liste des règles par celles indiquées.	Règles, séparées par des virgules
--reset	Rétablit la valeur par défaut.	sans valeur
--force	Définit aussi en tant qu’un autre utilisateur que celui à qui appartiennent les dossiers de l’extension.	sans valeur

--set et --reset n’agissent qu’avec la partie exclusions. Une règle a l’une de trois formes :

Forme	Signification	Exemple
Nom	Un fichier ou un dossier portant exactement ce nom, à toute profondeur et dans toute racine. Avec une barre oblique à la fin, la règle ne touche que les dossiers.	.DS_Store, updraft/
Nom avec étoile	Un nom qui commence ou se termine ainsi. Une seule étoile est autorisée, au début ou à la fin.	*.log, backwpup*
Chemin	Un chemin dans une racine. La première partie est le nom de la racine. La règle touche l’entrée et tout ce qui est en dessous.	wp-content/cache

Un chemin commence par wp-content, wp-uploads, wp-plugins, wp-themes, wp-mu-plugins, wp-core ou wp-root. La casse ne joue aucun rôle.

# Afficher les règles en vigueur
wp cloneworx-backup scope exclusions

# Remplacer la liste par trois règles personnelles
wp cloneworx-backup scope exclusions --set="wp-content/cache,*.log,.DS_Store"

# Rétablir la valeur par défaut
wp cloneworx-backup scope exclusions --reset

L’extension vérifie chaque règle avant l’enregistrement. Si une règle n’est pas valide, elle n’enregistre rien : la commande se termine par une erreur et nomme chaque règle non valide avec la raison. Après l’enregistrement, elle indique le nombre de règles et affiche la liste qui s’applique désormais.

Sauvegarder des tables seulement en structure : scope tables

Certaines extensions tiennent des tables pour les sessions, les journaux, les caches ou les statistiques, qui deviennent volumineuses. Pour de telles tables, tu peux définir que chaque sauvegarde ne sauvegarde que la structure et omet les lignes. Par défaut, l’extension sauvegarde chaque table entièrement.

Paramètre	Signification	Valeurs autorisées
--structure-only	Remplace la liste des tables dont seule la structure est sauvegardée. Une valeur vide vide la liste.	Noms de tables sans préfixe, séparés par des virgules
--force	Définit aussi en tant qu’un autre utilisateur que celui à qui appartiennent les dossiers de l’extension.	sans valeur

Le paramètre n’agit qu’avec la partie tables.

# Sauvegarder deux tables en structure seulement
wp cloneworx-backup scope tables --structure-only="woocommerce_sessions,wfHits"

# Vider la liste : sauvegarder de nouveau chaque table en entier
wp cloneworx-backup scope tables --structure-only=""

• Le nom figure sans le préfixe des tables : woocommerce_sessions, pas wp_woocommerce_sessions.
• Seules les tables de ce site sont autorisées. Si tu nommes une table qui n’existe pas, l’extension n’enregistre rien, et la commande nomme les noms inconnus.
• Les propres tables de l’extension ne sont pas proposées au choix : d’elles, seule la structure est toujours sauvegardée.
• Lors d’une restauration, une telle table reste telle qu’elle est sur le site, avec ses données. Si elle n’y existe pas, l’extension la crée vide.

Après l’enregistrement, la commande indique le nombre de tables et affiche la liste de toutes les tables avec leurs étiquettes.

Voir aussi

• La page « Réglages »
• Définir ce qui est sauvegardé
• Configurer les notifications par e-mail
• Adapter l’extension à ton serveur
• Désinstaller l’extension