Códigos de saída

WP-CLIWP-CLI WP-CLI é a interface de linha de comando do WordPress, usada para realizar tarefas administrativas e de desenvolvimento de forma programática. A página do projeto é http://wp-cli.org/ https://make.wordpress.org/cli/ segue convenções Unix amplamente adotadas para códigos de saída: 0 indica sucesso (a condição principal do comando foi satisfeita), enquanto valores diferentes de zero indicam que a condição principal não foi satisfeita. Isso pode representar um erro operacional (o comando não conseguiu realizar a operação solicitada) ou um resultado negativo esperado que os scripts chamadores devem testar (por exemplo, “não instalado”). Os scripts que chamam comandos do WP-CLI podem verificar o código de saída para determinar se devem continuar, tentar novamente ou abortar.

Códigos de saída padrão

WP_CLI::error() (documentação) é a forma convencional de relatar uma falha e sair com o código 1.

WP_CLI::halt() (documentação) pode ser usado para sair com um código específico diferente de zero quando o comando precisa comunicar um resultado específico ao script chamador.

Códigos de saída para comandos com resultado booleano

Alguns comandos são projetados para comunicar diretamente um resultado binário por meio do código de saída, em vez de fazê-lo por meio da saída. Esses comandos ainda usam os códigos padrão 0/1, mas 1 significa “condição não atendida”, e não “erro operacional”. Por exemplo:

• wp plugin is-installed <plugin> sai com 0 se o pluginPlugin Um plugin é um software que contém um grupo de funções que pode ser adicionado a um site WordPress. Ele pode ampliar a funcionalidade ou adicionar novos recursos aos seus sites WordPress. Os plugins do WordPress são escritos na linguagem de programação PHP e se integram perfeitamente ao WordPress. Eles podem ser gratuitos no Diretório de Plugins do WordPress.org https://wordpress.org/plugins/ ou podem ser plugins pagos de terceiros. estiver instalado, e com 1 se não estiver.
• wp theme is-installed <theme> segue o mesmo padrão.
• wp core is-installed sai com 0 quando o WordPress está instalado e com 1 quando não está.

Use o código de saída 1 para indicar “condição não atendida” (em vez de um erro) quando:

1. O resultado do comando é binário (aprovado/reprovado, encontrado/não encontrado) e deve ser testado diretamente em uma condicional do shell.
2. A intenção está explicitamente documentada para que os autores dos scripts saibam que o código de saída representa um resultado, e não um erro.

Não retorne um código de saída diferente de zero para condições que sejam informativas, e não um resultado definitivo (por exemplo, um comando de listagem que não encontra itens ainda é uma operação bem-sucedida — ele retornou uma lista vazia).

Usando códigos de saída em scripts

Como o WP-CLI usa códigos de saída padrão, você pode usar os comandos do WP-CLI diretamente em condicionais do shell:

# Verificar se um plugin está instalado antes de tentar ativá-lo
if wp plugin is-installed my-plugin; then
    wp plugin activate my-plugin
else
    echo "Plugin não instalado"
    exit 1
fi

Você também pode verificar $? após qualquer comando do WP-CLI para conferir se ele foi bem-sucedido:

wp core update
if [ "$?" -ne 0 ]; then
    echo "Falha na atualização"
fi