WP-CLI adalah antarmuka baris perintah untuk WordPress. Anda dapat memperbarui plugin, mengonfigurasi instalasi multisitus, dan banyak lagi, tanpa menggunakan browser web.
Pemeliharaan berkelanjutan dimungkinkan oleh:
Rilis stabil saat ini adalah versi 2.11.0. Untuk pengumuman, ikuti @wpcli di Twitter atau daftar untuk mendapatkan pembaruan email. Lihat peta jalan untuk ikhtisar tentang apa yang direncanakan untuk rilis mendatang.
Tautan cepat: Menggunakan | Menginstal | Dukungan | Memperluas | Berkontribusi | Kredit
WP-CLI menyediakan antarmuka baris perintah untuk banyak tindakan yang mungkin Anda lakukan di admin WordPress. Misalnya, wp plugin install --activate
(doc) memungkinkan Anda menginstal dan mengaktifkan plugin WordPress:
$ wp plugin install user-switching --activate
Installing User Switching (1.0.9)
Downloading installation package from https://downloads.wordpress.org/plugin/user-switching.1.0.9.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating ' user-switching ' ...
Plugin ' user-switching ' activated.
Success: Installed 1 of 1 plugins.
WP-CLI juga menyertakan perintah untuk banyak hal yang tidak dapat Anda lakukan di admin WordPress. Misalnya, wp transient delete --all
(doc) memungkinkan Anda menghapus satu atau semua transien:
$ wp transient delete --all
Success: 34 transients deleted from the database.
Untuk pengenalan lebih lengkap tentang penggunaan WP-CLI, baca panduan Quick Start. Atau, temui teman-teman shell untuk mempelajari tentang utilitas baris perintah yang bermanfaat.
Sudah merasa nyaman dengan dasar-dasarnya? Masuk ke daftar lengkap perintah untuk informasi rinci tentang pengelolaan tema dan plugin, mengimpor dan mengekspor data, melakukan operasi pencarian-penggantian basis data, dan banyak lagi.
Mengunduh file Phar adalah metode instalasi yang kami rekomendasikan untuk sebagian besar pengguna. Jika Anda memerlukannya, lihat juga dokumentasi kami tentang metode instalasi alternatif (Komposer, Homebrew, Docker).
Sebelum menginstal WP-CLI, pastikan lingkungan Anda memenuhi persyaratan minimum:
Setelah Anda memverifikasi persyaratan, unduh file wp-cli.phar menggunakan wget
atau curl
:
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
Selanjutnya, periksa file Phar untuk memverifikasi apakah file tersebut berfungsi:
php wp-cli.phar --info
Untuk menggunakan WP-CLI dari baris perintah dengan mengetik wp
, buat file dapat dieksekusi dan pindahkan ke suatu tempat di PATH Anda. Misalnya:
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp
Jika WP-CLI berhasil diinstal, Anda akan melihat tampilan seperti ini saat menjalankan wp --info
:
$ wp --info
OS: Linux 5.10.60.1-microsoft-standard-WSL2 # 1 SMP Wed Aug 25 23:20:18 UTC 2021 x86_64
Shell: /usr/bin/zsh
PHP binary: /usr/bin/php8.1
PHP version: 8.1.0
php.ini used: /etc/php/8.1/cli/php.ini
MySQL binary: /usr/bin/mysql
MySQL version: mysql Ver 8.0.27-0ubuntu0.20.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.11.0
Anda dapat mengupdate WP-CLI dengan wp cli update
(doc), atau dengan mengulangi langkah instalasi.
Jika WP-CLI dimiliki oleh root atau pengguna sistem lain, Anda harus menjalankan sudo wp cli update
.
Ingin menjalani hidup di ujung tanduk? Jalankan wp cli update --nightly
untuk menggunakan WP-CLI build nightly terbaru. Nightly build kurang lebih cukup stabil untuk Anda gunakan di lingkungan pengembangan Anda, dan selalu menyertakan fitur WP-CLI terbaru dan terhebat.
WP-CLI juga dilengkapi dengan skrip penyelesaian tab untuk Bash dan ZSH. Cukup unduh wp-completion.bash dan sumber dari ~/.bash_profile
:
source /FULL/PATH/TO/wp-completion.bash
Jangan lupa menjalankan source ~/.bash_profile
setelahnya.
Jika menggunakan zsh untuk shell Anda, Anda mungkin perlu memuat dan memulai bashcompinit
sebelum melakukan sumber. Letakkan yang berikut ini di .zshrc
Anda :
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash
Pengelola dan kontributor WP-CLI memiliki ketersediaan terbatas untuk menjawab pertanyaan dukungan umum. Versi WP-CLI saat ini adalah satu-satunya versi yang didukung secara resmi.
Saat mencari dukungan, silakan cari pertanyaan Anda terlebih dahulu di tempat-tempat berikut:
Jika Anda tidak menemukan jawabannya di salah satu tempat di atas, Anda dapat:
#cli
di WordPress.org Slack untuk mengobrol dengan siapa pun yang ada saat itu. Opsi ini paling cocok untuk pertanyaan singkat.Masalah GitHub dimaksudkan untuk melacak peningkatan dan bug dari perintah yang ada, bukan dukungan umum. Sebelum mengirimkan laporan bug, harap tinjau praktik terbaik kami untuk membantu memastikan masalah Anda ditangani tepat waktu.
Harap jangan mengajukan pertanyaan dukungan di Twitter. Twitter bukanlah tempat yang dapat diterima untuk memberikan dukungan karena: 1) sulit untuk mengadakan percakapan kurang dari 280 karakter, dan 2) Twitter bukanlah tempat di mana seseorang dengan pertanyaan yang sama dapat mencari jawaban dalam percakapan sebelumnya.
Ingat, gratis != gratis; lisensi sumber terbuka memberi Anda kebebasan untuk menggunakan dan memodifikasi, tetapi tidak memberikan komitmen waktu orang lain. Harap bersikap hormat, dan sesuaikan ekspektasi Anda.
Perintah adalah unit atom dari fungsionalitas WP-CLI. wp plugin install
(doc) adalah salah satu perintah. wp plugin activate
(doc) adalah hal lain.
WP-CLI mendukung pendaftaran kelas, fungsi, atau penutupan apa pun yang dapat dipanggil sebagai perintah. Bunyinya rincian penggunaan dari PHPdoc panggilan balik. WP_CLI::add_command()
(doc) digunakan untuk registrasi perintah internal dan pihak ketiga.
/**
* Delete an option from the database.
*
* Returns an error if the option didn't exist.
*
* ## OPTIONS
*
* <key>
* : Key for the option.
*
* ## EXAMPLES
*
* $ wp option delete my_option
* Success: Deleted 'my_option' option.
*/
$ delete_option_cmd = function ( $ args ) {
list ( $ key ) = $ args ;
if ( ! delete_option ( $ key ) ) {
WP_CLI :: error ( " Could not delete ' $ key ' option. Does it exist? " );
} else {
WP_CLI :: success ( " Deleted ' $ key ' option. " );
}
};
WP_CLI :: add_command ( ' option delete ' , $ delete_option_cmd );
WP-CLI hadir dengan lusinan perintah. Lebih mudah daripada membuat perintah WP-CLI khusus. Baca buku masak perintah untuk mempelajari lebih lanjut. Telusuri dokumen API internal untuk menemukan berbagai fungsi bermanfaat yang dapat Anda gunakan dalam perintah WP-CLI khusus Anda.
Kami menghargai Anda mengambil inisiatif untuk berkontribusi pada WP-CLI. Berkat Anda, dan komunitas di sekitar Anda, WP-CLI adalah proyek yang hebat.
Berkontribusi tidak terbatas pada kode saja. Kami mendorong Anda untuk berkontribusi dengan cara yang paling sesuai dengan kemampuan Anda, dengan menulis tutorial, memberikan demo di pertemuan lokal, membantu pengguna lain dengan pertanyaan dukungan mereka, atau merevisi dokumentasi kami.
Bacalah pedoman kontribusi kami di buku pegangan untuk pengenalan menyeluruh tentang bagaimana Anda dapat terlibat. Mengikuti pedoman ini membantu mengomunikasikan bahwa Anda menghargai waktu kontributor lain dalam proyek tersebut. Pada gilirannya, mereka akan melakukan yang terbaik untuk membalas rasa hormat tersebut ketika bekerja dengan Anda, lintas zona waktu dan di seluruh dunia.
WP-CLI memiliki satu pengelola proyek: schlessera.
Kadang-kadang, kami memberikan akses menulis kepada kontributor yang telah menunjukkan, selama jangka waktu tertentu, bahwa mereka mampu dan berinvestasi dalam memajukan proyek ini.
Baca dokumen tata kelola di buku pegangan untuk rincian operasional lebih lanjut tentang proyek ini.
Selain perpustakaan yang ditentukan di composer.json, kami telah menggunakan kode atau ide dari proyek berikut:
wp shell
wp media regenerate
wp search-replace
wp export
wp import
wp scaffold plugin-tests