La interfaz de línea de comandos para WordPress

BY admin
|

WP-CLI es la interfaz de línea de comandos para WordPress. Puede actualizar complementos, configurar instalaciones de varios sitios y mucho más, sin usar un navegador web.

mantenimiento Continuo es posible gracias a:

La actual versión estable es la versión 2.4.0. Para anuncios, sigue a @wpcli en Twitter o regístrate para recibir actualizaciones por correo electrónico. Echa un vistazo a la hoja de ruta para obtener una visión general de lo que está planeado para las próximas versiones.

Estado de compilación Tiempo promedio para resolver un problema Porcentaje de problemas aún abiertos

Enlaces rápidos: Usar | Instalar | Soporte | Extender | Contribuir | Créditos

Usar

WP-CLI proporciona una interfaz de línea de comandos para muchas acciones que se puede realizar en el administrador de WordPress. Por ejemplo, wp plugin install --activate (doc) le permite instalar y activar un complemento de WordPress:

$ 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 también incluye comandos para muchas cosas que no puedes hacer en el administrador de WordPress. Por ejemplo, wp transient delete --all (doc) le permite eliminar uno o todos los transitorios:

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

Para una introducción más completa al uso de WP-CLI, lea la guía de inicio rápido. También puede ponerse al día con los amigos del shell para obtener información sobre útiles utilidades de línea de comandos.

¿Ya te sientes cómodo con lo básico? Vaya a la lista completa de comandos para obtener información detallada sobre la administración de temas y complementos, la importación y exportación de datos, la realización de operaciones de búsqueda y reemplazo de bases de datos y más.

Instalar

Descargar el archivo Phar es nuestro método de instalación recomendado para la mayoría de los usuarios. Si lo necesita, consulte también nuestra documentación sobre métodos de instalación alternativos (Composer, Homebrew, Docker).

Antes de instalar WP-CLI, asegúrese de que su entorno cumpla con los requisitos mínimos:

  • Entorno tipo UNIX (OS X, Linux, FreeBSD, Cygwin); soporte limitado en entorno Windows
  • PHP 5.6 o posterior
  • WordPress 3.7 o posterior. Las versiones anteriores a la última versión de WordPress pueden tener una funcionalidad degradada

Una vez que haya verificado los requisitos, descargue wp-cli.archivo phar usando wget o curl:

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

A continuación, compruebe el archivo Phar para verificar que funciona:

php wp-cli.phar --info

Para usar WP-CLI desde la línea de comandos escribiendo wp, haga que el archivo sea ejecutable y muévalo a algún lugar de su RUTA de acceso. Por ejemplo:

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

Si WP-CLI se instaló correctamente, debería ver algo como esto cuando ejecute 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

Actualización

Puede actualizar WP-CLI con wp cli update (doc), o repitiendo los pasos de instalación.

Si WP-CLI es propiedad de root u otro usuario del sistema, deberá ejecutar sudo wp cli update.

¿Quieres vivir la vida al límite? Ejecute wp cli update --nightly para usar la última compilación nocturna de WP-CLI. La compilación nocturna es lo suficientemente estable como para que la uses en tu entorno de desarrollo, y siempre incluye las últimas y mejores funciones de WP-CLI.

Terminaciones de pestañas

WP-CLI también viene con un script de finalización de pestañas para Bash y ZSH. Simplemente descargue wp-completion.bash y la fuente de ~/.bash_profile:

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

No olvide ejecutar source ~/.bash_profile después.

Si usa zsh para su shell, es posible que deba cargar y comenzar bashcompinit antes de abastecerse. Ponga lo siguiente en su .zshrc:

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

Soporte

Los mantenedores y colaboradores de WP-CLI tienen disponibilidad limitada para responder a preguntas generales de soporte. La versión actual de WP-CLI es la única versión soportada oficialmente.

Cuando busque asistencia, primero busque su pregunta en estos lugares:

  • Problemas comunes y sus soluciones
  • Manual de WP-CLI
  • Problemas abiertos o cerrados en la organización GitHub de WP-CLI
  • Hilos etiquetados ‘WP-CLI’ en el WordPress.org foro de soporte
  • Preguntas etiquetadas como ‘WP-CLI’ en el intercambio de paquetes de WordPress

Si no encontró una respuesta en uno de los lugares anteriores, puede:

  • Unirse al canal #cli en el WordPress.org Slack para chatear con quien esté disponible en ese momento. Esta opción es la mejor para preguntas rápidas.
  • Publicar un nuevo hilo en el WordPress.org apoye el foro y etiquételo como ‘WP-CLI’ para que sea visto por la comunidad.

Los problemas de GitHub están diseñados para rastrear mejoras y errores de comandos existentes, no para soporte general. Antes de enviar un informe de error, revise nuestras prácticas recomendadas para asegurarse de que su problema se resuelva de manera oportuna.

Por favor, no hagas preguntas de soporte en Twitter. Twitter no es un lugar de apoyo aceptable porque: 1) es difícil mantener conversaciones con menos de 280 caracteres, y 2) Twitter no es un lugar donde alguien con tu misma pregunta pueda buscar una respuesta en una conversación anterior.

¡Recuerda, libre != gratis; la licencia de código abierto le otorga la libertad de usar y modificar, pero no compromisos del tiempo de otras personas. Por favor, sea respetuoso y establezca sus expectativas en consecuencia.

Extendiendo

Un comando es la unidad atómica de la funcionalidad WP-CLI. wp plugin install (doc) es un comando. wp plugin activate (doc) es otro.

WP-CLI admite el registro de cualquier clase, función o cierre llamable como comando. Lee los detalles de uso del PHPDoc de la devolución de llamada. WP_CLI::add_command() (doc) se utiliza para el registro de comandos internos y de terceros.

/** * 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 viene con docenas de comandos. Es más fácil de lo que parece crear un comando WP-CLI personalizado. Lea el libro de cocina de comandos para obtener más información. Explore los documentos internos de la API para descubrir una variedad de funciones útiles que puede usar en su comando WP-CLI personalizado.

Contribuyendo

Agradecemos que haya tomado la iniciativa de contribuir a WP-CLI. Es gracias a ti, y a la comunidad que te rodea, que WP-CLI es un gran proyecto.

Contribuir no se limita solo al código. Le animamos a contribuir de la manera que mejor se adapte a sus habilidades, escribiendo tutoriales, dando una demostración en su reunión local, ayudando a otros usuarios con sus preguntas de soporte o revisando nuestra documentación.

Lea nuestras pautas para contribuir en el manual para obtener una introducción completa sobre cómo puede participar. Seguir estas pautas ayuda a comunicar que respeta el tiempo de otros colaboradores en el proyecto. A su vez, harán todo lo posible para corresponder a ese respeto cuando trabajen contigo, en zonas horarias y en todo el mundo.

Liderazgo

WP-CLI tiene un responsable del proyecto: schlessera.

En ocasiones, otorgamos acceso de escritura a colaboradores que han demostrado, durante un período de tiempo, que son capaces e invierten en hacer avanzar el proyecto.

Lea el documento de gobernanza en el manual para obtener más detalles operativos sobre el proyecto.

Créditos

Además de las bibliotecas definidas en composer.json, hemos utilizado código o ideas de los siguientes proyectos:

  • Drush para lot muchas cosas
  • wpshell para wp shell
  • Regenerar miniaturas para wp media regenerate
  • Buscar-Reemplazar-DB para wp search-replace
  • WordPress-Exportador de CLI para wp export
  • WordPress-Importador de CLI para wp import
  • pruebas de plugin de wordpress para wp scaffold plugin-tests