wp cli
Version 2.11.0
WP-CLI est l'interface de ligne de commande pour WordPress. Vous pouvez mettre à jour les plugins, configurer des installations multisites et bien plus encore, sans utiliser de navigateur Web.
La maintenance continue est rendue possible par :
La version stable actuelle est la version 2.11.0. Pour les annonces, suivez @wpcli sur Twitter ou inscrivez-vous pour recevoir des mises à jour par e-mail. Consultez la feuille de route pour un aperçu de ce qui est prévu pour les prochaines versions.
Liens rapides : Utilisation de | Installation | Assistance | Extension | Contribuer | Crédits
WP-CLI fournit une interface de ligne de commande pour de nombreuses actions que vous pouvez effectuer dans l'administrateur WordPress. Par exemple, wp plugin install --activate (doc) vous permet d'installer et d'activer un plugin WordPress :
$ wp plugin install user-switching --activate
Installing User Switching (1.0.9)
Downloading installation package from https://downloads.wordpress.org/plugin/user-switching.1.0.9.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating ' user-switching ' ...
Plugin ' user-switching ' activated.
Success: Installed 1 of 1 plugins. WP-CLI inclut également des commandes pour de nombreuses choses que vous ne pouvez pas faire dans l'administrateur WordPress. Par exemple, wp transient delete --all (doc) vous permet de supprimer un ou tous les transitoires :
$ wp transient delete --all
Success: 34 transients deleted from the database.Pour une introduction plus complète à l’utilisation de WP-CLI, lisez le guide de démarrage rapide. Ou retrouvez des amis shell pour en savoir plus sur les utilitaires de ligne de commande utiles.
Vous vous sentez déjà à l’aise avec les bases ? Accédez à la liste complète des commandes pour obtenir des informations détaillées sur la gestion des thèmes et des plugins, l'importation et l'exportation de données, l'exécution d'opérations de recherche-remplacement de base de données et bien plus encore.
Le téléchargement du fichier Phar est notre méthode d'installation recommandée pour la plupart des utilisateurs. Si vous en avez besoin, consultez également notre documentation sur les méthodes d'installation alternatives (Composer, Homebrew, Docker).
Avant d'installer WP-CLI, veuillez vous assurer que votre environnement répond à la configuration minimale requise :
Une fois que vous avez vérifié les exigences, téléchargez le fichier wp-cli.phar en utilisant wget ou curl :
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.pharEnsuite, vérifiez le fichier Phar pour vérifier qu'il fonctionne :
php wp-cli.phar --info Pour utiliser WP-CLI à partir de la ligne de commande en tapant wp , rendez le fichier exécutable et déplacez-le quelque part dans votre PATH. Par exemple:
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp Si WP-CLI a été installé avec succès, vous devriez voir quelque chose comme ceci lorsque vous exécutez wp --info :
$ wp --info
OS: Linux 5.10.60.1-microsoft-standard-WSL2 # 1 SMP Wed Aug 25 23:20:18 UTC 2021 x86_64
Shell: /usr/bin/zsh
PHP binary: /usr/bin/php8.1
PHP version: 8.1.0
php.ini used: /etc/php/8.1/cli/php.ini
MySQL binary: /usr/bin/mysql
MySQL version: mysql Ver 8.0.27-0ubuntu0.20.04.1 for Linux on x86_64 (( Ubuntu ))
SQL modes:
WP-CLI root dir: /home/wp-cli/
WP-CLI vendor dir: /home/wp-cli/vendor
WP_CLI phar path:
WP-CLI packages dir: /home/wp-cli/.wp-cli/packages/
WP-CLI global config:
WP-CLI project config: /home/wp-cli/wp-cli.yml
WP-CLI version: 2.11.0 Vous pouvez mettre à jour WP-CLI avec wp cli update (doc), ou en répétant les étapes d'installation.
Si WP-CLI appartient à root ou à un autre utilisateur système, vous devrez exécuter sudo wp cli update .
Vous voulez vivre à la limite ? Exécutez wp cli update --nightly pour utiliser la dernière version nocturne de WP-CLI. La version nocturne est plus ou moins suffisamment stable pour que vous puissiez l'utiliser dans votre environnement de développement et inclut toujours les dernières et meilleures fonctionnalités WP-CLI.
WP-CLI est également livré avec un script de complétion d'onglets pour Bash et ZSH. Téléchargez simplement wp-completion.bash et sourcez-le à partir de ~/.bash_profile :
source /FULL/PATH/TO/wp-completion.bash N'oubliez pas d'exécuter source ~/.bash_profile ensuite.
Si vous utilisez zsh pour votre shell, vous devrez peut-être charger et démarrer bashcompinit avant de rechercher. Mettez ce qui suit dans votre .zshrc :
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bashLes responsables et contributeurs de WP-CLI ont une disponibilité limitée pour répondre aux questions de support général. La version actuelle de WP-CLI est la seule version officiellement prise en charge.
Lorsque vous recherchez de l'aide, veuillez d'abord rechercher votre question sur ces sites :
Si vous n'avez pas trouvé de réponse dans l'un des lieux ci-dessus, vous pouvez :
#cli dans WordPress.org Slack pour discuter avec toute personne disponible à ce moment-là. Cette option est la meilleure pour les questions rapides.Les problèmes GitHub sont destinés au suivi des améliorations et des bogues des commandes existantes, et non à une assistance générale. Avant de soumettre un rapport de bug, veuillez consulter nos meilleures pratiques pour vous assurer que votre problème est résolu dans les meilleurs délais.
Veuillez ne pas poser de questions d'assistance sur Twitter. Twitter n'est pas un lieu d'assistance acceptable car : 1) il est difficile de tenir des conversations en moins de 280 caractères, et 2) Twitter n'est pas un endroit où une personne ayant la même question peut rechercher une réponse dans une conversation antérieure.
Rappelez-vous, libre != gratis; la licence open source vous accorde la liberté d'utilisation et de modification, mais pas l'engagement du temps d'autrui. Soyez respectueux et définissez vos attentes en conséquence.
Une commande est l'unité atomique de la fonctionnalité WP-CLI. wp plugin install (doc) est une commande. wp plugin activate (doc) en est un autre.
WP-CLI prend en charge l’enregistrement de toute classe, fonction ou fermeture appelable en tant que commande. Il lit les détails d'utilisation du PHPdoc du rappel. WP_CLI::add_command() (doc) est utilisé pour l'enregistrement des commandes internes et tierces.
/**
* Delete an option from the database.
*
* Returns an error if the option didn't exist.
*
* ## OPTIONS
*
* <key>
* : Key for the option.
*
* ## EXAMPLES
*
* $ wp option delete my_option
* Success: Deleted 'my_option' option.
*/
$ delete_option_cmd = function ( $ args ) {
list ( $ key ) = $ args ;
if ( ! delete_option ( $ key ) ) {
WP_CLI :: error ( " Could not delete ' $ key ' option. Does it exist? " );
} else {
WP_CLI :: success ( " Deleted ' $ key ' option. " );
}
};
WP_CLI :: add_command ( ' option delete ' , $ delete_option_cmd );WP-CLI est livré avec des dizaines de commandes. Il est plus facile qu'il n'y paraît de créer une commande WP-CLI personnalisée. Lisez le livre de recettes des commandes pour en savoir plus. Parcourez la documentation interne de l'API pour découvrir une variété de fonctions utiles que vous pouvez utiliser dans votre commande WP-CLI personnalisée.
Nous vous remercions d'avoir pris l'initiative de contribuer à WP-CLI. C'est grâce à vous et à la communauté qui vous entoure que WP-CLI est un si beau projet.
La contribution ne se limite pas au code. Nous vous encourageons à contribuer de la manière qui correspond le mieux à vos capacités, en écrivant des didacticiels, en faisant une démonstration lors de votre rencontre locale, en aidant les autres utilisateurs avec leurs questions d'assistance ou en révisant notre documentation.
Lisez nos directives de contribution dans le manuel pour une introduction complète à la manière dont vous pouvez vous impliquer. Suivre ces directives permet de communiquer que vous respectez le temps des autres contributeurs du projet. En retour, ils feront de leur mieux pour vous rendre la pareille lorsqu'ils travailleront avec vous, quels que soient les fuseaux horaires et partout dans le monde.
WP-CLI a un seul responsable de projet : schlessera.
À l'occasion, nous accordons un accès en écriture aux contributeurs qui ont démontré, sur une période de temps, qu'ils sont capables et investis pour faire avancer le projet.
Lisez le document de gouvernance dans le manuel pour plus de détails opérationnels sur le projet.
Outre les bibliothèques définies dans composer.json, nous avons utilisé du code ou des idées des projets suivants :
wp shellwp media regeneratewp search-replacewp exportwp importwp scaffold plugin-tests
