WP-CLI

Dernière mise à jour 11 septembre 2024

WP-CLI (WordPress Command Line Interface) est un outil puissant pour gérer une installation WordPress directement à partir de la ligne de commande ou du terminal. Au lieu d’utiliser le tableau de bord standard de WordPress, vous pouvez exécuter des commandes pour effectuer des tâches telles que la mise à jour des extensions, la gestion des thèmes et la configuration des réglages, le tout à partir de votre terminal.

L’utilisation de WP-CLI présente un certain nombre d’avantages, notamment

Rapidité : Exécuter des tâches en ligne de commande est souvent plus rapide que de naviguer dans l’interface d’administration de WordPress, en particulier pour les tâches répétitives.
Automatisation : WP-CLI peut être intégré dans des scripts pour des flux de travail automatisés.
Gestion à distance : WP-CLI vous permet de gérer des sites WordPress à distance.
Flexibilité : La possibilité d’exécuter des commandes et des scripts offre un niveau de contrôle et de personnalisation.

Accéder à WP-CLI sur Kinsta

WP-CLI v2 est installé par défaut sur tous nos serveurs. Pour accéder à WP-CLI, vous devez vous connecter à votre serveur avec SSH et naviguer à la racine du document de votre site. Kinsta fournit un accès SSH avec tous nos plans d’hébergement WordPress infogérés.

1. Se connecter à votre serveur avec SSH

La méthode la plus simple pour se connecter via SSH est d’utiliser un nom d’utilisateur et un mot de passe. Les étapes de connexion varient en fonction de votre système d’exploitation.

Windows

Les utilisateurs de Windows ont besoin d’un client de terminal pour se connecter à SSH. Nous vous recommandons de télécharger le client gratuit PuTTY à l’aide du programme d’installation .msi.

Lancez PuTTY et saisissez l’adresse IP de votre hôte et le numéro de port unique (tous deux trouvés dans MyKinsta > Sites > nom du site > Info > SFTP/SSH). Cliquez ensuite sur Ouvrir.
Si c’est la première fois que vous vous connectez, vous verrez probablement une demande de clé rsa2. Cliquez sur Oui, ce qui permettra de faire confiance à l’hôte à l’avenir.
Dans l’écran du terminal, entrez votre nom d’utilisateur Kinsta (que vous trouverez dans MyKinsta > Sites > nom du site > Info > SFTP/SSH) et appuyez sur Entrée.
Saisissez votre mot de passe Kinsta (trouvé dans MyKinsta > Sites > nom du site > Info > SFTP/SSH) et appuyez à nouveau sur Entrée.

Vous êtes maintenant connecté via SSH à votre site WordPress.

Mac/Linux

Ouvrez un nouveau terminal depuis Applications > Utilitaires > Terminal.
Dans MyKinsta, naviguez vers Sites > nom du site > Info > SFTP/SSH, et sur la commande de terminal SSH, cliquez sur Copier dans le presse-papiers .
Collez la commande SSH dans le terminal et appuyez sur Entrée.
Saisissez votre mot de passe Kinsta (que vous trouverez dans MyKinsta > Sites > nom du site > Info > SFTP/SSH) et appuyez à nouveau sur Entrée.

Vous êtes maintenant connecté via SSH à votre site WordPress.

2. Naviguer vers la racine de votre site

Pour exécuter des commandes WP-CLI, vous devez d’abord vous rendre à la racine de votre site ; c’est là que se trouvent vos fichiers WordPress (tels que wp-config.php, wp-content, wp-admin, et wp-includes). Pour naviguer vers la racine de votre site sur Kinsta, entrez la commande suivante :

cd public

Vous pouvez maintenant utiliser les commandes WP-CLI sur votre installation WordPress hébergée sur Kinsta. Pour une liste complète des commandes WP-CLI disponibles, reportez-vous à la documentation du développeur WordPress.

Commandes WP-CLI utiles

Voici une liste de commandes WP-CLI qui pourraient vous être utiles. Pour une liste complète des commandes WP-CLI disponibles, y compris les réglages globaux et les options, reportez-vous à la documentation du développeur WordPress.

Options utiles

Voici une liste d’options utiles que vous pouvez ajouter à la fin de vos commandes :

--skip-themes: Ceci empêche le chargement des thèmes WordPress lorsque vous exécutez une commande WP-CLI. Ceci est utile s’il y a un problème dans un des thèmes qui cause des conflits avec les commandes WP-CLI.
--skip-plugins: Ceci empêche les extensions WordPress de se charger lorsque vous exécutez une commande WP-CLI. Ceci est utile s’il y a un problème dans l’une des extensions qui cause des conflits avec les commandes WP-CLI.
--all: Cette commande s’applique à tous les éléments concernés. Par exemple, si vous voulez mettre à jour toutes les extensions ou tous les utilisateurs.
--dry-run: Ceci peut être utilisé pour simuler l’exécution d’une commande sans faire de changements réels. Elle vous montre ce qui se passerait si la commande était exécutée, mais elle n’effectue aucune action. Par exemple, si vous exécutez une recherche et un remplacement, mettez à jour toutes les extensions ou supprimez des articles massivement.
--format=<format>: Spécifie le format de sortie lors de l’exportation de données. Par exemple, lorsque vous exécutez wp plugin list ou wp user list, vous pouvez vouloir que les données soient au format table, json ou csv.

Plugins

Afficher la liste des plugins

Voir une liste des extensions installées avec la commande suivante :

wp plugin list

Activer un plugin

Pour activer une extension, utilisez la commande suivante, en remplaçant $plugin par le nom de l’extension à partir de wp plugin list.

wp plugin activate $plugin

Désactiver un plugin

Pour désactiver une extension utilisez la commande suivante, en remplaçant $plugin par le nom de l’extension à partir de wp plugin list.

wp plugin deactivate $plugin

Mettre à jour un plugin spécifique

Pour mettre à jour une extension, utilisez la commande suivante, en remplaçant $plugin par le nom de l’extension à partir de wp plugin list.

wp plugin update $plugin

Mettre à jour tous les plugins

wp plugin update --all

Revenir en arrière sur un plugin

Si vous mettez à jour une extension qui casse quelque chose sur votre site, vous pouvez revenir en arrière en installant une version spécifique à l’aide de la commande suivante, en remplaçant $plugin par le nom de l’extension à partir de wp plugin list et $version par le numéro de version requis.

wp plugin update $plugin --version=$version

URL

Définir l’URL de la page d’accueil

Pour définir l’URL de votre page d’accueil, utilisez la commande suivante, en remplaçant $URL par l’URL nécessaire.

wp option update home '$URL'

Définir l’URL du site

Pour définir l’URL du site, utilisez la commande suivante, en remplaçant $URL par l’URL nécessaire.

wp option update siteurl '$URL'

Utilisateurs

Liste de tous les utilisateurs de WordPress

Voir la liste de tous les utilisateurs de WordPress à l’aide de la commande suivante :

wp user list

Créer un nouvel utilisateur

Pour créer un nouvel utilisateur, utilisez la commande suivante, en remplaçant $username et $emailaddress par les informations d’identification de l’utilisateur, et $role par le rôle que vous souhaitez attribuer au nouvel utilisateur, par exemple, administrateur.

wp user create $username $emailaddress -–role=$role

Réinitialiser le mot de passe d’un utilisateur

Pour réinitialiser le mot de passe d’un utilisateur, utilisez la commande suivante, en remplaçant $username parle nom d’utilisateur nécessaire dans la wp user list.

wp user reset-password $username

Mettre à jour les détails d’un utilisateur

Pour mettre à jour les données d’un utilisateur, utilisez la commande suivante, en remplaçant $user par le nom d’utilisateur nécessaire à partir de wp user list, $field par le champ que vous souhaitez mettre à jour et $value par les nouvelles données que vous souhaitez introduire.

wp user update $user -—$field=$value

Cache

Pour utiliser les commandes d’effacement du cache listées ci-dessous, l’extension Kinsta Must Use (MU) doit être installée sur le site.

Effacer tout le cache

Pour effacer tout le cache, y compris le cache du site, le cache edge, le cache CDN et le cache Redis, utilisez la commande suivante :

wp kinsta cache purge --all

Effacer le cache pleine page et le cache edge

Pour effacer le cache pleine page et le cache edge, utilisez la commande suivante :

wp kinsta cache purge

Effacer le cache du site sans effacer le cache edge

Pour effacer uniquement le cache du site, utilisez la commande suivante :

wp kinsta cache purge --site

Effacer le cache CDN

Pour effacer uniquement le cache du CDN, utilisez la commande suivante :

wp kinsta cache purge --cdn

Effacer le cache Redis

Pour effacer uniquement le cache Redis, utilisez la commande suivante :

wp kinsta cache purge --object

Vider le cache des objets

Videz le cache d’objets de votre site à l’aide de la commande suivante :

wp cache flush

Cela peut entrainer une légère augmentation temporaire des temps de chargement, le temps que le cache se reconstitue.

Recherche et remplacement

Lorsque vous effectuez une recherche et un remplacement sur votre site WordPress, nous vous recommandons d’effectuer une sauvegarde et d’utiliser l’option --dry-run pour voir ce qui sera remplacé avant d’exécuter la commande.

Remplacer un ancien domaine par un nouveau domaine

Pour remplacer une ancienne URL par une nouvelle, utilisez la commande suivante, en remplaçant $old-domain par l’URL que vous souhaitez remplacer et $new-domain par l’URL par laquelle vous souhaitez la remplacer :

wp search-replace '$old-domain' '$new-domain' --skip-columns=guid

--skip-columns=guid il est recommandé d’utiliser cette commande pour éviter de modifier accidentellement les URL stockées en tant qu’identifiants uniques dans la colonne guid de la base de données, ce qui pourrait perturber les URL des messages. Cette commande peut également être utilisée pour remplacer des domaines d’adresses électroniques.

Remplacer HTTP par HTTPS

Pour mettre à jour vos URL de HTTP à HTTPS, utilisez la commande suivante :

wp search-replace 'http://' 'https://' --skip-columns=guid

--skip-columns=guid il est recommandé d’utiliser cette commande pour éviter de modifier accidentellement les URL stockées en tant qu’identifiants uniques dans la colonne guid de la base de données, ce qui pourrait entrainer des problèmes avec les pièces jointes multimédias.

Résolution des problèmes

Si vous avez des difficultés à exécuter des commandes dans WP-CLI, cela peut être dû à une erreur fatale d’un thème ou d’une extension. Vous pouvez ajouter ce qui suit à votre commande WP-CLI pour ignorer le chargement des thèmes et des extensions :

--skip-themes --skip-plugins

Par exemple, pour obtenir une liste d’utilisateurs et ignorer les thèmes et les extensions, vous pouvez exécuter ce qui suit :

wp user list --skip-themes --skip-plugins

Si vous souhaitez ignorer des extensions spécifiques, vous pouvez utiliser ce qui suit, en remplaçant $plugin par le nom de l’extension et en utilisant une virgule pour séparer chaque pextension :

--skip-plugins=$plugin,$plugin

Par exemple :

wp user list --skip-plugins=wordpress-seo,wordfence