Crafting Custom WP-CLI Commands: Unlocking WordPress Flexibility & Adaptability

The world’s most popular content management system, WordPress, powers millions of websites. Even though a lot of people find its design to be easy to use, developers frequently look for more potent tools to make tedious work easier.

With this blog post, we explore the realm of crafting personalized WP CLI commands, offering WordPress an unprecedented degree of adaptability.

Understanding WP-CLI Commands

WordPress Command Line Interface, or WP-CLI, is a strong and adaptable utility that significantly expands WordPress’s capabilities beyond the conventional admin dashboard.

When compared to typical graphical interfaces, this command line interface facilitates faster and more effective workflow by enabling developers to interact with WordPress sites straight from the command line.

As an illustration, rather than enabling a plugin via the admin dashboard after completing the standard procedure (Dashboard > Plugins > Add New > search for the plugin > Install > Activate), you can use the command wp plugin install <plugin-name> --activate to install and activate a plugin in one step.

Although WP-CLI already includes a core set of commands, the real power lies in a developer realizing the potential of the tool and crafting custom commands tailored to the unique requirements of their website.

Pros and Cons of WP-CLI

WP-CLI is an essential part of the WordPress ecosystem, but like any tool, it comes with trade-offs worth knowing upfront.

Creating Custom WP-CLI Commands: An In-Depth Look

There are over 60,000 plugins available for WordPress. The most popular include Yoast SEO, used on over 12 million websites, and Elementor, with over 12 million active installations.

Writing custom WP-CLI commands may sound difficult, but with the right approach, it can be a worthwhile endeavor. Here’s the process, step by step:

Example 1: Clearing All Transients

Transients are a way to temporarily store cached data in WordPress. Sometimes you need to clear all transients to refresh your site’s data. Here’s a custom WP-CLI command for that.

Step 1: Create a plugin

In your wp-content/plugins directory, create a folder called elsner-wp-cli-clear-transients, and inside it, a file named elsner-wp-cli-clear-transients.php

<?php
/*
Plugin Name: Elsner WP-CLI Clear Transients
Description: A simple plugin to clear all transients via WP-CLI.
Version: 1.0
Author: Elsner Technologies
*/

if (defined('WP_CLI') && WP_CLI) {
    class Clear_Transients_Command extends WP_CLI_Command {
        /**
         * Clear all transients.
         * @when after_wp_load
         */
        public function clear() {
            global $wpdb;
            $wpdb->query("DELETE FROM $wpdb->options WHERE option_name LIKE '_transient_%'");
            $wpdb->query("DELETE FROM $wpdb->options WHERE option_name LIKE '_site_transient_%'");
            WP_CLI::success("All transients cleared.");
        }
    }
    WP_CLI::add_command('transients', 'Clear_Transients_Command');
}

Step 2: Activate the plugin

Activate it from the WordPress admin dashboard or via WP-CLI: wp plugin activate elsner-wp-cli-clear-transients

Step 3: Use the command

Run wp transients clear to clear all transients stored in your WordPress database.

Example 2: Listing Custom Post Types

Suppose you want to list all custom post types registered on your WordPress site. Here’s a WP-CLI command for that.

Step 1: Create a plugin

In your wp-content/plugins directory, create a folder called elsner-wp-cli-list-cpt and inside it, a file named elsner-wp-cli-list-cpt.php

<?php
/*
Plugin Name: Elsner WP-CLI List Custom Post Types
Description: A simple plugin to list all custom post types via WP-CLI.
Version: 1.0
Author: Elsner Technologies
*/

if (defined('WP_CLI') && WP_CLI) {
    class List_CPT_Command extends WP_CLI_Command {
        /**
         * List all custom post types.
         * @when after_wp_load
         */
        public function list() {
            $post_types = get_post_types(['_builtin' => false], 'names');
            if (empty($post_types)) {
                WP_CLI::success("No custom post types found.");
                return;
            }
            foreach ($post_types as $post_type) {
                WP_CLI::line($post_type);
            }
        }
    }
    WP_CLI::add_command('cpt', 'List_CPT_Command');
}

Step 2: Activate the plugin

Activate it from the WordPress admin dashboard or via WP-CLI: wp plugin activate elsner-wp-cli-list-cpt

Step 3: Use the command

Run wp cpt list to list all custom post types registered on your WordPress site.

Frequently Asked Questions

Conclusion

Creating custom WP-CLI commands can significantly enhance your WordPress development workflow, offering speed, efficiency, and flexibility. By following the steps and examples above, you can start crafting your own custom commands tailored to your specific needs, unlocking the full potential of WP-CLI and WordPress.