WordPress WP-CLI

WP-CLI — это интерфейс командной строки для WordPress, используемый для выполнения задач администрирования и разработки программным способом. Страница проекта: wp-cli.org.

Данное руководство — перевод официальной документации WordPress.org по данному инструменту. Нужна помощь? Пожалуйста, ознакомьтесь с доступными вариантами поддержки.

Хотите помочь сделать WP-CLI лучше? Ознакомьтесь с руководством по внесению вклада для ознакомления или создайте свой первый pull request.

Руководство в процессе перевода, некоторые разделы могут быть не полными, что означает, что они в процессе работы.

Альтернативные методы установки

Установка WP-CLI через Git

Если вы собираетесь работать над самим WP-CLI, обратитесь к блоку Setting up (Настройка) в разделе Pull Requests этого справочника.

Установка nightly через Phar

Nightly — это самая современная версия WP-CLI, собранная прямо из ветки master.

Просто следуйте обычным инструкциям по установке, за исключением изменения URL-адреса файла phar:

https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli-nightly.phar

Установка через Composer

Как часть проекта

Добавьте следующую строку в файл composer.json вашего проекта:

"require" : {
    "wp-cli/wp-cli-bundle": "*"
}

Чтобы добавить любые дополнительные пакеты, предложенные в пакете wp-cli-bundle, такие как psy/psysh, выполните команду:

composer require --dev $(composer suggests --by-package | awk '/wp-cli\/wp-cli-bundle/' RS= | grep -o -P '(?<=- ).*(?=:)')

Опционально (если вы работаете на сервере или, например, на виртуальной машине локально) вы можете автоматизировать настройку команды и сделать ее доступной в path пользователя. Допустим, Composer установлен в /var/www/vendor (вы можете получить конфигурационную переменную composer vendor-dir для вашей машины с помощью composer config --list | grep "[vendor-dir]"), мы можем добавить следующие скрипты/команды в файл composer.json. Вторая и третья строки устанавливают bash completion, чтобы нам не приходилось запоминать все команды:

"scripts" : {
    "post-install-cmd" : [
        "[[ -f /usr/bin/wp ]] || sudo ln -s /var/www/vendor/wp-cli/wp-cli/bin/wp /usr/bin/wp",
        "source /var/www/vendor/wp-cli/wp-cli/utils/wp-completion.bash",
    "[[ -f ~/.bash_profile ]] || touch ~/.bash_profile",
        "source ~/.bash_profile"
    ]
}

Вышеприведенный скрипт предполагает, что ваша текущая оболочка — bash, что может быть не у всех пользователей. Пример для vagrant box (добавлен в scripts — block):

cat /etc/passwd | grep $(whoami)
vagrant:x:1000:1000::/home/vagrant:/bin/bash

Если у вас есть доступный и установленный bash для вашей ОС, вы можете переключаться динамически:

"scripts" : {
    "post-update-cmd" : [
        "/bin/bash -c \"[[ -f /usr/local/bin/wp ]] || sudo ln -s /var/www/vendor/wp-cli/wp-cli/bin/wp /usr/bin/wp\"",
        "/bin/bash -c \"source /var/www/vendor/wp-cli/wp-cli/utils/wp-completion.bash\"",
    "/bin/bash -c \"[[ -f ~/.bash_profile ]] || touch ~/.bash_profile\"",
        "/bin/bash -c \"source ~/.bash_profile\""
    ]
}

Как проект

Требуется установить php и composer (или php composer.phar) в качестве консольных команд.

composer create-project wp-cli/wp-cli-bundle --prefer-source

Затем запустите wp-cli-bundle/vendor/wp-cli/wp-cli/bin/wp или добавьте папку wp-cli-bundle/vendor/wp-cli/wp-cli/bin в PATH для глобальной команды wp (в Windows вместо нее используйте wp-cli/bin/wp.bat).

Для обновления вам потребуется:

cd wp-cli-bundle
git pull origin main
composer install

Глобальные требования

Если вы предпочитаете, чтобы инструменты PHP были установлены глобально через Composer и у вас в PATH есть что-то вроде ~/.composer/vendor/bin (или C:\Users\you\AppData\Roaming\Composer\vendor\bin в Windows) , вы можете просто запустить:

composer global require wp-cli/wp-cli-bundle

Чтобы обновить все глобально, запустите composer global update.

Установка определенной версии

Если вы хотите установить определенную версию WP-CLI, то добавьте номера версий после пакетов

composer create-project wp-cli/wp-cli-bundle:2.1.0 --no-dev

Версия должна быть в формате, понятном Composer, и может быть найдена на сайте packagist.org.

Установка новейшей версии

Если вы хотите установить новейшую версию, используйте dev-main:

composer create-project wp-cli/wp-cli-bundle:dev-main --no-dev

Глобальная установка в качестве проекта

Вы можете указать собственный путь установки WP-CLI, например, так:

composer create-project wp-cli/wp-cli-bundle /usr/share/wp-cli --no-dev

Затем просто сделайте симлинк на двоичный файл:

sudo ln -s /usr/share/wp-cli-bundle/vendor/wp-cli/wp-cli/bin /usr/bin/wp

Установка через Homebrew

brew install wp-cli

Вот формула.

Установка через Docker

Сообщество Docker поддерживает образы WordPress и WP-CLI.

Чтобы включить образ WP-CLI в свой собственный проект:

image: wordpress:cli

Установка на Windows

Установите с помощью composer, как описано выше, или используйте следующий метод.

Убедитесь, что php установлен и находится в вашем path, чтобы вы могли выполнить его глобально.

Скачайте wp-cli.phar вручную и сохраните его в папку, например, c:\wp-cli.

Создайте файл wp.bat в папке c:\wp-cli со следующим содержимым:

@ECHO OFF
php "c:/wp-cli/wp-cli.phar" %*

Добавьте c:\wp-cli в свой путь:

setx path "%path%;c:\wp-cli"

Теперь вы можете использовать WP-CLI из любого места командной строки Windows.

Установка через пакет .deb

В Debian или Ubuntu просто скачайте и откройте один из пакетов .deb:

https://github.com/wp-cli/builds/tree/gh-pages/deb

Установка на Fedora 30+

su -c 'dnf install wp-cli'

Установка на CentOS

su -c 'yum install wp-cli'

Использование пользовательского двоичного файла PHP

В некоторых случаях, например, при установке MAMP, вы можете не использовать бинарный файл PHP по умолчанию.

Чтобы использовать последнюю версию PHP, предоставляемую MAMP, вам нужно изменить переменную окружения PATH, добавив следующее в ~/.bash_profile или ~/.zsh_profile:

PHP_VERSION=$(ls /Applications/MAMP/bin/php/ | sort -n | tail -1)
export PATH=/Applications/MAMP/bin/php/${PHP_VERSION}/bin:$PATH

Чтобы использовать определенную версию PHP, предоставляемую MAMP, вам нужно определить путь к исполняемому файлу версии PHP и изменить переменную окружения PATH, добавив следующее в ~/.bash_profile или ~/.zsh_profile:

export PATH=/Applications/MAMP/bin/php/php5.5.26/bin:$PATH

Обратите внимание, что в этом случае переменная PHP_VERSION не присваивается, потому что мы не ищем динамически последнюю версию PHP.

После того, как вы добавили всё и сохранили файл, перезагрузите его с помощью:

source ~/.bash_profile

После этого запустите wp --info, чтобы убедиться, что изменения были применены правильно.

Для установки WP-CLI на базе Composer и Git можно альтернативно установить переменную окружения WP_CLI_PHP, если вы по каким-то причинам не хотите изменять PATH.

Установка на MediaTemple

См. ссылку:

http://razorfrog.com/installing-wp-cli-on-mediatemple-grid-server/

Быстрый старт

Поздравляем! Вы впервые установили WP-CLI и готовы усовершенствовать использование WordPress. Эта страница содержит краткое введение в WP-CLI с некоторыми примерами использования.

WP-CLI — это интерфейс командной строки для WordPress.

Цель проекта — предложить полную альтернативу административной панели WordPress (админке); для любого действия, которое вы захотите выполнить в админке WordPress, должна существовать эквивалентная команда WP-CLI.

Например, поскольку вы можете установить плагин из админки WordPress, вы также можете установить плагин с помощью WP-CLI:

$ wp plugin install akismet
Installing Akismet (3.1.8)
Downloading install package from https://downloads.wordpress.org/plugin/akismet.3.1.8.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.

И, поскольку вы также можете активировать плагины из админки WordPress, вы можете активировать плагин с помощью WP-CLI:

$ wp plugin activate akismet
Success: Plugin 'akismet' activated.

Одно из ключевых различий между использованием админки WordPress и WP-CLI: для выполнения любого действия требуется гораздо меньше кликов.

По мере знакомства с командной строкой вы заметите, что выполнение той или иной задачи с помощью WP-CLI обычно происходит гораздо быстрее, чем выполнение той же задачи через админку WordPress. Инвестирование времени в изучение того, как лучше использовать WP-CLI, приносит дивиденды в долгосрочной перспективе.

Общие термины

На протяжении всего использования WP-CLI вы будете слышать, как некоторые термины используются снова и снова.

Например, команда — это атомарная единица функциональности WP-CLI. wp plugin install является одной из таких команд, как и wp plugin activate. Команды представляют собой имя (например, ‘plugin install’) и обратный вызов, и регистрируются с помощью WP_CLI::add_command().

Синопсис определяет, какие позиционные и ассоциативные аргументы принимает команда. Давайте рассмотрим синопсис для команды wp plugin install:

$ wp plugin install
usage: wp plugin install <plugin|zip|url>... [--version=<version>] [--force] [--activate] [--activate-network]

В этом примере … является принятым позиционным аргументом. На самом деле, wp plugin install принимает один и тот же позиционный аргумент (slug (строка идентификатор), ZIP или URL плагина для установки) несколько раз. [--version=<version>] — один из принятых ассоциативных аргументов. Он используется для обозначения версии устанавливаемого плагина.

Обратите внимание на квадратные скобки вокруг определения аргумента; квадратные скобки означают, что аргумент необязателен.

WP-CLI также имеет ряд глобальных аргументов, которые работают со всеми командами. Например, включение --debug означает, что выполнение вашей команды будет отображать все ошибки PHP и добавит дополнительную информацию в процесс начальной загрузки WP-CLI.

Готовы погрузиться? Вот несколько распространенных примеров использования WP-CLI:

Скачивание и установка WordPress за считанные секунды

1. Скачайте последнюю версию WordPress с помощью wp core download:

$ wp core download --path=wpclidemo.dev
Creating directory '/srv/www/wpclidemo.dev/'.
Downloading WordPress 4.6.1 (en_US)...
Using cached file '/home/vagrant/.wp-cli/cache/core/wordpress-4.6.1-en_US.tar.gz'...
Success: WordPress downloaded.

2. Создайте новый файл wp-config.php с помощью wp config create:

$ cd wpclidemo.dev
$ wp config create --dbname=wpclidemo --dbuser=root --prompt=dbpass
1/10 [--dbpass=<dbpass>]:
Success: Generated 'wp-config.php' file.

3. Создайте базу данных на основе wp-config.php с помощью wp db create:

$ wp db create
Success: Database created.

4. Установите WordPress с помощью wp core install:

$ wp core install --url=wpclidemo.dev --title="WP-CLI" --admin_user=wpcli --admin_password=wpcli --admin_email=info@wp-cli.org
Success: WordPress installed successfully.

Вот и все!

Обновление плагинов до последней версии

Используйте wp plugin update --all, чтобы обновить все плагины до последней версии.

$ wp plugin update --all
Enabling Maintenance mode...
Downloading update from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the plugin...
Plugin updated successfully.
Downloading update from https://downloads.wordpress.org/plugin/nginx-champuru.3.2.0.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the plugin...
Plugin updated successfully.
Disabling Maintenance mode...
Success: Updated 2/2 plugins.
+------------------------+-------------+-------------+---------+
| name                   | old_version | new_version | status  |
+------------------------+-------------+-------------+---------+
| akismet                | 3.1.3       | 3.1.11      | Updated |
| nginx-cache-controller | 3.1.1       | 3.2.0       | Updated |
+------------------------+-------------+-------------+---------+

Добавление пользователя в качестве супер-админа

На многосайтовом сайте используйте wp super-admin add для предоставления полномочий супер администратора существующему пользователю.

$ wp super-admin add wpcli
Success: Granted super-admin capabilities.

Регенерация миниатюр

Если вы добавили или изменили размер изображения, зарегистрированного с помощью add_image_size(), вы можете использовать wp media regenerate, чтобы ваша тема отображала правильный размер изображения.

wp media regenerate --yes
Found 1 image to regenerate.
1/1 Regenerated thumbnails for "charlie-gpa" (ID 4).
Success: Finished regenerating the image.

Интересно, что дальше? Просмотрите все команды WP-CLI, чтобы открыть для себя новый мир.

Как использовать WP-CLI

Используя WP-CLI, вы можете выполнять определенные задачи с помощью командной строки вместо доступа к панели администратора WordPress. В следующих разделах мы рассмотрим шаг за шагом некоторые из этих задач.

Как установить WordPress
Как перевести сайт в режим обслуживания
Как запустить веб-сервер
Как создать пользовательский плагин

Создание пользовательского плагина

Если вы хотите создавать свои плагины, в WP-CLI есть мощная команда scaffold, которая позволяет нам генерировать начальный код. В этом руководстве мы рассмотрим, как сгенерировать начальный код для обычного плагина.

Шаг 1. Подготовка файлов плагина через scaffold

Приведенная ниже команда использует несколько опций, позволяющих нам указать slug плагина, его название, описание, имя автора и uri, а также uri плагина. Вы можете заменить значения, переданные в опциях ниже, чтобы настроить плагин в соответствии с вашими потребностями.

$ wp scaffold plugin wpcli-demo-plugin --plugin_name="WP-CLI Demo Plugin" --plugin_description="This is a wp-cli demo plugin" --plugin_author=wp-cli --plugin_author_uri="https://wp-cli.org" --plugin_uri="https://plugins.wp-cli.org/demo-plugin"Success: Created plugin files.
    Success: Created test files.

Приведенная выше команда создает новую папку wpcli-demo-plugin в каталоге plugins со следующей структурой файлов.

| - bin/
| - tests/
| - .gitignore
| - .editorconfig
| - .phpcs.xml.dist
| - .travis.yml
| - Gruntfile.js
| - package.json
| - phpunit.xml.dist
| - readme.txt
| - wpcli-demo-plugin.php

Если вы не используете флаг -skip-tests, всегда генерируются следующие файлы:

phpunit.xml.dist — это файл конфигурации для PHPUnit.
.travis.yml — это файл конфигурации для Travis CI. Используйте --ci=<provider>, чтобы выбрать другую службу.
bin/install-wp-tests.sh настраивает набор тестов WordPress и тестовую базу данных.
tests/bootstrap.php — это файл, который делает текущий плагин активным при запуске набора тестов.
tests/test-sample.php — это файл-пример, содержащий тестовые примеры.
.phpcs.xml.dist — это коллекция правил PHP_CodeSniffer.

Шаг 2. Создание пользовательского типа записи

Теперь мы можем снова использовать команду scaffold, чтобы добавить пользовательский тип поста внутри нашего нового плагина с помощью команды wp scaffold post-type.

$ wp scaffold post-type books --label=Book --textdomain=wpcli-demo-plugin --dashicon=dashicons-book-alt --plugin=wpcli-demo-plugin
Success: Created '/wpcli-demo-plugin/post-types/books.php'.

Шаг 3. Написание кода внутри основного файла

Основной файл плагина wpcli-demo-plugin.php является отправной точкой, которую мы можем использовать для написания логики нашего плагина.

В главном файле плагина давайте теперь обратимся к новому типу поста, который мы только что создали.

Откройте в вашем любимом текстовом редакторе файл wpcli-demo-plugin.php и под строкой Your code starts here (рус. — Ваш код начинается здесь) добавьте следующее:

\\Your code starts here.
require('post-types/books.php');

Шаг 4. Активация плагина

Теперь вы можете использовать две команды wp-cli для проверки списка плагинов и активации только что созданного плагина: wp plugin list и wp plugin activate.

Первая команда выводит список всех установленных плагинов, а вторая активирует заданный плагин.

    $ wp plugin list
    +-------------------+----------+-----------+---------+
    | name              | status   | update    | version |
    +-------------------+----------+-----------+---------+
    | akismet           | inactive | available | 4.1.5   |
    | hello             | inactive | none      | 1.7.2   |
    | wpcli-demo-plugin | inactive | none      | 0.1.0   |
    +-------------------+----------+-----------+---------+

Из списка выше мы видим, что наш плагин wpcli-demo-plugin неактивен. Давайте включим его с помощью второй команды.

    $ wp plugin activate wpcli-demo-plugin
    Plugin 'wpcli-demo-plugin' activated.
    Success: Activated 1 of 1 plugins.

Теперь наш плагин активен.

Мы можем зайти в панель администратора WordPress и начать использовать наш пользовательский тип поста books (рус. — книги).

Установка WordPress

Скачивание и установка WordPress с помощью WP-CLI не представляет собой ничего сложного. Нам потребуется четыре шага.

Во-первых, нам нужно скачать WordPress с помощью команды wp core download.

Шаг 1. Скачиваем WordPress

Синтаксис команды для загрузки WordPress следующий: wp core download [--path=<path>] [--locale=<locale>] [--version=<version>] [--skip-content] [--force].

Запускаем команду:

    $ wp core download --path=wpdemo.test --locale=it_IT
    Creating directory '/wpdemo.test/'.
    Downloading WordPress 5.4.1 (it_IT)...
    md5 hash verified: 3fa03967b47cdfbf263462d451cdcdb8
    Success: WordPress downloaded.

Приведенная выше команда создает папку wpdemo.test/ в текущем рабочем каталоге и загружает последнюю версию WordPress.

Вы можете заменить параметр --path=wpdemo.test на ваше желаемое имя папки и --locale=it_IT на желаемую локаль. Вы можете опустить параметр --locale, и тогда по умолчанию будет загружаться WordPress на американском английском языке с использованием локали en_US.

Шаг 2. Создание (генерация) файла конфигурации

На этом шаге мы создадим файл конфигурации и настроим учетные данные базы данных для нашей установки.

Основной синтаксис команды следующий: wp config create --dbname=<dbname> --dbuser=<dbuser> [--dbpass=<dbpass>].

    $ wp config create --dbname=your_db_name_here --dbuser=your_db_user_here --prompt=dbpass
    1/10 [--dbpass=<dbpass>]: type_your_password
    Success: Generated 'wp-config.php' file.

Приведенная выше команда создает файл wp-config.php и добавляет в него переданные вами учетные данные базы данных.

Обязательно замените your_db_name_here на имя, которое вы хотите присвоить базе данных, замените your_db_user_here на пользователя базы данных и введите пароль базы данных, когда появится следующий вопрос: 1/10 [--dbpass=]:

Шаг 3. Создание базы данных

В этом шаге мы создадим базу данных на основе информации, которую мы передали в файл wp-config.php в шаге 2.

    $ wp db create
    Success: Database created.

Теперь мы готовы перейти к последнему шагу — установке WordPress.

Шаг 4. Установка WordPress

Чтобы теперь установить WordPress, нам нужно выполнить последнюю команду.

    $ wp core install --url=wpclidemo.dev --title="WP-CLI" --admin_user=wpcli --admin_password=wpcli --admin_email=info@wp-cli.org
    Success: WordPress installed successfully.

Не забудьте заменить значения, переданные каждому из следующих параметров, своими данными:

--url=wpclidemo.dev замените wpclidemo.dev на url вашего сайта,
--title="WP-CLI" замените WP-CLI на имя, которое вы хотите присвоить сайту,
--admin_user=wpcli замените wpcli на имя пользователя, которое вы хотите назначить администратору сайта,
--admin_password=wpcli замените wpcli на пароль, который вы хотите использовать для доступа к панели администратора WordPress.

Поздравляем! Вы успешно установили WordPress с помощью WP-CLI.

Перевод сайта в режим техобслуживания

WP-CLI предлагает команду для включения, отключения режима технического обслуживания и проверки, включен ли режим обслуживания или нет.

Шаг 1. Проверка состояния

$ wp maintenance-mode status
Maintenance mode is not active.

Шаг 2. Включение режима обслуживания

$ wp maintenance-mode activate
Enabling Maintenance mode...
Success: Activated Maintenance mode.

Шаг 3. Отключение режима обслуживания

$ wp maintenance-mode deactivate
Disabling Maintenance mode...
Success: Deactivated Maintenance mode.

Запуск веб-сервера

Вы можете использовать команду wp server для запуска встроенного веб-сервера PHP для конкретной установки WordPress.

По умолчанию веб-сервер будет запускаться, используя localhost и порт по умолчанию 8080, но вы можете изменить их с помощью опций --host и --port.

Шаг 1. Запуск веб-сервера с использованием настроек по умолчанию

$ wp server
PHP 7.2.24-0ubuntu0.18.04.4 Development Server started at Thu Jun  4 17:40:13 2020
Listening on http://localhost:8080
Document root is ../wpdemo.test
Press Ctrl-C to quit.

Приведенная выше команда запускает сервер, используя настройки по умолчанию. Теперь мы можем открыть браузер и перейти по ссылке http://localhost:8080 для доступа к установке WordPress.

Шаг 2. Запуск веб-сервера с использованием различных настроек

Если вы хотите указать другой номер порта или хост, вы можете передать их в следующих флагах: --port и --host.

$ wp server --port=9090 --host=192.168.0.4

Приведенная выше команда запустит веб-сервер и будет слушать запросы на http://192.168.0.4:9090.

Вы можете открыть браузер и посетить страницу для доступа к вашей установке WordPress.

Введение

Рекомендуемая установка

Обновление WP-CLI

Tab completions

Bash & Z-Shell

Oh My Zsh

Рабочий процесс Dash/Alfred

Настройка

Использование