Getting Started with WP-CLI

@cwpnolen @emagineusa@WordCampRI #WCRI
WordCamp Rhode Island
WP-CLI
GETTING STARTED WITH

Who Am I?
Christian Nolen
Technical Director for emagine
@cwpnolen

http://www.emagine.com/careers/
We’re Hiring

What is WP-CLI?

1. UNIX-like environment (OS X, Linux, FreeBSD,
Cygwin); limited support in Windows environment
2. PHP 5.3.29 or later
3. WordPress 3.7 or later
Requirements

Installation
Manual Install
http://wp-cli.org/#installing
Third-Party Companies 
https://wp-cli.org/docs/hosting-companies/
Vagrant
https://github.com/Varying-Vagrant-Vagrants/VVV

Why Bother

Improved productivity means less
human sweat, not more.
Henry Ford

65%The amount of time I save setting up WordPress
compared to the 5 Minute Install

wp command subcommand --options --paramaters
Syntax

wp
wp-cli

command
the section of WordPress you want to work with

subcommand
the action we want to take on the section

--options
definable options or settings for your subcommand

--parameters
global options that can be assigned to any command

Setup WordPress

wp core download
download and unpack the latest version of WordPress

wp core download --version=4.6
you can also specify the version of WordPress you want to download

wp core download --locale=nl_NL
you can also specify the language for WordPress

wp core config --prompt
creates wp-config.php

wp db create
creates your database specified in wp-config is it doesn’t exist

wp core install --prompt
populates your database with the WordPress tables using the supplied data

Working with Plugins

wp plugin list
displays a table list all your installed plugins

wp plugin delete hello
deletes the Hello Dolly plugin

wp plugin install jetpack
installs the Jetpack plugin

wp plugin activate jetpack
activates the Jetpack plugin

wp plugin install wp-super-cache --activate
installs and activates the WP Super Cache plugin

wp plugin install buddypress woocommerce
install multiple plugins

wp plugin install bbpress —version=2.5.9
installs version 2.5.9 of bbPress

wp plugin update bbpress
updates the bbPress plugin to the latest version

wp plugin --all
updates all plugins

wp plugin search 'Yoast SEO'
searches wordpress.org plugin repository for 'Yoast Seo'
and returns a table list of results

wp plugin toggle bbpress
activates bbpress if the plugin is currently inactive
deactivates the plugin if it is currently active

Working with Themes

wp theme list
displays a table list all available themes

wp theme search 'travel blog'
searches wordpress.org plugin repository for 'travel blog'
and returns a table list of relevant themes

wp theme search 'travel blog'  
--fields=name,slug,rating,num_ratings
returns the same table list of relevant themes but includes
a column for the number of ratings for the theme

wp theme search 'travel blog'  
--per-page=50
updates the number of items returns from 10 to 50

wp theme install nisarg --activate
installs and activates the Nisarg theme

wp theme delete twentysixteen
deletes the twentysixteen theme
(themes can only be deleted when they are not active)

Working with Posts

wp post list
displays a table list all available themes 
(by default only lists items from the 'post' post type)

wp post list
displays a table list of posts 
(by default only lists items from the 'post' post type)

wp post list --post_type=post,page
displays a table list of posts narrowed by the 'post' and 'page' post type

wp post create --post_type=page  
--post_title= 'Sample Page'
--post_name=sample-page-one
--post_status=publish
--post_content= '<p>Some test.</p>'
creates a post of the 'page' post type defining the  
page title, slug, status and content

wp post generate --count=100
creates 100 posts for the 'post' post type 
(generate defaults to the 'post' post type and 'published' post_status)

wp post delete 3
deletes the post with the post ID of '3'
(the deleted post is moved to the trash)

wp post delete 4 --force
permanently deletes the post with the post ID of '4'
(skips moving the post to the trash)

wp post delete 5 6
deletes the post with the post ID of '4' and '5'

wp post delete $(wp post list --format=ids)
deletes all posts of the 'post' post type  
(--format=ids returns a list of post IDs space delimited)

wp post delete  
$(wp post list --post_status=trash --format=ids)
empties the trash for posts that belong to the 'post' post type

Generate Post Content

curl loripsum.net/api/5/short/headers/ul/bq
| wp post generate --post_content --count=5
retrieves dummy html markup and and applies it to
the post_content for each generated post

for n in {1..5}; do
curl loripsum.net/api/5/short/headers/ul/bq
| wp post generate --post_content --count=1; done
uses a for loop to get our dummy html markup to be used for generated post content 
using the for loop allows the content being generated to be dynamic 
(note: the count option needs to be set to 1. the loop is dictating the count)

Export / Import

wp export --dir=../
exports all posts to the parent directory you are currently in

wp export --dir=../ --post_type=page
exports all post in the 'page' post type  
to the parent directory you are currently in

wp import ../<filename>
imports the data found in the export file  
located in the parent directory

The Database

wp db export ../my-export.sql
exports your WordPress database to the parent directory
with the file name my-export.sql

wp db import ../my-export.sql
imports the exported WordPress database found in the parent directory
with the file name my-export.sql

Search and Replace

wp search-replace old-domain.com new-domain.com
performs a serialized search and replace on the database 
changes old-domain.com to new-domain.com
(no plugin or third-party library needed)

Working with Media

wp media import ../sample-files/*
imports all files found in the 'sample-files' folder
found in the parent directory

wp media import
http://www.emagine.com/assets/logo.png
imports an image via the assets URL

wp media regenerate
regenerates all thumbnails created by WordPress 
(no additional plugin needed)

wp media regenerate <attachment_id>
regenerates all thumbnails for a specific media item 
(no additional plugin needed)

Working with Core

wp core check-update
checks if there is an update available for your
current version of WordPress

wp core update
updates WordPress to the latest version  
(if an update is available)

wp core update-db
updates the WordPress database if needed

wp core verify-checksums
verifies that the core files in your WordPress install match wordpress.org's

wp core multisite-convert
changes a single site install to a multisite install
(defaults to sub-directories)

wp core multisite-convert --subdomains
changes a single site install to a sub-domain multisite install

Resources
http://wp-cli.org/docs/
http://wp-cli.org/commands/
https://wp-cli.org/docs/external-resources/

Don’t Fear the  
Command Line

Whenever you are asked if you can do a job,
tell 'em, “Certainly I can!”
Then get busy and find out how to do it.
Theodore Roosevelt

Thank You

Getting Started with WP-CLI

More Related Content

What's hot

Viewers also liked

Similar to Getting Started with WP-CLI

Recently uploaded

Getting Started with WP-CLI