Что такое WP-CLI? Руководство для начинающих

WP-CLI существует уже довольно давно (около 2011 года) и неуклонно набирает обороты в сообществе разработчиков WordPress. Но что именно, и как вы можете использовать его в вашем рабочем процессе WordPress?

Идея WP-CLI заключается в том, что он позволяет вам взаимодействовать с сайтами WordPress и управлять ими через интерфейс командной строки. Согласно официальной документации, это альтернатива командной строке традиционному пользовательскому интерфейсу администратора WordPress.

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

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

Прежде чем идти дальше, я должен сделать признание. Как я уже говорил, я никогда раньше не использовал WP-CLI! Я знал об этом довольно давно и очень хотел испытать его, но так и не смог его установить и использовать. До сих пор это …

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

Вы готовы начать? Хорошо, тогда пошли!

Установка WP-CLI

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

Для начала нам нужно получить последнюю версию WP-CLI. Рекомендуемый способ сделать это — загрузить WP-CLI в виде файла Phar через командную строку. Это всего лишь архивный файл PHP, содержащий все файлы PHP, необходимые для работы WP-CLI, все они упакованы в один удобный файл, готовый для загрузки.

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

Откройте окно терминала и введите следующее:

Это загрузит файл WP-CLI Phar на ваш компьютер. Давайте проверим все в порядке, проверив архив WP-CLI.

Вы должны увидеть вывод, похожий на следующий:

Чтобы сделать использование WP-CLI более удобным, мы хотим иметь возможность запускать его из любого места и с помощью более короткой команды, такой как wp вместо того, чтобы каждый раз вводить wp-cli.phar .

Мы можем сделать это с помощью следующих двух команд:

Теперь попробуйте запустить wp --info в окне терминала (указывая на любой каталог). Если вы видите тот же вывод, что и раньше, когда php wp-cli.phar --info значит, вы в деле. WP-CLI настроен и готов к использованию!

Есть и другие способы установки WP-CLI, например, через Composer, поэтому вы можете попробовать альтернативные методы, если вы боретесь с рекомендуемым методом по умолчанию.

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

Установка в Windows немного сложнее, так как PHP не доступен из командной строки по умолчанию. Вы можете установить PHP вручную, но самый простой способ — использовать локальный сервер разработки, такой как MAMP, потому что PHP автоматически устанавливается как часть общего пакета.

Как только PHP станет доступным в вашей системе, вам нужно будет найти путь к исполняемому файлу PHP и сделать его доступным глобально (это подробно описано в руководстве по PHP ).

Если PHP установлен и доступен из любого каталога, загрузите файл wp-cli.phar вручную и сохраните его в папке, такой как c:\wp-cli . Чтобы можно было запустить WP-CLI с помощью команды wp как мы это делали в macOS, создайте командный файл с именем wp.bat в той же папке, в которой вы сохранили архивный файл wp-cli.phar .

Добавьте это в командный файл:

Наконец, добавьте c:\wp-cli к вашему глобальному пути:

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

Еще более легкий путь!

Если ты чувствуешь себя немного растерянным, тогда у меня может быть спасательный круг для тебя. Если вы пользователь DesktopServer, то WP-CLI чрезвычайно прост в настройке. Начиная с DesktopServer 3.8.2, доступен новый плагин для разработчиков, который устанавливает WP-CLI на всех ваших сайтах разработки!

После активации вы можете получить доступ к WP-CLI через основной список сайтов DesktopServer или панель инструментов WordPress.

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

Использование WP-CLI удаленно

Это руководство предназначено для начинающих, которые не знакомы с WP-CLI и используют локальную установку WordPress. Тем не менее, если вы хотите выполнять команды на удаленном сервере (то есть на живом сайте WordPress), вы все равно можете следовать, если у вас установлен WP-CLI.

Вам нужно будет иметь возможность подключиться к серверу через SSH-клиент и иметь под рукой данные для входа в свою учетную запись хостинга. После подключения и входа в систему вы сможете использовать все команды WP-CLI из этого руководства.

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

Тестирование Воды

Надеюсь, к настоящему времени у вас будет установлен WP-CLI, и в этом случае вы можете немного расслабиться, выполнив самое сложное!

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

Одним из преимуществ использования DesktopServer является то, что он автоматически открывает окно командной строки, указывающее на правильный корневой каталог сайта WordPress. Я подумал, что это было приятно, особенно если вы работаете на нескольких сайтах.

Давайте теперь протестируем нашу установку WP-CLI. Это наша первая команда …

Итак, чтобы получить доступ к WP-CLI, введите wp а затем команду и / или параметр. Если wp , вы просто получите длинный список доступных команд и параметров (которые я здесь не буду показывать, но попробуйте сами).

Наша первая команда содержала параметр. Разница в том, что параметру предшествуют два дефиса. Ключ к WP-CLI заключается в том, что почти все команды содержат подкоманды (и параметры). Эта иерархия очень хорошо организована, ее легко понять и следовать.

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

Давайте рассмотрим несколько основных команд WP-CLI и их вывод, чтобы понять, как это работает.

Сначала давайте получим текущую версию WP-CLI, которую мы используем.

wp --version

Мы можем запустить аналогичную команду, чтобы найти текущую версию WordPress.

Как насчет списка всех тем, установленных в настоящее время?

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

Мы можем сделать то же самое для плагинов.

Мы можем использовать параметры для уточнения списка плагинов.

Здесь у нас есть параметр, который требует указания одного или нескольких значений. Это очень часто, и вы очень быстро привыкнете к этому. В этом случае мы перечислили только те поля, которые мы хотели показать (имя, версия).

Мы также можем показывать только плагины, которые соответствуют определенным критериям.

Это просто выводит все плагины снова, так как они все в настоящее время неактивны. Мы вскоре изменим это, когда начнем вводить команды для управления плагинами (и темами).

Возможно, вы заметили в приведенных выше командах, что используются два командных слова ( plugin и list ). Если вы wp plugin по себе, он не будет запускать команду, а перечислит все wp plugin . Попробуй сам.

Таким образом, команда list — это всего лишь одна из нескольких подкоманд, доступных для команды plugin «parent». Многие другие команды работают аналогичным образом.

Введите wp core и wp theme чтобы увидеть список их подкоманд.

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

По умолчанию вы получаете результаты команды WP-CLI, выведенные в табличном формате, но вместо этого это можно легко изменить на JSON или запятую (CSV), используя параметр --format .

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

Плагины и Темы

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

Для плагинов и тем, размещенных в репозитории WordPress, просто введите имя после команды install следующим образом:

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

Мы можем установить темы аналогичным образом:

И давайте просто проверим, правильно ли была установлена ​​тема Twenty Eleven:

Для плагинов и тем, размещенных в других местах, просто введите полный путь к zip-файлу. Название плагина / темы на самом деле является слагом, который удобно запомнить, если имя вашего плагина / темы состоит из более чем одного слова.

Например, чтобы установить плагин Theme Check из репозитория WordPress:

Чтобы активировать плагин, используйте команду activate .

Или вы можете установить и активировать плагин все в одной строке.

Чтобы удалить плагин, используйте команду delete .

Обратите внимание, что вам не нужно было деактивировать плагин, прежде чем мы удалили его, как вы должны это сделать в админке WordPress. Процесс установки / активации / удаления одинаков для тем.

Сообщения и Страницы

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

Во-первых, давайте выведем текущий список сообщений.

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

Давайте снова посмотрим на обновленный список сообщений.

Как видите, было создано пять новых сообщений, каждое с общим названием и без содержания сообщения. Мы можем генерировать любое количество постов и для любого типа поста.

Это создает три новые страницы с общими названиями и без содержания страницы. Я не слишком уверен в том, насколько полезным является массовое создание постов. Тем не менее, это может быть довольно полезно для тестирования.

Если мы хотим создавать отдельные сообщения, мы имеем полный контроль над содержимым сообщений. Давайте создадим один пост с определенным заголовком и примером содержания.

Это создает сообщение с определенным названием и содержанием. По умолчанию сообщения будут создаваться с черновым состоянием, поэтому, если мы хотим, чтобы они публиковались сразу, нам нужно установить параметр post_status для publish .

Создать страницу с контентом так же просто — просто установите для параметра post_type значение page (по умолчанию это значение post).

Мы также можем обновить существующие сообщения с помощью команды update .

Убедитесь, что идентификатор сообщения правильный; в противном случае вы получите Warning: Invalid post ID сообщения об ошибке. И снова, вы можете обновить любой тип сообщения, а не только сообщения!

Как и следовало ожидать, вы также можете удалять сообщения через WP-CLI.

Это отправит сообщение в корзину. Если вы хотите обойти это и просто навсегда удалить сообщение, добавьте параметр --force .

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

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

WordPress Комментарии

Управление комментариями очень похоже на сообщения. Чтобы увидеть все комментарии на вашем сайте, используйте эту команду:

Будьте осторожны — это может занять некоторое время, если у вас много комментариев на вашем сайте!

Чтобы создать комментарий, используйте команду create мы теперь знакомы.

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

Как и в случае с сообщениями, можно легко создавать массовые комментарии.

Обязательно укажите параметр count если вы не хотите, чтобы генерировалось 100 фиктивных комментариев, так как 100 — это значение по умолчанию!

Чтобы удалить комментарий, просто используйте следующую команду с идентификатором вашего комментария и опционально параметром --force если вы хотите пропустить отправку его в корзину.

Помните, однако, что идентификатор здесь — это идентификатор комментария, а не идентификатор сообщения.

Рекомендуемые ресурсы WP-CLI

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

• Главная страница проекта WP-CLI
• Официальное руководство WP-CLI
• Дорожная карта WP-CLI
• Slack Channel
• Полный список команд WP-CLI
• WP-CLI Twitter Feed
• Полное руководство по DesktopServer

Вывод

Мы только что коснулись того, что вы можете сделать с помощью WP-CLI. Но, надеюсь, теперь у вас будет достаточно уверенности, чтобы глубже вникнуть в WP-CLI и поэкспериментировать с более продвинутыми командами.

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

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

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

Однако некоторые пользователи, особенно начинающие, могут быть отстранены от рекомендуемого по умолчанию процесса установки. Это позор, поскольку WP-CLI чрезвычайно полезен, и все разработчики WordPress должны по крайней мере проверить это.

Это очень весело и полезно. Если у вас есть доступ к DesktopServer, то обязательно используйте его для установки WP-CLI — это действительно просто.

Наконец, если вы заинтересованы в дальнейшей разработке WordPress, не забудьте ознакомиться с другим материалом WordPress, который у нас есть здесь, на Envato Tuts +.

Вы уже используете WP-CLI или впервые экспериментировали с ним? Если да, то как вы пожили? Я хотел бы услышать ваши комментарии!