kommandoradsgränssnittet för WordPress

BY admin
|

WP-CLI är kommandoradsgränssnittet för WordPress. Du kan uppdatera plugins, konfigurera multisite installationer och mycket mer, utan att använda en webbläsare.

löpande underhåll möjliggörs av:

den nuvarande stabila versionen är version 2.4.0. För meddelanden, Följ @wpcli på Twitter eller registrera dig för e-postuppdateringar. Kolla in färdplanen för en översikt över vad som planeras för kommande utgåvor.

Byggstatus genomsnittlig tid för att lösa ett problem procentandel av problem som fortfarande är öppna

Snabblänkar: använda | Installera | Support | utvidga | bidra | krediter

använda

WP-CLI tillhandahåller ett kommandoradsgränssnitt för många åtgärder du kan utföra i WordPress admin. Till exempel, wp plugin install --activate(doc) låter dig installera och aktivera ett WordPress-plugin:

$ wp plugin install user-switching --activateInstalling 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 innehåller också kommandon för många saker du inte kan göra i WordPress admin. Till exempel, wp transient delete --all (doc) kan du ta bort en eller alla transienter:

$ wp transient delete --allSuccess: 34 transients deleted from the database.

för en mer fullständig introduktion till att använda WP-CLI, läs snabbstartsguiden. Eller, kom ikapp med shell-vänner för att lära dig mer om användbara kommandoradsverktyg.

känner du dig redan bekväm med grunderna? Hoppa in i den kompletta listan med kommandon för detaljerad information om hantering av teman och plugins, importera och exportera data, utföra databassökning-ersätt operationer och mer.

installera

ladda ner Phar-filen är vår rekommenderade installationsmetod för de flesta användare. Om du behöver, se även vår dokumentation om alternativa installationsmetoder (Composer, Homebrew, Docker).

innan du installerar WP-CLI, se till att din miljö uppfyller minimikraven:

  • UNIX – liknande miljö (OS X, Linux, FreeBSD, Cygwin); begränsat stöd i Windows-miljö
  • PHP 5.6 eller senare
  • WordPress 3.7 eller senare. Versioner som är äldre än den senaste WordPress-versionen kan ha försämrad funktionalitet

när du har verifierat kraven, ladda ner wp-cli.phar-fil med wget eller curl:

curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

kontrollera sedan Phar-filen för att verifiera att den fungerar:

php wp-cli.phar --info

för att använda WP-CLI från kommandoraden genom att skriva wp, gör filen körbar och flytta den till någonstans i din sökväg. Till exempel:

chmod +x wp-cli.pharsudo mv wp-cli.phar /usr/local/bin/wp

om WP-CLI installerades framgångsrikt bör du se något liknande när du kör wp --info:

$ wp --infoOS:Darwin 16.7.0 Darwin Kernel Version 16.7.0: Thu Jan 11 22:59:40 PST 2018; root:xnu-3789.73.8~1/RELEASE_X86_64 x86_64Shell:/bin/zshPHP binary: /usr/local/bin/phpPHP version: 7.0.22php.ini used: /etc/local/etc/php/7.0/php.iniWP-CLI root dir: /home/wp-cli/.wp-cli/vendor/wp-cli/wp-cliWP-CLI vendor dir: /home/wp-cli/.wp-cli/vendorWP-CLI packages dir: /home/wp-cli/.wp-cli/packages/WP-CLI global config: /home/wp-cli/.wp-cli/config.ymlWP-CLI project config:WP-CLI version: 2.4.0

Uppdatering

du kan uppdatera WP-CLI med wp cli update (doc), eller genom att upprepa installationsstegen.

om WP-CLI ägs av root eller en annan systemanvändare måste du köra sudo wp cli update.

vill du leva livet på kanten? Kör wp cli update --nightly för att använda den senaste nattliga byggnaden av WP-CLI. Den nattliga byggnaden är mer eller mindre stabil nog för att du ska kunna använda i din utvecklingsmiljö och innehåller alltid de senaste och bästa WP-CLI-funktionerna.

Flikkompletioner

WP-CLI kommer också med ett flikkompletteringsskript för Bash och ZSH. Ladda bara ner WP-completion.bash och källa det från ~/.bash_profile:

source /FULL/PATH/TO/wp-completion.bash

glöm inte att springa source ~/.bash_profile efteråt.

om du använder zsh för ditt skal kan du behöva ladda och starta bashcompinit innan du köper. Lägg följande i din .zshrc:

autoload bashcompinitbashcompinitsource /FULL/PATH/TO/wp-completion.bash

Support

WP-CLIs underhållare och bidragsgivare har begränsad tillgänglighet för att ta itu med allmänna supportfrågor. Den nuvarande versionen av WP-CLI är den enda officiellt stödda versionen.

när du letar efter support, vänligen sök först efter din fråga på dessa platser:

  • vanliga problem och deras korrigeringar
  • WP-CLI handbook
  • öppna eller stängda problem i WP-CLI GitHub organisation
  • trådar taggade ’WP – CLI’ i WordPress.org supportforum
  • frågor taggade ’WP-CLI’ i WordPress StackExchange

om du inte hittade ett svar på någon av platserna ovan kan du:

  • gå med i #cli – kanalen i WordPress.org Slack att chatta med vem som helst kan vara tillgängliga vid tidpunkten. Det här alternativet är bäst för snabba frågor.
  • Lägg upp en ny tråd i WordPress.org supportforum och tagga det ’WP-CLI’ så det ses av samhället.

GitHub-problem är avsedda för spårning av förbättringar och buggar av befintliga kommandon, inte allmänt stöd. Innan du skickar in en felrapport, läs våra bästa metoder för att säkerställa att ditt problem åtgärdas i tid.

Vänligen fråga inte supportfrågor på Twitter. Twitter är inte en acceptabel plats för support eftersom: 1) Det är svårt att hålla konversationer på under 280 tecken, och 2) Twitter är inte en plats där någon med samma fråga kan söka efter ett svar i en tidigare konversation.

kom ihåg, libre != gratis; open source-licensen ger dig friheten att använda och ändra, men inte åtaganden från andras tid. Var respektfull, och ställ dina förväntningar därefter.

utvidga

ett kommando är atomenheten för WP-CLI-funktionalitet. wp plugin install (doc) är ett kommando. wp plugin activate (doc) är en annan.

WP-CLI stöder registrering av en anropbar klass, funktion eller stängning som ett kommando. Den läser användningsinformation från återuppringnings PHPdoc. WP_CLI::add_command() (doc) används för både intern och tredjeparts kommandoregistrering.

/** * 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 kommer med dussintals kommandon. Det är lättare än det ser ut att skapa ett anpassat WP-CLI-kommando. Läs kommandona kokbok för att lära dig mer. Bläddra i de interna API-dokumenten för att upptäcka en mängd användbara funktioner som du kan använda i ditt anpassade WP-CLI-kommando.

bidragande

vi uppskattar att du tar initiativ till att bidra till WP-CLI. Det är på grund av dig, och samhället omkring dig, att WP-CLI är ett så bra projekt.

bidragande är inte begränsat till bara kod. Vi uppmuntrar dig att bidra på det sätt som bäst passar dina förmågor, genom att skriva handledning, ge en demo på din lokala meetup, hjälpa andra användare med deras supportfrågor, eller revidera vår dokumentation.

Läs igenom våra bidragande riktlinjer i handboken för en grundlig introduktion till hur du kan engagera dig. Att följa dessa riktlinjer hjälper till att kommunicera att du respekterar tiden för andra bidragsgivare på projektet. I sin tur kommer de att göra sitt bästa för att återfå den respekten när de arbetar med dig, över tidszoner och runt om i världen.

ledarskap

WP-CLI har en projektansvarig: schlessera.

ibland ger vi skrivåtkomst till bidragsgivare som under en tidsperiod har visat att de är kapabla och investerade i att flytta projektet framåt.

Läs styrdokumentet i handboken för mer operativa detaljer om projektet.

krediter

förutom de bibliotek som definieras i composer.json, vi har använt kod eller ideer från följande projekt:

  • Drush för … en massa saker
  • wpshell för wp shell
  • regenerera miniatyrer för wp media regenerate
  • Sök-Ersätt-DB för wp search-replace
  • WordPress-CLI-exportör för wp export
  • WordPress-CLI-importör för wp import
  • wordpress-plugin-tester för wp scaffold plugin-tests