Códigos de salida


WP-CLIWP-CLI WP-CLI es la interfaz de línea de comandos para WordPress, utilizada para realizar tareas administrativas y de desarrollo de forma programática. La página del proyecto es http://wp-cli.org/ https://make.wordpress.org/cli/ sigue convenciones de Unix ampliamente adoptadas para los códigos de salida: 0 indica éxito (se cumplió la condición principal del comando), mientras que los valores distintos de cero indican que no se cumplió la condición principal. Esto puede representar un error operativo (el comando no pudo realizar la operación solicitada) o un resultado negativo esperado que los scripts invocadores deben comprobar (por ejemplo, «no instalado»). Los scripts que llaman a comandos de WP-CLI pueden inspeccionar el código de salida para determinar si deben continuar, reintentar o cancelar.

Códigos de salida estándar

Código de salida Significado
0 El comando se completó correctamente. La operación solicitada se realizó según lo esperado.
1 El comando falló. WP-CLI no pudo realizar la operación según lo esperado (por ejemplo, argumentos no válidos, WordPress no encontrado o se produjo un error fatal).

WP_CLI::error() (doc) es la forma convencional de informar de un fallo y salir con el código 1.

WP_CLI::halt() (doc) puede utilizarse para salir con un código distinto de cero específico cuando el comando necesita comunicar un resultado concreto al script invocador.

Códigos de salida para comandos con resultado booleano

Algunos comandos están diseñados para comunicar directamente un resultado binario mediante el código de salida en lugar de hacerlo mediante la salida. Estos comandos siguen utilizando los códigos estándar 0/1, pero 1 significa «condición no cumplida» en lugar de «error operativo». Por ejemplo:

  • wp plugin is-installed <plugin> sale con 0 si el pluginPlugin Un plugin es un componente de software que contiene un grupo de funciones que se pueden añadir a un sitio web de WordPress. Puede ampliar la funcionalidad o añadir nuevas características a sus sitios web de WordPress. Los plugins de WordPress están escritos en el lenguaje de programación PHP y se integran perfectamente con WordPress. Pueden ser gratuitos en el directorio de plugins de WordPress.org https://wordpress.org/plugins/ o pueden ser plugins de pago de terceros. está instalado, y con 1 si no lo está.
  • wp theme is-installed <theme> sigue el mismo patrón.
  • wp core is-installed sale con 0 cuando WordPress está instalado y con 1 cuando no lo está.

Utilice el código de salida 1 para indicar «condición no cumplida» (en lugar de un error) cuando:

  1. El resultado del comando es binario (correcto/incorrecto, encontrado/no encontrado) y está destinado a comprobarse directamente en una condición del shell.
  2. La intención está documentada explícitamente para que los autores de scripts sepan que el código de salida transmite el significado de un resultado, no el de un error.

no devuelva un código de salida distinto de cero para condiciones que sean informativas en lugar de un resultado definitivo (por ejemplo, un comando de listado que no encuentra elementos sigue siendo una operación correcta: devolvió una lista vacía).

Uso de códigos de salida en scripts

Dado que WP-CLI utiliza códigos de salida estándar, puede utilizar los comandos de WP-CLI directamente en condiciones del shell:

# Comprueba si un plugin está instalado antes de intentar activarlo
if wp plugin is-installed my-plugin; then
    wp plugin activate my-plugin
else
    echo "Plugin no instalado"
    exit 1
fi

También puede inspeccionar $? después de cualquier comando de WP-CLI para comprobar si se ejecutó correctamente:

wp core update
if [ "$?" -ne 0 ]; then
    echo "La actualización falló"
fi