Hitchhiker's guide

to

Arūnas Liuiza

WordPress Core Contributor, WordPress Kaunas Meetup co-organizer, WordCamp, WordSesh, TEDx speaker and one of the editors of the Lithuanian WordPress translation team.

 

Free, premium and custom WordPress plugin developer

 

Engineering Team Lead at

The Answer to Life, the Universe
and Everything?

Any sufficiently advanced technology is indistinguishable from magic

- Arthur C. Clarke,1973

/whois WP-CLI

The official command line tool for interacting with and managing your WordPress sites.

 

Yup, the Terminal.

 

Official website: https://make.wordpress.org/cli/​

Requirements

  • UNIX-like environment (OS X, Linux, FreeBSD, Cygwin);
    • limited support in Windows environment
       
  • PHP 5.6 or later.
     
  • WordPress 3.7 or later.
    • Versions older than the latest WordPress release may have degraded functionality

Installation

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

 

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

 

https://make.wordpress.org/cli/handbook/guides/installing/

The Basics

Anatomy of a Command

wp plugin update akismet --version=1.0.0
wp command action input --parameter=value

 

Global Parameters

--path=            a path to s WordPress directory

--url=               url of the site

--user=            set user

--skip-themes[=theme]

--skip-plugins[=plugin]

--dry-run         

--format=json|table|csv

https://make.wordpress.org/cli/handbook/config/#global-parameters

wp plugin <action>

wp plugin install tinycoffee

 

wp plugin activate tinycoffee

 

wp plugin update tinycoffee --version=0.1.0

 

https://developer.wordpress.org/cli/commands/plugin/update/

wp theme <action>

wp theme install twentyseventeen

 

wp theme install twentyseventeen

 

wp theme update twentyseventeen --version=0.1.0

 

https://developer.wordpress.org/cli/commands/theme/update/

wp user <action>

wp user list

 

wp user create bob bob@example.com --role=author

 

wp user update 123 --display_name=Mary --user_pass=marypass


https://developer.wordpress.org/cli/commands/user/​

wp ... anything

wp config

wp core

wp cache

wp comment

wp cron

wp db

wp export

wp import

wp media

wp menu

wp network

wp option

wp package

wp post

wp post-type

wp profile

wp rewrite

wp role

wp server

wp sidebar

wp search-replace

wp site

wp super-admin

wp taxonomy

wp term

wp transient

wp widget

...

Common tasks

Update WordPress

wp core update

 

wp core update-db

 

wp core update-db --network

Install WordPress

wp core download --locale=lt_LT

wp config create --dbname=testing --dbuser=wp
--dbpass=securepswd

 

wp core install --url=example.com --title=Example
--admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com

Import/export

wp export

 

wp import example.wordpress.2018-08-10.xml

Database

wp db export backup.sql

 

wp db import backup.sql

Search & Replace

wp search-replace olddomain.com newdomain.com 'wp_post*'

 

  • works with serialised data
     
  • can do regular expressions
     
  • might be a little... slow :)

 

wp db search - another option

Configuration

https://make.wordpress.org/cli/handbook/references/config/

 

wp-cli.yaml

  • global parameter defaults
  • subcommand defaults
  • environments

 

wp @prod post list

DIY

Build Your Own Commands

if ( class_exists( 'WP_CLI' ) ) {
  WP_CLI::add_command( 'hello', 'arunas_cli_hello' );
}
function arunas_cli_hello( $args, $options ) {
  WP_CLI::success( 'Hello, World!' );
}

https://make.wordpress.org/cli/handbook/internal-api/

https://make.wordpress.org/cli/handbook/commands-cookbook/

Questions?

ask@arunas.co

slid.es/arunas/wp-cli-kaunas-2022/