WP-CLI — это интерфейс командной строки для WordPress. Вы можете обновлять плагины, настраивать многосайтовые установки и многое другое без использования веб-браузера.
Постоянное техническое обслуживание становится возможным благодаря:
Текущая стабильная версия — версия 2.11.0. Чтобы получать анонсы, подписывайтесь на @wpcli в Твиттере или подпишитесь на рассылку обновлений по электронной почте. Ознакомьтесь с дорожной картой, чтобы получить представление о том, что запланировано на предстоящие выпуски.
Быстрые ссылки: Использование | Установка | Поддержка | Расширение | Содействие | Кредиты
WP-CLI предоставляет интерфейс командной строки для многих действий, которые вы можете выполнить в администраторе WordPress. Например, wp plugin install --activate
(doc) позволяет установить и активировать плагин 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 также включает команды для многих вещей, которые вы не можете сделать в администраторе WordPress. Например, wp transient delete --all
(doc) позволяет удалить один или все переходные процессы:
$ wp transient delete --all
Success: 34 transients deleted from the database.
Для более полного ознакомления с использованием WP-CLI прочитайте краткое руководство. Или пообщайтесь с друзьями по оболочке, чтобы узнать о полезных утилитах командной строки.
Уже чувствуете себя комфортно с основами? Ознакомьтесь с полным списком команд, чтобы получить подробную информацию об управлении темами и плагинами, импорте и экспорте данных, выполнении операций поиска и замены в базе данных и многом другом.
Загрузка файла Phar — рекомендуемый метод установки для большинства пользователей. При необходимости ознакомьтесь также с нашей документацией по альтернативным методам установки (Composer, Homebrew, Docker).
Перед установкой WP-CLI убедитесь, что ваша среда соответствует минимальным требованиям:
После проверки требований загрузите файл wp-cli.phar с помощью wget
или curl
:
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
Затем проверьте файл Phar, чтобы убедиться, что он работает:
php wp-cli.phar --info
Чтобы использовать WP-CLI из командной строки, набрав wp
, сделайте файл исполняемым и переместите его куда-нибудь в PATH. Например:
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp
Если WP-CLI был установлен успешно, при запуске 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
Вы можете обновить WP-CLI с помощью wp cli update
(doc) или повторив шаги установки.
Если WP-CLI принадлежит пользователю root или другому системному пользователю, вам необходимо запустить sudo wp cli update
.
Хотите жить на грани? Запустите wp cli update --nightly
, чтобы использовать последнюю ночную сборку WP-CLI. Ночная сборка более или менее стабильна, чтобы вы могли использовать ее в своей среде разработки, и всегда включает в себя новейшие и лучшие функции WP-CLI.
WP-CLI также поставляется со сценарием завершения табуляции для Bash и ZSH. Просто загрузите wp-completion.bash и получите его из ~/.bash_profile
:
source /FULL/PATH/TO/wp-completion.bash
Не забудьте после этого запустить source ~/.bash_profile
.
Если вы используете zsh для своей оболочки, вам может потребоваться загрузить и запустить bashcompinit
перед поиском исходного кода. Поместите следующее в свой .zshrc
:
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash
Сопровождающие и участники WP-CLI имеют ограниченную возможность решать общие вопросы поддержки. Текущая версия WP-CLI — единственная официально поддерживаемая версия.
При поиске поддержки сначала найдите свой вопрос в следующих местах:
Если вы не нашли ответа ни на одном из сайтов выше, вы можете:
#cli
в Slack WordPress.org, чтобы общаться со всеми, кто доступен в данный момент. Этот вариант лучше всего подходит для быстрых вопросов.Проблемы GitHub предназначены для отслеживания улучшений и ошибок существующих команд, а не для общей поддержки. Прежде чем отправлять отчет об ошибке, ознакомьтесь с нашими рекомендациями, чтобы обеспечить своевременное решение вашей проблемы.
Пожалуйста, не задавайте вопросы поддержке в Твиттере. Твиттер не является приемлемым местом для поддержки, потому что: 1) сложно поддерживать разговоры длиной менее 280 символов и 2) Твиттер — это не то место, где кто-то, задавший тот же вопрос, может найти ответ в предыдущем разговоре.
Помните, бесплатно != бесплатно; лицензия открытого исходного кода дает вам свободу использования и изменения, но не требует отнимать время других людей. Пожалуйста, будьте уважительны и устанавливайте свои ожидания соответственно.
Команда — это атомарная единица функциональности WP-CLI. wp plugin install
(doc) — это одна команда. wp plugin activate
(doc) — еще один.
WP-CLI поддерживает регистрацию любого вызываемого класса, функции или замыкания в качестве команды. Он считывает сведения об использовании из PHPdoc обратного вызова. WP_CLI::add_command()
(doc) используется как для внутренней, так и для сторонней регистрации команд.
/**
* 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 поставляется с десятками команд. Создать собственную команду WP-CLI проще, чем кажется. Прочтите кулинарную книгу команд, чтобы узнать больше. Просмотрите внутреннюю документацию API, чтобы узнать о множестве полезных функций, которые вы можете использовать в своей собственной команде WP-CLI.
Мы ценим, что вы проявили инициативу и внесли свой вклад в WP-CLI. Именно благодаря вам и сообществу вокруг вас WP-CLI стал таким замечательным проектом.
Вклад не ограничивается только кодом. Мы рекомендуем вам вносить свой вклад так, как это лучше всего соответствует вашим способностям: писать учебные пособия, проводить демо-версии на местных встречах, помогать другим пользователям с вопросами о поддержке или редактировать нашу документацию.
Прочтите наши рекомендации по участию в руководстве, чтобы получить подробное представление о том, как вы можете принять участие. Следование этим рекомендациям поможет показать, что вы уважаете время других участников проекта. В свою очередь, они сделают все возможное, чтобы ответить вам взаимностью при работе с вами, в разных часовых поясах и по всему миру.
У WP-CLI есть один сопровождающий проекта: schlessera.
Иногда мы предоставляем доступ для записи участникам, которые в течение определенного периода времени продемонстрировали, что они способны и вкладывают средства в продвижение проекта.
Прочтите документ управления в руководстве, чтобы получить более подробную информацию о проекте.
Помимо библиотек, определенных в композиторе.json, мы использовали код или идеи из следующих проектов:
wp shell
wp media regenerate
wp search-replace
wp export
wp import
wp scaffold plugin-tests