Useful WP-CLI Commands

Abhijeet Pratap
Page content

About the WP-CLI and how it works

The WordPress Command-Line Interface (WP-CLI) is a powerful and official command-line tool for managing various aspects of a WordPress website. It provides a set of commands that allow users to perform administrative tasks without needing to use the traditional WordPress admin interface. WP-CLI is particularly useful for developers, system administrators, and advanced users who prefer working with the command line.

How WP-CLI Works:

WP-CLI operates through a command-line interface, allowing users to interact with a WordPress site using commands entered into a terminal or command prompt. Here are some key aspects of how WP-CLI works:

  1. Installation:

    • WP-CLI is a separate tool that needs to be installed on the server where your WordPress site is hosted. Installation instructions can be found on the official WP-CLI website.

  2. Command Structure:

    • Commands are structured in a way that reflects the WordPress administrative structure. For example, commands related to posts, plugins, themes, users, and more are organized accordingly.

  3. Syntax:

    • The basic syntax of a WP-CLI command is wp [command] [subcommand] [options] [arguments]. For example, to update WordPress to the latest version, you would use the command wp core update.

  4. Functionality:

    • WP-CLI provides a wide range of commands for various tasks, including:
      • Core Management: Update, install, and manage the WordPress core.
      • Plugin and Theme Management: Install, activate, deactivate, and manage plugins and themes.
      • Database Operations: Import, export, and perform database operations.
      • User Management: Create, delete, and manage user accounts.
      • Content Management: Create, update, and delete posts, pages, and other content.
      • Site Configuration: Manage settings, permalinks, and other site configurations.

  5. Automation and Scripting:

    • WP-CLI is often used in scripts and automation workflows, allowing developers to perform routine tasks or set up deployment processes.

What Users Can Do with WP-CLI:

  1. Automate Updates:

    • Users can automate the process of updating WordPress core, plugins, and themes using WP-CLI commands.

  2. Manage Plugins and Themes:

    • Activate or deactivate plugins and themes, install new ones, and perform updates without accessing the WordPress admin interface.

  3. Database Operations:

    • Perform database backups, imports, and other operations directly from the command line.

  4. User Management:

    • Create and manage user accounts, change passwords, and perform user-related tasks.

  5. Content Management:

    • Create and manage posts, pages, categories, and tags without using the WordPress admin interface.

  6. Site Configuration:

    • Change site settings, update permalinks, and manage other configuration options from the command line.

  7. Troubleshooting:

    • WP-CLI can be a handy tool for troubleshooting and diagnosing issues on a WordPress site, as it provides insights into various aspects of the site’s configuration.

WP-CLI enhances the efficiency of managing WordPress sites, especially for users comfortable with the command line. It’s important to note that while it provides powerful capabilities, users should be cautious and ensure they understand the impact of each command, especially when dealing with tasks that can affect the site’s functionality and data.

Useful WP CLI Commands

WP-CLI provides a variety of commands to perform different tasks on a WordPress site. Here are some common and useful WP-CLI commands along with a brief explanation of how they work:

  1. wp core update:

    • Description: Updates the WordPress core to the latest version.
    • Usage: wp core update

  2. wp plugin install:

    • Description: Installs a WordPress plugin.
    • Usage: wp plugin install <plugin-slug>

  3. wp plugin activate:

    • Description: Activates a specific plugin.
    • Usage: wp plugin activate <plugin-slug>

  4. wp theme install:

    • Description: Installs a WordPress theme.
    • Usage: wp theme install <theme-slug>

  5. wp theme activate:

    • Description: Activates a specific theme.
    • Usage: wp theme activate <theme-slug>

  6. wp post list:

    • Description: Lists posts on the site.
    • Usage: wp post list

  7. wp post create:

    • Description: Creates a new post.
    • Usage: wp post create --post_type=post --post_title='Post Title' --post_content='Post Content' --post_status=publish

  8. wp user list:

    • Description: Lists users on the site.
    • Usage: wp user list

  9. wp user create:

    • Description: Creates a new user.
    • Usage: wp user create <username> <email> --role=editor

  10. wp option get:

    • Description: Retrieves the value of a site option.
    • Usage: wp option get <option-name>

  11. wp search-replace:

    • Description: Searches and replaces strings in the database.
    • Usage: wp search-replace 'old-string' 'new-string'

  12. wp db export:

    • Description: Exports the WordPress database to a file.
    • Usage: wp db export

  13. wp db import:

    • Description: Imports a database file into the WordPress database.
    • Usage: wp db import <file.sql>

  14. wp rewrite flush:

    • Description: Flushes the rewrite rules.
    • Usage: wp rewrite flush

  15. wp cache flush:

    • Description: Clears the object cache.
    • Usage: wp cache flush

These are just a few examples, and there are many more commands available. To get detailed information about each command, you can use the --help flag. For example:

  • wp core update --help
  • wp plugin install --help
  • wp post create --help

This will provide you with information about the command’s options, usage, and examples. Keep in mind that some commands may require additional parameters, and it’s important to check the documentation or use the --help option for more details.