WP-CLI de WordPress

Creando wp-config.php desde la línea de comandos

wp config create --dbname=wptest --dbuser=myuser --dbpass=mypas

Opciones:

• --dbname=<dbname>, para establecer el nombre de la base de datos.
• --dbuser=<dbuser>, para establecer el usuario de acceso a base de datos.
• [--dbpass=<dbpass>], para establecer la contraseña de acceso a base de datos.
• [--dbhost=<dbhost>], para establecer el host de la base de datos. default: localhost.
• [--dbprefix=<dbprefix>], para establecer el prefijo de las tablas de la base de datos. default: wp_
• [--dbcharset=<dbcharset>], para establecer el charset de la base de datos. default: utf8.
• [--dbcollate=<dbcollate>], para establecer la colación de la base de datos.
• [--locale=<locale>], para establecer la constante WPLANG..
• [--extra-php], para escribir instrucciones PHP.
• [--skip-salts], para no generar keys & salts.
• [--skip-check], para no chequear la conexión con la base de datos.
• [--force], para sobreescribir el archivo si existe

Ejemplos:

wp db create

Creará una base de datos con la información establecida en el fichero wp-config.php.

Opciones:

• wp post create, para crear un nuevo post
• wp post delete, para borrar un post
• wp post edit, abre un editor para modificar el post_content
• wp post generate, para generar un lote de posts
• wp post get, para obtener detalles de un post
• wp post list, para obtener un listado de posts
• wp post meta, para administrar post meta
• wp post term, para administrar terms
• wp post update, para actualizar posts

Creando un post con WP-CLI

Opciones wp post create:

• [<file>], almacena en post_content el contenido de <file>.
• [--<field>=<value>], par clave/valor.
• [--edit], abre el editor de archivos del sistema para escribir el post_content
• [--porcelain], devuelve el post_id

En [--<field>=<value>] podemos establecer valores para algunos campos como:

• ID
• post_author
• post_date
• post_content
• post_title
• post_excerpt
• post_status
• post_type
• post_password
• post_name
• post_parent
• menu_order
• post_category

wp post create —post_title=«Mi nuevo post» —post_content=«lorem ipsum dolor sit amet» —post_type=«page» —menu_order=5

Genera un lote de posts desde la línea de comandos

Opciones:

• [--count=<number>], el número de posts que queremos generar. Por defecto 100.
• [--post_type=<type>], el tipo de post que queremos generar. Por defecto post.
• [--post_status=<status>], el estado de los posts que queremos generar. Por defecto publish.
• [--post_author=<login>], para asignar un autor a los posts que queremos generar.
• [--post_date=<yyyy-mm-dd>], para establecer una fecha a los posts que queremos generar.
• [--post_content], para asignar contenido a los posts.
• [--max_depth=<number>], para posts que sean de tipo hierarchical
• [--format=<format>], para que nos devuelva en la salida una barra de progreso o los ids de los posts que se están generando. Por defecto progress.

curl http://miweb.net/api/5 | wp post generate --post_content --count=20

Listado de posts con WP-CLI

Opciones:

• [--<field>=<value>], uno o más args que se pasarán a la WP_Query que devolverá el listado.
• [--field=<field>], para imprimir únicamente un campo concreto en la salida.
• [--fields=<fields>], para limitar la salida a campos específicos.
• [--format=<format>], para mostrar la salida en un formato determinado. Por defecto tabla. Acepta: table, csv, ids, json, count, yaml

wp post list --fields=ID,post_title,post_author

Elimina un post con WP-CLI

Opciones:

• <id>, uno o más IDs (separados por coma) para eliminar (quedarán en papelera)
• [--force], para forzar la eliminación completa de los posts, no quedarán en papelera
• [--defer-term-counting], para obviar la llamada a wp_defer_term_counting() y evitar varias queries y mejorar el rendimiento del proceso

wp post delete 15,47

También podemos eliminar posts sacando sus IDs de un listado, combinando dos comandos:

wp post delete (wp post list --post_status=trash --format=ids)

Opciones:

• wp user add-cap, para añadir una capability.
• wp user add-role, para añadir un rol de usuario.
• wp user create, para crear un nuevo usuario.
• wp user delete, para borrar uno o varios usuarios existentes.
• wp user generate, para generar usuarios en lote.
• wp user get, para obtener información sobre un usuario.
• wp user import-csv, para importar usuarios desde un CSV.
• wp user list, para listar los usuarios.
• wp user list-caps, para listar todas las capabilities de un usuario.
• wp user meta, para administrar los custom fields de un usuario.
• wp user remove-cap, para eliminar capabilities de usuarios.
• wp user remove-role, para eliminar un rol de usuario.
• wp user session, para administrar la sesión de usuario.
• wp user set-role, para establecer un rol a un usuario.
• wp user term, para administrar términos de usuarios.
• wp user update, para actualizar los datos de un usuario.

Listar usuarios

Opciones:

• [--role=<role>], para mostrar los usuarios de un determinado role.
• [--<field>=<value>], para mostrar en la salida sólo los usuarios que cumplan esta condición en WP_User_Query().
• [--network], listar todos los usuarios en la red si es multisite.
• [--field=<field>], para imprimir únicamente un campo concreto en la salida.
• [--fields=<fields>], para limitar la salida a campos específicos.
• [--format=<format>], para mostrar la salida en un formato determinado. Por defecto tabla. Acepta: table, csv, ids, json, count, yaml

Crear listado en formato CSV:

Crear usuarios

Opciones:

• <user-login>, el login del usuario que vamos a crear.
• <user-email>, el e-mail del usuario que vamos a crear.
• [--role=<role>], el rol del usuario que vamos a crear.
• [--user_pass=<password>], la contraseña del usuario que vamos a crear.
• [--user_registered=<yyyy-mm-dd-hh-ii-ss>], la fecha de registro del usuario que vamos a crear.
• [--display_name=<name>], el nombre que usará WordPress para mostrar el usuario que vamos a crear.
• [--user_nicename=<nice_name>], una cadena que contiene el nombre amigable del nombre de usuario que vamos a crear.
• [--user_url=<url>], la url del sitio web del usuario que vamos a crear.
• [--nickname=<nickname>], el nick del usuario que vamos a crear.
• [--first_name=<first_name>], el nombre del usuario que vamos a crear.
• [--last_name=<last_name>], los apellidos del usuario que vamos a crear.
• [--description=<description>], una cadena con una descripción del usuario que vamos a crear.
• [--rich_editing=<rich_editing>], para activar o no el editor visual al escribir.
• [--send-email], para enviar un mail al nuevo usuario.
• [--porcelain], para mostrar en pantalla el ID del usuario que vamos a crear.

wp user create miusuario miusuario@example.com --role=administrator

wp user create miusuario miusuario@example.com --role=administrator --user_pass=miclave

Opciones:

• <user>, el nombre de usuario, email o ID del usuario que queremos editar.
• [--user_pass=<password>], para establecer una contraseña nueva para el usuario que estamos editando.
• [--user_login=<login>], para establecer un nuevo nombre de usuario para el usuario que estamos editando.
• [--user_nicename=<nice_name>], para establecer un nuevo nombre amigable para el usuario que estamos editando.
• [--user_url=<url>], para editar la URL del usuario que estamos editando.
• [--user_email=<email>], para editar el email del usuario que estamos editando.
• [--display_name=<display_name>], para editar el nombre que muestra WordPress del usuario que estamos editando.
• [--nickname=<nickname>], para editar el nickname del usuario que estamos editando.
• [--first_name=<first_name>], para cambiar el nombre del usuario que estamos editando.
• [--last_name=<last_name>], para cambiar los apellidos del usuario que estamos editando.
• [--description=<description>], para editar la descripción del usuario que estamos editando.
• [--rich_editing=<rich_editing>], para activar o no el editor visual al escribir.
• [--user_registered=<yyyy-mm-dd-hh-ii-ss>], para modificar la fecha en la que el usuario que estamos editando se registró.
• [--role=<role>], para establecer el rol del usuario que estamos editando.
• --<field>=<value>, par clave/valor de campos personalizados (custom fields) para del usuario que estamos editando.

wp user update 1 --user_pass=nuevaclave

Eliminar usuarios

Opciones:

• <user>, el nombre de usuario, email o ID del usuario que queremos eliminar.
• [--network], si es un multisite, borra el usuario de toda la red.
• [--reassign=<user-id>], para asignar todas las entradas del usuario que queremos eliminar a otro usuario.
• [--yes], responde SI a cualquier confirmación desde la consola.

wp user delete 3 --reassign=4

Eliminar el usuario 3 y asigna todo su contenido al usuario 4.

Generar un lote de usuarios

Opciones:

• [--count=<number>], el número de usuarios que queremos crear. Por defecto 100
• [--role=<role>], el rol que tendrán los usuarios generados.
• [--format=<format>], cómo queremos ver la salida. Por defecto progress, aunque podemos elegir ver los ids.

wp user generate --count=5 --role=editor

Importar usuarios desde un CSV

Opciones:

• <file>, la ruta local o remota del fichero CSV que contiene los usuarios a importar.
• [--send-email], si queremos que se notifique por email al nuevo usuario creado.
• [--skip-update], para evitar actualizar el usuario si ya existe.

Ejemplo CSV:

user_login,user_email,user_pass,display_name,role;

miusuario1,miusuario1@example.com,miclave1,Mi usuario 1,administrator;

miusuario2,miusuario2@example.com,miclave2,Mi usuario 2,editor;

Importar:

wp user import-csv /path/to/users.csv

Administración de la BD

Opciones:

• wp db check, lista el estado de la base de datos y de cada una de sus tablas.
• wp db cli, abre MySQL en la consola utilizando las credenciales establecidas en wp-config.php.
• wp db create, crea una nueva base de datos (utilizando el nombre establecido en wp-config.php, si no existe).
• wp db drop, elimina la base de datos (utilizando el nombre establecido en wp-config.php).
• wp db export, para exportar la base de datos.
• wp db import, para importar una base de datos Import a database from a file or from STDIN.
• wp db optimize, para optimizar la base de datos.
• wp db prefix, muestra el prefijo de la base de datos.
• wp db query, para ejecutar una consulta contra la base de datos.
• wp db repair, repara la base de datos.
• wp db reset, elimina todas las tablas de la base de datos.
• wp db search, para buscar una cadena en la base de datos.
• wp db size, muestra el nombre de la base de datos y su peso.
• wp db tables, para mostrar un listado de las tablas de la base de datos.

Opciones de db size:

• [--size_format], para devolver únicamente el peso en bytes (b, por defecto), kilobytes (kb) ó megabytes(mb) de la base de datos.
• [--tables], para segmentar la información y ver lo que pesa cada tabla de manera independiente.
• [--format], para establecer la salida de la información en pantalla: table (por defecto), csv ó json.
• [--network], para listar todas las tablas en una instalación multisite
• [--all-tables-with-prefix], para listar todas las tablas con el prefijo por defecto, incluso si no están registradas en $wpdb.
• [--all-tables], lista todas las tablas en la base de datos independientemente del prefijo, incluso si no están registradas en $wpdb.

wp db size —tables

Opciones db export:

• [<file>], el nombre que queremos dar al fichero sql resultante. Si se omite, se creará un fichero con el nombre de la base de datos.
• [--<field>=<value>], argumentos extra que pueden pasarse a mysqldump.
• [--tables=<tables>], donde podemos definir una lista separada por comas con el nombre de tablas específicas que queremos exportar. Si no se especifica nada, se exportan todas las tablas.
• [--exclude_tables=<tables>], donde podemos definir una lista separada por comas con el nombre de las tablas que NO queremos exportar. Si no se especifica nada, se exportan todas las tablas.
• [--porcelain], para devolver en la salida únicamente el nombre del fichero exportado

Opciones db import:

• [<file>], el nombre del fichero a importar.
• [--skip-optimization], para evitar comprobaciones de claves y mejorar el rendimiento.

Buscar y reemplazar en la BD

Éste comando se utiliza para buscar una cadena en base de datos y reemplazarla por otra. Muy útil cuando por ejemplo tienes que realizar una migración de dominio, o modificar el nombre de un post_type.

Es muy recomendable hacer una copia de seguridad de la base de datos.

Además, wp search-replace interpreta los datos serializados, y hace los reemplazos de manera inteligente, sin romper nada.

Opciones:

• <old>, la cadena que vamos a buscar en la base de datos.
• <new>, la cadena que va a reemplazar a la cadena <old> que estamos buscando.
• [<table>…], lista de tablas sobre las que restringir los reemplazos. Soporta Wildcards, ejemplo: ‘wp_*options’ or ‘wp_post*’.
• [--dry-run], ejecuta el comando, pero simplemente muestra en pantalla el resultado, sin guardar los cambios en base de datos. Es importante la primera vez siempre ejecutar este comando en modo dry run, para evaluar los cambios antes de que se produzcan.
• [--network], hace la búsqueda y reemplazo en todas las tablas registradas en $wpdb en instalaciones multisite.
• [--all-tables-with-prefix], habilita la búsqueda y reemplazo en todas las tables con el prefijo, incluso aunque no estén registradas en $wpdb.
• [--all-tables], habilita la búsqueda y reemplazo en todas las tablas de la base de datos, incluso aunque no estén registradas en $wpdb.
• [--export[=<file>]], escribe los datos transformados a un archivo SQL en lugar de guardar los reemplazos en la base de datos.
• [--export_insert_size=<rows>], para definir el número de filas en una sola instrucción INSERT al realizar la exportación de SQL. Por defecto 50.
• [--skip-columns=<columns>], para no realizar la búsqueda y reemplazo en columnas específicas. Se pueden establecer múltiples columnas separadas por coma.
• [--include-columns=<columns>], para realizar la búsqueda y reemplazo en columnas específicas. Se pueden establecer múltiples columnas separadas por coma.
• [--precise], fuerza el uso de PHP en lugar de SQL, que es más completo pero más lento
• [--verbose], va imprimiendo en caliente las filas de las tablas que está chequeando el script.
• [--regex], para lanzar la búsqueda utilizando una expresión regular con delimitadores. Si se utiliza una expresión regular el tiempo de ejecución del script puede multiplicarse por 15 ó 20.
• [--regex-flags=<regex-flags>], para establecer modificadores en la expresión regular, por ejemplo “i”, para insensibilidad a mayúsculas y minúsculas.
• [--format=<format>], para imprimir la salida en un formato particular: table (por defecto), count (únicamente el número de reemplazos)

Migrar url:

wp search-replace 'midominio.com' 'midominio.dev' --dry-run

wp search-replace 'foo' 'bar' wp_users wp_usermeta

Exportar contenido con WP-CLI

Opciones:

• [--dir=<dirname>], ruta completa donde se almacenará el fichero WXR. Por defecto es el actual directorio desde el que estamos ejecutando el comando.
• [--skip_comments], para no incluir los comentarios en el archivo WXR.
• [--max_file_size=<MB>], para establecer en megas el tamaño máximo del archivo WXR. Por defecto 15
• [--start_date=<date>], para establecer una fecha de publicación a partir de la cual exportar el contenido. El formato de fecha debe ser YYYY-MM-DD.
• [--end_date=<date>], para exportar entradas que tengan como tope esta fecha de publicación. El formato de fecha debe ser YYYY-MM-DD.
• [--post_type=<post-type>], para exportar las entradas de un tipo de contenido concreto. Pueden establecerse varios tipos de contenido separados por coma. Ej: post,page,product… Por defecto se exporta todo (any)
• [--post_type__not_in=<post-type>], al contrario que el anterior, para exportar las entradas excepto de los tipos de contenido indicados. Pueden establecerse varios tipos de contenido separados por coma.
• [--post__in=<pid>], para exportar todos los posts especificados. Admite una lista de IDs separados por coma o espacio.
• [--start_id=<pid>], para exportar todos los posts con ID igual o superior al indicado (número).
• [--author=<author>], para exportar todos los posts que ha creado un usuario concreto. Se puede identificar al usuario por ID o por nombre de usuario (user_login).
• [--category=<name>], para exportar todos los posts de una categoría concreta.
• [--post_status=<status>], para exportar todos los posts que se encuentren en un determinado status (publish, future, draft, trash…).
• [--filename_format=<format>], para especificar un formato al nombre de fichero que se va a exportar. Por defecto: ‘{site}.wordpress.{date}.{n}.xml’.

wp export --category=noticias --skip_comments

Importar contenido con WP-CLI

Opciones:

• <file>…, ruta a uno o más ficheros WXR válidos. Además de la ruta completa a un fichero concreto, también son aceptados directorios.
• --authors=<authors>, para indicar cómo manejar el mapeo de autores. Las opciones que acepta este parámetro son: ‘create’, ‘mapping.csv’, o ‘skip’. Para más información te aconsejo que leas la documentación oficial.
• [--skip=<data-type>], para saltar la importación de datos específicos. Las opciones que acepta este parámetro son: ‘attachment’ y ‘image_resize’. Se ahorraría tiempo al evitar generar los thumbnails.

Instalar y activa plugin WordPress Importer:

wp plugin install wordpress-importer --activate

Crear código desde plantillas

Opciones:

• wp scaffold child-theme, genera un child theme basado en el tema activado.
• wp scaffold plugin, genera un código base para crear tu propio plugin. Crea un starter plugin, como referencia para tu desarrollo.
• wp scaffold plugin-tests, genera los ficheros necesarios para correr test unitarios en tu plugin (PHPUnit).
• wp scaffold post-type, genera el código PHP necesario para registrar un custom post type.
• wp scaffold taxonomy, genera el código PHP necesario para registrar una custom taxonomy.
• wp scaffold theme-tests, genera los ficheros necesarios para correr test unitarios en tu tema (PHPUnit).
• wp scaffold _s, genera un código base para crear tu propio tema basado en Underscores (_s).

Opciones de wp scaffold post-type:

• <slug>, para establecer el identificador o nombre de nuestro post type.
• [--label=<label>], el texto que usaremos para los botones y menús del escritorio de WordPress. Por defecto se configura para el multi-idioma.
• [--textdomain=<textdomain>], nuestro textdomain para traducir las cadenas.
• [--dashicon=<dashicon>], para establecer un icono en el menú del escritorio de WordPress (https://developer.wordpress.org/resource/dashicons/#products).
• [--theme], para indicar que cree un archivo PHP en nuestro tema con el código generado en lugar de imprimirlo por pantalla.
• [--plugin=<plugin>], para indicar que cree un archivo PHP en el plugin indicado con el código generado en lugar de imprimirlo por pantalla.
• [--raw], para generar únicamente el código para registrar el post-type, sin crear las funciones que se enganchan al init y al post_update_messages.
• [--force], sobreescribe los ficheros si ya existen.

wp scaffold post-type mycpt --label=mylabel --textdomain=mytextdomain --raw

Opciones de wp scaffold taxonomy:

• <slug>, para establecer el identificador o nombre de nuestra taxonomía.
• [--post_types=<post-types>], post-types registrados a los que asociamos la nueva taxonomía.
• [--label=<label>], el texto que usaremos para los botones y menús del escritorio de WordPress. Por defecto se configura para el multi-idioma.
• [--textdomain=<textdomain>], nuestro textdomain para traducir las cadenas.
• [--theme], para indicar que cree un archivo PHP en nuestro tema con el código generado en lugar de imprimirlo por pantalla.
• [--plugin=<plugin>], para indicar que cree un archivo PHP en el plugin indicado con el código generado en lugar de imprimirlo por pantalla.
• [--raw], para generar únicamente el código para registrar el post-type, sin crear las funciones que se enganchan al init y al post_update_messages.
• [--force], sobreescribe los ficheros si ya existen.

wp scaffold taxonomy mytax --label=mylabel --post_types=mycpt --textdomain=mytextdomain --raw

Generar código de un plugin

Opciones:

• <slug>, el slug o identificador de nuestro plugin.
• [--dir=<dirname>], si queremos crear los ficheros en un directorio diferente al de plugins.
• [--plugin_name=<title>], el nombre del plugin que será visible en el escritorio de WordPress.
• [--plugin_description=<description>], la descripción de lo que hace nuestro plugin.
• [--plugin_author=<author>], el nombre del autor o autores del plugin.
• [--plugin_author_uri=<url>], URL del autor o autores del plugin.
• [--plugin_uri=<url>], URL de la página del plugin.
• [--skip-tests], para no generar los ficheros necesarios para correr test unitarios en nuestro plugin.
  [–ci=<provider>], para escoger la herramienta de integración continua. Las opciones son ‘travis’ (por defecto), ‘circle’ y ‘gitlab’.
• [--activate], para activar el plugin una vez creado.
• [--activate-network], para activar el plugin para toda la red (en caso de instalación multisite).
• [--force], para forzar sobre-escribir el plugin en caso de que ya exista.

wp scaffold plugin myplugin --plugin_name="My Plugin" --plugin_description="My Description"

Opciones:

• <slug>, el slug o identificador de nuestro tema.
• [--activate], para activar el tema una vez creado.
• [--enable-network], para habilitar el tema para toda la red (en caso de instalación multisite).
• [--theme_name=<title>], el nombre que se establecerá en las cabeceras de style.css (y que aparecerá después en el gestor de temas del escritorio de WordPress).
• [--author=<full-name>], el nombre del autor o autores del tema.
• [--author_uri=<uri>], URL del autor o autores del tema.
• [--sassify], para incluir la hojas de estilos del tema en formato SASS.
• [--force], para forzar sobre-escribir el tema en caso de que ya exista.

• <slug>, el slug o identificador de nuestro tema hijo.
• --parent_theme=<slug>, el slug del tema padre sobre el que heredaremos.
• [--theme_name=<title>], el nombre que se establecerá en las cabeceras de style.css (y que aparecerá después en el gestor de temas del escritorio de WordPress).
• [--author=<full-name>], el nombre del autor o autores del tema.
• [--author_uri=<uri>], URL del autor o autores del tema.
• [--theme_uri=<uri>], URL del tema.
• [--activate], para activar el tema una vez creado.
• [--enable-network], para habilitar el tema para toda la red (en caso de instalación multisite).
• [--force], para forzar sobre-escribir el tema en caso de que ya exista.

wp scaffold child–theme mychildtheme —parent_theme=twentyseventeen