WP-CLI é a interface de linha de comando do WordPress. Você pode atualizar plug-ins, configurar instalações multisite e muito mais, sem usar um navegador da web.
A manutenção contínua é possível graças a:
A versão estável atual é a versão 2.11.0. Para anúncios, siga @wpcli no Twitter ou inscreva-se para receber atualizações por e-mail. Confira o roteiro para uma visão geral do que está planejado para os próximos lançamentos.
Links rápidos: Usando | Instalando | Suporte | Estendendo | Contribuindo | Créditos
WP-CLI fornece uma interface de linha de comando para muitas ações que você pode realizar no administrador do WordPress. Por exemplo, wp plugin install --activate
(doc) permite instalar e ativar um 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 também inclui comandos para muitas coisas que você não pode fazer no administrador do WordPress. Por exemplo, wp transient delete --all
(doc) permite excluir um ou todos os transientes:
$ wp transient delete --all
Success: 34 transients deleted from the database.
Para uma introdução mais completa ao uso do WP-CLI, leia o guia de início rápido. Ou converse com amigos do shell para aprender sobre utilitários úteis de linha de comando.
Já se sente confortável com o básico? Acesse a lista completa de comandos para obter informações detalhadas sobre como gerenciar temas e plug-ins, importar e exportar dados, realizar operações de pesquisa e substituição de banco de dados e muito mais.
Baixar o arquivo Phar é nosso método de instalação recomendado para a maioria dos usuários. Caso precise, consulte também nossa documentação sobre métodos alternativos de instalação (Composer, Homebrew, Docker).
Antes de instalar o WP-CLI, certifique-se de que seu ambiente atenda aos requisitos mínimos:
Depois de verificar os requisitos, baixe o arquivo wp-cli.phar usando wget
ou curl
:
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
Em seguida, verifique o arquivo Phar para verificar se está funcionando:
php wp-cli.phar --info
Para usar WP-CLI na linha de comando digitando wp
, torne o arquivo executável e mova-o para algum lugar em seu PATH. Por exemplo:
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp
Se o WP-CLI foi instalado com sucesso, você deverá ver algo assim ao executar 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
Você pode atualizar o WP-CLI com wp cli update
(doc) ou repetindo as etapas de instalação.
Se o WP-CLI pertencer ao root ou a outro usuário do sistema, você precisará executar sudo wp cli update
.
Quer viver a vida no limite? Execute wp cli update --nightly
para usar a versão noturna mais recente do WP-CLI. A compilação noturna é mais ou menos estável o suficiente para você usar em seu ambiente de desenvolvimento e sempre inclui os melhores e mais recentes recursos WP-CLI.
WP-CLI também vem com um script de preenchimento de tabulação para Bash e ZSH. Basta baixar wp-completion.bash e obtê-lo em ~/.bash_profile
:
source /FULL/PATH/TO/wp-completion.bash
Não se esqueça de executar source ~/.bash_profile
depois.
Se estiver usando zsh para seu shell, pode ser necessário carregar e iniciar bashcompinit
antes de obter. Coloque o seguinte no seu .zshrc
:
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash
Os mantenedores e contribuidores do WP-CLI têm disponibilidade limitada para responder a questões gerais de suporte. A versão atual do WP-CLI é a única versão oficialmente suportada.
Ao procurar suporte, primeiro pesquise sua pergunta nestes locais:
Se você não encontrou uma resposta em um dos locais acima, você pode:
#cli
no Slack do WordPress.org para conversar com quem estiver disponível no momento. Esta opção é melhor para perguntas rápidas.Os problemas do GitHub destinam-se ao rastreamento de melhorias e bugs de comandos existentes, não ao suporte geral. Antes de enviar um relatório de bug, revise nossas práticas recomendadas para ajudar a garantir que seu problema seja resolvido em tempo hábil.
Por favor, não faça perguntas de suporte no Twitter. O Twitter não é um local aceitável para suporte porque: 1) é difícil manter conversas com menos de 280 caracteres e 2) o Twitter não é um lugar onde alguém com a mesma pergunta possa procurar uma resposta em uma conversa anterior.
Lembre-se, livre! = grátis; a licença de código aberto concede a você a liberdade de usar e modificar, mas não compromete o tempo de outras pessoas. Por favor, seja respeitoso e defina suas expectativas de acordo.
Um comando é a unidade atômica da funcionalidade WP-CLI. wp plugin install
(doc) é um comando. wp plugin activate
(doc) é outro.
WP-CLI suporta o registro de qualquer classe, função ou encerramento que possa ser chamado como um comando. Ele lê detalhes de uso do PHPdoc do retorno de chamada. WP_CLI::add_command()
(doc) é usado para registro de comandos internos e de terceiros.
/**
* 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 vem com dezenas de comandos. É mais fácil do que parece criar um comando WP-CLI personalizado. Leia o livro de receitas de comandos para saber mais. Navegue pela documentação interna da API para descobrir uma variedade de funções úteis que você pode usar em seu comando WP-CLI personalizado.
Agradecemos por você ter tomado a iniciativa de contribuir com o WP-CLI. É por sua causa e pela comunidade ao seu redor que o WP-CLI é um projeto tão bom.
A contribuição não se limita apenas ao código. Incentivamos você a contribuir da maneira que melhor se adapta às suas habilidades, escrevendo tutoriais, fazendo uma demonstração em seu encontro local, ajudando outros usuários com suas dúvidas de suporte ou revisando nossa documentação.
Leia nossas diretrizes de contribuição no manual para obter uma introdução completa sobre como você pode se envolver. Seguir essas diretrizes ajuda a comunicar que você respeita o tempo de outros colaboradores do projeto. Por sua vez, eles farão o possível para retribuir esse respeito ao trabalhar com você, em diferentes fusos horários e em todo o mundo.
WP-CLI tem um mantenedor de projeto: schlessera.
Ocasionalmente, concedemos acesso de escrita a colaboradores que demonstraram, ao longo de um período de tempo, que são capazes e investiram no avanço do projeto.
Leia o documento de governança no manual para obter mais detalhes operacionais sobre o projeto.
Além das bibliotecas definidas em compositor.json, utilizamos códigos ou ideias dos seguintes projetos:
wp shell
wp media regenerate
wp search-replace
wp export
wp import
wp scaffold plugin-tests