\n\n\n\n
What Is WP-CLI?<\/h2>\n
\nWP-CLI is the command-line interface for WordPress, enabling users to manage their WordPress sites without a web browser. It’s a set of command-line tools for handling WordPress tasks, including managing themes, plugins, and databases.
\n<\/p>\n <\/div>\n\n\n\n<\/p>
While the WordPress admin dashboard offers a user-friendly experience, WP-CLI elevates website management. Using the command-line interface, you can perform tasks more swiftly and even automate various site maintenance aspects.<\/p>
WP-CLI is particularly useful for WordPress developers<\/a> who handle multiple sites, facilitating streamlined management directly from the command line.<\/p> WP-CLI offers various advantages for both regular users and freelancers. Here’s why you should consider using the WordPress command-line interface:<\/p> WP-CLI has come a long way, and its latest stable version is WP-CLI v2<\/strong>, <\/strong>with the newest release being 2.8.1<\/strong>. This release brings updated features and improved stability to help you manage your WordPress site efficiently.<\/p> Here are the minimum requirements for running WP-CLI v2:<\/p> Updating to the latest version is recommended for several reasons:<\/p> Installing WP-CLI is straightforward whether you’re on a hosting plan or a local Linux environment.<\/p> Fortunately, WP-CLI is already installed if you’re using Hostinger’s Premium plan or above for web hosting<\/a> and managed WordPress hosting<\/a>. <\/p> To use it, activate SSH<\/a> access on your hPanel<\/strong>. Here’s how:<\/p> For those on VPS hosting<\/a> or any Linux environment, you can manually install WP-CLI using the steps below:<\/p> After installing WP-CLI, familiarize yourself with its primary features. This command-line tool lets you accomplish many tasks efficiently. Mastering these WP-CLI commands will help you manage your WordPress site directly from the command line.<\/p> To ensure you’re running the current version of WP-CLI, you can check this tool’s installed version routinely. Open your command-line tool and enter:<\/p> You’ll see an output similar to:<\/p> For more detailed information, including the PHP<\/a> and MySQL version, you can use this command:<\/p> The output will look like the following:<\/p> If you’re on an outdated version, you can easily update WP-CLI by running the wp cli update <\/strong>command below:<\/p> The output will confirm the updated version, such as:<\/p> WP-CLI offers built-in documentation that contains essential command information. To view a complete list of available commands, type the following:<\/p> You should see the output as follows:<\/p> To exit the help page, press Q<\/strong>.<\/p> If you need details about a particular WP-CLI command, this tool offers comprehensive help documentation. This includes syntax, options, and examples.<\/p> For instance, to learn more about the wp user<\/strong> command, you can type:<\/p> You’ll see the output detailing usage, available arguments, and other essential information:<\/p> You can also use the help<\/strong> command for subcommands. For example, to access the help page for the wp user update<\/strong> command, type:<\/p> Installing WordPress<\/a> through WP-CLI is quick and efficient. Before starting, ensure you’ve created a MySQL<\/a> database, as it’s a prerequisite for WordPress installation.<\/p> With Hostinger, you can create a MySQL database in hPanel by navigating to Databases → Management<\/strong> via the sidebar.<\/p> Fill in the database’s name, username, and password to create a new database.<\/p> Alternatively, follow these steps to create a new MySQL database using the command line:<\/p> After setting up the MySQL database, you can install WordPress from the command line. First, navigate to the public_html<\/strong> directory, where your website files should reside. To check the current directory, run the following:<\/p> If you’re not in public_html<\/strong>, navigate accordingly:<\/p> Once you’re in the public_html<\/strong> directory, proceed as follows:<\/p> The output will confirm the WordPress installation:<\/p> From listing all installed themes to installing a new one, WP-CLI streamlines these tasks effortlessly.<\/p> First, if you want to view all the currently installed themes, use:<\/p> This command will display an output like:<\/p> If you want to switch your active theme from Twenty Twenty-Two to Astra, for instance, use the following command:<\/p> You will see an output similar to:<\/p> You can also utilize WP-CLI to find themes from the WordPress repository. Here’s an example to search for themes with Bootstrap<\/a> support:<\/p> You should see an output similar to the following:<\/p> For example, to install and activate The Bootstrap Blog theme, utilize the command below:<\/p> If you want to see more wp theme<\/strong> subcommands, run the command as is. Here’s the output you will see:<\/p> WP-CLI simplifies WordPress plugin<\/a> management from installation to deactivation. Let’s go over how you can do this effortlessly.<\/p> To list currently installed plugins, use the following command:<\/p> The output will look like this:<\/p> To install a new plugin<\/a> like WooCommerce, use the following wp plugin install<\/strong> command:<\/p> The output will confirm the installation:<\/p> To activate this newly installed WordPress plugin, use:<\/p> You will then see:<\/p> To install multiple plugins in one go, list the plugin slugs separated by a space:<\/p> You can search for plugins in the WordPress repository using the command below. For example, to find WordPress cache plugins, type:<\/p> This will generate an output similar to:<\/p> For more wp plugin<\/strong> commands, run:<\/p> Here’s a glimpse of the output you can expect:<\/p> Updating your WordPress site, themes, and plugins is essential for performance and security. WP-CLI streamlines this process so your site can run the latest WordPress updates.<\/p> To update WordPress<\/a> to the latest version, run:<\/p> You should see this output:<\/p> Next, check if a database update is needed by running:<\/p> After the update, the output will confirm like this:<\/p> To verify your current WordPress version, use:<\/p> Keeping your installed plugins up-to-date is also crucial. To update plugins, use:<\/p> The output will read:<\/p> Make sure to update your themes, as well. To update all of them, run:<\/p> You’ll see the following output:<\/p> For targeted updates, replace the –all<\/strong> parameter with the specific theme or plugin slug.<\/p> If you need to change your WordPress URL, WP-CLI simplifies this process.<\/p> To modify the home address, run the wp option update<\/strong> command, replacing http:\/\/example.com<\/strong> with your domain name.<\/p> The output will confirm as follows:<\/p> To adjust the site URL, use the same command but swap home<\/strong> with siteurl<\/strong>:<\/p> You’ll see this output:<\/p> In some cases, WordPress core files may get corrupted due to faulty updates or hacking attempts. WP-CLI provides a quick way to reinstall these core files without affecting your site’s content and settings.<\/p> To reinstall the WordPress core<\/a>, run the following command:<\/p> This command will skip downloading the wp-content<\/strong> directory and forcibly overwrite all other existing WordPress core files. The output should be:<\/p> After downloading the core files, verify their integrity with this command:<\/p> If everything is clear, you should see:<\/p> Managing content on WordPress can be time-consuming if you’re doing it manually. WP-CLI streamlines this process, enabling you to create, edit, and delete posts and media directly from the command line.<\/p> Managing Posts<\/strong><\/p> To view a list of all posts, run the following command:<\/p> You’ll see an output similar to this:<\/p> In this example, the post with the title Hello world!<\/strong> has an ID of 1<\/strong>. To move this post to the trash, use:<\/p> The output will read:<\/p> To create a new post, run:<\/p> This command will open your system’s default text editor. Once you’ve added the content, save and exit the editor to see the output:<\/p> If you have a draft saved as a TXT <\/strong>file in the directory, you can import it directly with:<\/p> To generate multiple posts for testing, use:<\/p> Managing Comments<\/strong><\/p> To approve a pending comment with a specific comment ID, use:<\/p> The output will confirm with:<\/p> To list all the comments on a post, you can run:<\/p> The output will display a list of comments associated with the post:<\/p> Managing Media<\/strong><\/p> You can automate image imports using WP-CLI. For instance, to import all images from a folder named images_for_site<\/strong>, run:<\/p> You should see an output like this:<\/p> WP-CLI offers simple yet powerful commands for exporting and importing WordPress data. Whether moving to a new host or backing up content, these commands make the process more efficient.<\/p> To export all your WordPress posts into an XML<\/strong> file, use the following command:<\/p> This will save the XML <\/strong>file to the specified directory, after which you’ll see this output:<\/p> You can also export specific types of content, like pages or custom post types. For instance, to export all pages, use:<\/p> To import an XML <\/strong>file into WordPress, use:<\/p> The –authors=create<\/strong> flag ensures that new authors mentioned in the XML<\/strong> file are created if they don’t already exist. You’ll see an output like:<\/p> You can also skip specific content or attachments during import. For example, to skip attachments, run:<\/p> Managing your WordPress database is crucial for optimal website performance. WP-CLI simplifies database tasks, offering a set of commands you can run directly from the command line.<\/p> To display all registered WordPress users, use this command:<\/p> You’ll get an output similar to this:<\/p> To export your WordPress database, run:<\/p> This saves an SQL <\/strong>file in your current directory. You’ll see this output:<\/p> To import an SQL <\/strong>file into your WordPress database, run the following:<\/p> After a successful import, you’ll see:<\/p> Periodically, it’s beneficial to check your database for errors. Use this command for a quick repair:<\/p> You’ll get this confirmation message:<\/p> Finally, keep your database optimized for smooth site performance. Execute the following:<\/p> You’ll see this output:<\/p> Bulk changes to your WordPress content, URLs, or database fields usually require manual effort or specialized database plugins<\/a>. However, WP-CLI offers a helpful search and replace command that automates this process.<\/p> To replace a string throughout your database, run:<\/p>What Are the Benefits of WP-CLI?<\/h3>
\n
WP-CLI v2<\/h3>
\n
\n
\nImportant!<\/strong> Although WP-CLI can be installed in older PHP and WordPress versions, we recommend updating to the latest releases for enhanced security.
\n<\/p><\/div>\n\n\n\n<\/p>How to Install WP-CLI?<\/h2>
![\"\"](\"https:\/\/imagedelivery.net\/LqiWLm-3MGbYHtFuUbcBtA\/wp-content\/uploads\/sites\/2\/2024\/06\/New-WP_in-text-banner.png\/public\")
<\/a><\/figure>\n
![\"Selecting](\"\/tutorials\/wp-content\/uploads\/sites\/2\/2023\/10\/hpanel-advanced-ssh-access.png\")
<\/a><\/figure><\/div>\n
![\"SSH](\"\/tutorials\/wp-content\/uploads\/sites\/2\/2023\/10\/hpanel-advanced-ssh-access-enable-highlighted-1024x350.png\")
<\/a><\/figure><\/div>\n
curl -O https:\/\/raw.githubusercontent.com\/wp-cli\/builds\/gh-pages\/phar\/wp-cli.phar<\/pre>
\n
php wp-cli.phar --info<\/pre>
\n
chmod +x wp-cli.phar<\/pre>
\n
sudo mv wp-cli.phar \/usr\/local\/bin\/wp<\/pre>
\n
wp core install<\/pre>
Common WP-CLI Commands<\/h2>
How to Check WP-CLI Version<\/h3>
wp cli version<\/pre>
WP-CLI 2.8.1<\/pre>
wp --info<\/pre>
PHP binary: \/usr\/bin\/php8.2
PHP version: 8.2.0
php.ini used: \/etc\/php\/8.1\/cli\/php.ini
MySQL binary: \/usr\/bin\/mysql
MySQL version: mysql Ver 8.0.27-0ubuntu0.22.04.1 for Linux on x86_64 ((Ubuntu))
SQL modes:
WP-CLI root dir: \/home\/wp-cli\/
WP-CLI vendor dir: \/home\/wp-cli\/vendor
WP_CLI phar path:
WP-CLI packages dir: \/home\/wp-cli\/.wp-cli\/packages\/
WP-CLI global config:
WP-CLI project config: \/home\/wp-cli\/wp-cli.yml
WP-CLI version: 2.8.1
<\/pre>wp cli update<\/pre>
Success: WP-CLI updated to 2.8.1<\/pre>
How to Access the List of WP-CLI Commands and Help Documentation<\/h3>
wp<\/pre>
NAME\n wp\nDESCRIPTION\n Manage WordPress through the command-line.\nSYNOPSIS\n wp <command>\nSUBCOMMANDS\n cache Adds, removes, fetches, and flushes the WP Object Cache object.\n cap Adds, removes, and lists capabilities of a user role.\n cli Reviews current WP-CLI info, checks for updates, or views defined aliases.\n.....\n<\/pre>
How to Learn More About a Specific Command<\/h3>
wp help user<\/pre>
NAME\n wp user\nDESCRIPTION\n Manages users, along with their roles, capabilities, and meta.\nSYNOPSIS\n wp user <command>\nSUBCOMMANDS\n add-cap Adds a capability to a user.\n add-role Adds a role to a user.\n create Creates a new user.\n ...\n<\/pre>
wp help user update<\/pre>
How to Install WordPress via WP-CLI<\/h3>
![\"Database](\"\/tutorials\/wp-content\/uploads\/sites\/2\/2023\/10\/hpanel-databases-management-1024x407.png\")
<\/a><\/figure><\/div>\n
mysql -u root -p<\/pre>
\n
CREATE USER 'username';\nCREATE DATABASE 'databasename';<\/pre>
\n
GRANT ALL PRIVILEGES ON databasename.* TO 'username' IDENTIFIED BY 'yourpassword';<\/pre>
\n
quit<\/pre>
pwd<\/pre>
cd \/home\/username\/public_html<\/pre>
\n
wp core download<\/pre>
\n
wp config create --dbname=databasename --dbuser=username --dbpass=password --dbhost=localhost --dbprefix=wp_<\/pre>
\n
wp core install --url=\"your_domain.com\" --title=\"Your Site Title\" --admin_user=\"username\" --admin_password=\"password\" --admin_email=\"you@domain.com\"<\/pre>
Success: WordPress installed successfully.<\/pre>
How to Install and Manage WordPress Themes via WP-CLI<\/h3>
wp theme list<\/pre>
+----------------+----------+--------+---------+\n| name | status | update | version |\n+----------------+----------+--------+---------+\n| astra | inactive | none | 4.3.1 |\n| twentytwentytwo| active | none | 1.4 |\n+----------------+----------+--------+---------+\n<\/pre>
wp theme activate astra<\/pre>
Success: Switched to 'Astra' theme.<\/pre>
wp theme search bootstrap<\/pre>
Success: Showing 10 of 630 themes.\n+-----------------------+-----------------------+--------+\n| name | slug | rating |\n+-----------------------+-----------------------+--------+\n| Bootstrap Fitness | bootstrap-fitness | 0 |\n| Bootstrap Coach | bootstrap-coach | 0 |\n| The Bootstrap Blog | the-bootstrap-blog | 100 |\n...\n<\/pre>
wp theme install the-bootstrap-blog --activate<\/pre>
usage: wp theme activate <theme>\n or: wp theme auto-updates <command>\n or: wp theme delete [<theme>...] [--all] [--force]\n...\n<\/pre>
How to Install and Manage WordPress Plugins via WP-CLI<\/h3>
wp plugin list<\/pre>
+----------------+----------+--------+---------+\n| name | status | update | version |\n+----------------+----------+--------+---------+\n| akismet | inactive | none | 5.3 |\n| hello-dolly | active | none | 1.7.2 |\n+----------------+----------+--------+---------+\n<\/pre>
wp plugin install woocommerce<\/pre>
Success: Installed 1 of 1 plugins.<\/pre>
wp plugin activate woocommerce<\/pre>
Success: Plugin 'woocommerce' activated.<\/pre>
wp plugin install woocommerce gutenberg<\/pre>
wp plugin search cache<\/pre>
Success: Showing 10 of 1010 plugins.\n+--------------------------------+--------------------------+--------+\n| name | slug | rating |\n+--------------------------------+--------------------------+--------+\n| LiteSpeed Cache | litespeed-cache | 96 |\n| W3 Total Cache | w3-total-cache | 88 |\n| WP Fastest Cache | wp-fastest-cache | 98 |\n…\n<\/pre>
wp plugin<\/pre>
usage: wp plugin activate <plugin> \n or: wp plugin deactivate <plugin> \n or: wp plugin install <plugin> [--activate] \n...\n<\/pre>
How to Update WordPress via WP-CLI<\/h3>
wp core update<\/pre>
Success: WordPress updated successfully.<\/pre>
wp core update-db<\/pre>
Success: WordPress database updated.<\/pre>
wp core version<\/pre>
wp plugin update --all<\/pre>
Success: Updated x of x plugins.<\/pre>
wp theme update --all<\/pre>
Success: Updated x of x themes.<\/pre>
How to Change WordPress URL via WP-CLI<\/h3>
wp option update home \"http:\/\/example.com\"<\/pre>
Success: Updated 'home' option.<\/pre>
wp option update siteurl \"http:\/\/example.com\"<\/pre>
Success: Updated 'siteurl' option.<\/pre>
How to Reinstall WordPress Core via WP-CLI<\/h3>
wp core download --skip-content --force<\/pre>
Success: WordPress downloaded.<\/pre>
wp core verify-checksums<\/pre>
Success: WordPress installation verifies against checksums.<\/pre>
How to Manage Content via WP-CLI<\/h3>
wp post list<\/pre>
+----+--------------+-------------+---------------------+-------------+\n| ID | post_title | post_name | post_date | post_status |\n+----+--------------+-------------+---------------------+-------------+\n| 1 | Hello world! | hello-world | 2023-06-06 03:39:33 | publish |\n+----+--------------+-------------+---------------------+-------------+\n<\/pre>
wp post delete 1<\/pre>
Success: Trashed post 1.<\/pre>
wp post create --post_status=publish --post_title=\"This Post Was Created With WP-CLI\" --edit<\/pre>
Success: Created post 10.<\/pre>
wp post create .\/post.txt --post_title='Sample Post' --post_status=publish<\/pre>
wp post generate --count=10<\/pre>
wp comment approve 45<\/pre>
Success: Approved comment 45.<\/pre>
wp comment list --post_id=1234<\/pre>
+------------+---------------------+--------------+\n| comment_ID | comment_date | comment_content |\n+------------+---------------------+--------------+\n| 34 | 2023-10-18 12:34:56 | Great post! |\n+------------+---------------------+--------------+\n<\/pre>
wp media import images-for-site\/*<\/pre>
Imported file 'images-for-site\/image-1.jpg' as attachment ID 25.\nImported file 'images-for-site\/image-2.jpg' as attachment ID 26.\nSuccess: Imported 2 of 2 items.<\/pre>
How to Export\/Import WordPress via WP-CLI<\/h3>
wp export --dir=\/path\/to\/folder<\/pre>
Success: Wrote 'filename.xml' to '\/path\/to\/folder'.<\/pre>
wp export --post_type=page<\/pre>
wp import \/path\/to\/file.xml --authors=create<\/pre>
Success: Imported from 'file.xml'.<\/pre>
wp import \/path\/to\/file.xml --skip=attachment<\/pre>
How to Manage Database Using WP-CLI<\/h3>
wp db query \"SELECT user_login, ID FROM wp_users;\"<\/pre>
+------------+----+\n| user_login | ID |\n+------------+----+\n| user | 1 |\n+------------+----+\n<\/pre>
wp db export<\/pre>
Success: Exported to 'wordpress_db.sql'.<\/pre>
wp db import filename.sql<\/pre>
Success: Imported from 'filename.sql'.<\/pre>
wp db repair<\/pre>
Success: Database repaired.<\/pre>
wp db optimize<\/pre>
Success: Database optimized.<\/pre>
How to Search and Replace Using WP-CLI<\/h3>
wp search-replace 'old-string' 'new-string'<\/pre>