de opdrachtregelinterface voor WordPress

WP-CLI is de opdrachtregelinterface voor WordPress. U kunt plug-ins bijwerken, multisite-installaties configureren en nog veel meer, zonder gebruik te maken van een webbrowser.

doorlopend onderhoud is mogelijk gemaakt door:

de huidige stabiele versie is versie 2.4.0. Volg @wpcli op Twitter voor aankondigingen of meld je aan voor e-mailupdates. Bekijk de roadmap voor een overzicht van wat er gepland staat voor komende releases.

Bouwstatus gemiddelde tijd om een probleem op te lossen Percentage nog openstaande problemen

snelle links: Gebruik | installeren | ondersteunen | uitbreiden | bijdragen | Credits

gebruik

WP-CLI biedt een opdrachtregelinterface voor veel acties die u in de WordPress-beheerder kunt uitvoeren. Met wp plugin install --activate (doc) kunt u bijvoorbeeld een WordPress-plugin installeren en activeren:

$ 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 bevat ook opdrachten voor veel dingen die je niet kunt doen in de WordPress admin. Met wp transient delete --all (doc) kunt u bijvoorbeeld een of alle transiënten verwijderen:

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

voor een meer volledige introductie over het gebruik van WP-CLI, lees de Snelstartgids. Of, inhalen met shell vrienden om te leren over handige command line utilities.

voelt u zich al op uw gemak met de basis? Spring in de volledige lijst met commando ’s voor gedetailleerde informatie over het beheren van thema’ s en plugins, importeren en exporteren van gegevens, het uitvoeren van database search-replace operaties en meer.

installeren

het downloaden van het Phar-bestand is onze aanbevolen installatiemethode voor de meeste gebruikers. Indien nodig, zie ook onze documentatie over alternatieve installatiemethoden (Composer, Homebrew, Docker).

voordat u WP-CLI installeert, moet u ervoor zorgen dat uw omgeving voldoet aan de minimale vereisten:

  • UNIX-achtige omgeving (OS X, Linux, FreeBSD, Cygwin); beperkte ondersteuning in Windows-omgeving
  • PHP 5.6 of hoger
  • WordPress 3.7 of hoger. Versies die ouder zijn dan de nieuwste WordPress-release hebben mogelijk een verminderde functionaliteit

als u de vereisten hebt geverifieerd, download dan de wp-cli.phar-bestand met wget of curl:

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

controleer vervolgens het Phar-bestand om te controleren of het werkt:

php wp-cli.phar --info

als u WP-CLI vanaf de opdrachtregel wilt gebruiken door wp te typen, maakt u het bestand uitvoerbaar en verplaatst u het naar een plaats in uw pad. Bijvoorbeeld::

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

als WP-CLI succesvol geïnstalleerd is, zou u iets als dit moeten zien als u wp --infouitvoert:

$ 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

bijwerken

u kunt WP-CLI bijwerken met wp cli update (doc), of door de installatiestappen te herhalen.

als WP-CLI eigendom is van root of een andere systeemgebruiker, moet u sudo wp cli updateuitvoeren.

wil je op het randje leven? Voer wp cli update --nightly uit om de laatste nachtelijke build van WP-CLI te gebruiken. De nachtelijke build is min of meer stabiel genoeg voor u om te gebruiken in uw ontwikkelomgeving, en bevat altijd de nieuwste en beste WP-CLI-functies.

tab completies

WP-CLI wordt ook geleverd met een tab completion script voor Bash en ZSH. Gewoon downloaden wp-voltooiing.bash en bron het van ~/.bash_profile:

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

vergeet niet om daarna source ~/.bash_profile uit te voeren.

Als u zsh gebruikt voor uw shell, moet u mogelijk bashcompinit laden en starten voordat u sourcing uitvoert. Plaats het volgende in uw .zshrc:

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

ondersteuning

de onderhouders en medewerkers van WP-CLI zijn beperkt beschikbaar om algemene ondersteuningsvragen te beantwoorden. De huidige versie van WP-CLI is de enige officieel ondersteunde versie.

als u ondersteuning zoekt, zoekt u eerst naar uw vraag in deze locaties:

  • Common issues and their fixes
  • WP-CLI handbook
  • Open or closed issues in the WP-CLI GitHub organization
  • Threads tagged “WP-CLI” in de WordPress.org support forum
  • vragen met ‘WP-CLI’ in de WordPress StackExchange

Als u geen antwoord hebt gevonden in een van de bovenstaande locaties, kunt u:

  • deelnemen aan het #cli – kanaal in de WordPress.org Slack om te chatten met wie op dat moment beschikbaar zou kunnen zijn. Deze optie is het beste voor snelle vragen.
  • plaats een nieuwe thread in de WordPress.org ondersteuning forum en tag het ‘WP-CLI’, zodat het wordt gezien door de gemeenschap.

GitHub problemen zijn bedoeld voor het bijhouden van verbeteringen aan en bugs van bestaande commando ‘ s, niet Algemene ondersteuning. Voordat u een bugrapport indient, moet u onze best practices bekijken om ervoor te zorgen dat uw probleem tijdig wordt aangepakt.

stel geen ondersteuningsvragen op Twitter. Twitter is geen acceptabele locatie voor ondersteuning omdat: 1) Het is moeilijk om gesprekken te voeren in minder dan 280 tekens, en 2) Twitter is niet een plek waar iemand met dezelfde vraag kan zoeken naar een antwoord in een eerder gesprek.

onthoud, libre != gratis; de open source licentie geeft je de vrijheid om te gebruiken en te wijzigen, maar geen verplichtingen van andermans tijd. Wees alstublieft respectvol en stel uw verwachtingen dienovereenkomstig.

uitbreiding

een commando is de atomaire eenheid van de WP-CLI-functionaliteit. wp plugin install (doc) is één commando. wp plugin activate (doc) is een andere.

WP-CLI ondersteunt het registreren van elke opvraagbare klasse, functie of afsluiting als een commando. Het leest gebruiksdetails uit de phpdoc van de callback. WP_CLI::add_command() (doc) wordt gebruikt voor zowel interne als externe commando-registratie.

/** * 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 wordt geleverd met tientallen commando ‘ s. Het is makkelijker dan het lijkt om een aangepaste WP-CLI commando te maken. Lees het commando kookboek voor meer informatie. Blader door de interne API-documenten om een verscheidenheid aan handige functies te ontdekken die u kunt gebruiken in uw aangepaste WP-CLI-opdracht.

bijdragen

wij stellen het op prijs dat u het initiatief neemt om bij te dragen aan WP-CLI. Het is door jou, en de gemeenschap om je heen, dat WP-CLI zo ‘ n geweldig project is.

bijdragen is niet beperkt tot alleen code. We moedigen je aan om bij te dragen op de manier die het beste past bij je vaardigheden, door het schrijven van tutorials, het geven van een demo op je lokale meetup, het helpen van andere gebruikers met hun ondersteuningsvragen, of het herzien van onze documentatie.

Lees onze bijdragende richtlijnen in het handboek voor een grondige inleiding over hoe u kunt meedoen. Het volgen van deze richtlijnen helpt om te communiceren dat u de tijd van andere bijdragers aan het project te respecteren. Op hun beurt zullen ze hun best doen om dat respect te beantwoorden wanneer ze met u samenwerken, over tijdzones en over de hele wereld.

leiderschap

WP-CLI heeft één projectbeheerder: schlessera.

soms verlenen wij schrijftoegang aan bijdragers die gedurende een bepaalde periode hebben aangetoond dat zij in staat zijn en geïnvesteerd hebben in de voortgang van het project.

lees het governancedocument in het handboek voor meer operationele details over het project.

Credits

naast de bibliotheken gedefinieerd in componist.json, we hebben code of ideeën van de volgende projecten gebruikt:

  • Drush for … a lot of things
  • wpshell voor wp shell
  • regenerate Thumbnails voor wp media regenerate
  • Search-Replace-DB voor wp search-replace
  • WordPress-CLI-Exporter voor wp export
  • WordPress-CLI-Importer voor wp import
  • wordpress-plugin-tests voor wp scaffold plugin-tests