WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru

Глобальные параметры

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

Подробнее про глобальные параметры читайте здесь.

Список глобальных параметров

--path={path}
Путь к файлам WordPress.
--url={url}
Как-будто запрос пришел с указанного URL. В multisite этот аргумент определяет способ указания целевого сайта.
--ssh=[{scheme}:][{user}@]{host|container}[:{port}][{path}]
Выполнить операцию над удаленным сервером по SSH (или контейнером по схеме docker, docker-compose, vagrant). Подробнее читайте здесь.
--http={http}
Проводить операции с удаленным сайтом на WordPress через HTTP.
--user={id|login|email}
Устанавливает текущего пользователя WordPress.
--skip-plugins[={plugins}]
Пропускает подгрузку всех плагинов. Или через запятую можно указать, какие плагины пропустить. МЮ плагины будут работать всегда!
--skip-themes[={themes}]
Пропускает подгрузку всех тем. Или через запятую можно указать, какие темы пропустить.
--skip-packages
Пропускает подгрузку всех установленных пакетов (installed packages).
--require={path}
Подгружает указанный php файл перед тем как запустить команду. Можно указать несколько файлов.
--[no-]color
Нужно ли раскрашивать вывод?
--debug[={group}]
Показывать все ошибки PHP и добавить детали в вывод WP-CLI. Встроенные группы включают: bootstrap, commandfactory и help.
--prompt[={assoc}]
Указывает пользователю ввести значения для всех аргументов команды. Значения указываются через запятую.
--quiet
Подавлять информационные сообщения.
--context

allows users to select the WordPress context in which WP-CLI is supposed to execute its command(s).

  • cli: The context which has been the default before introduction of this flag. This is something in-between a frontend and an admin request, to get around some of the quirks of WordPress when running on the console.

  • admin: A context that simulates running a command as if it would be executed in the administration backend. This is meant to be used to get around issues with plugins that limit functionality behind an is_admin() check.

  • auto: Switches between cli and admin depending on which command is being used. For this initial release, all wp plugin and wp theme commands will use admin, while all other commands will use cli.

  • frontend: [WIP] This does nothing yet.

Где

  • [] - то что в квадратных скобках, можно указывать можно не указывать.
  • {} - значения в фигурных скобках - это изменяемые значения параметра.
  • | - этим символом показано, что можно указать либо одно, либо другое значение.
Примеры

Получим все метаполя записи 18 у сайта сети woman.site.ru:

wp post meta list 18 --url=woman.site.ru

Запустим команду из любой директории, указан путь ВП (где находится файл wp-settings.php):

wp post meta list 1 --path=/home/kama/sites/wp-kama.dev/public_html/core/

Выполнить PHP файл перед запуском команды:

wp post meta list 1 --require=/path/to/file.php

Конфигурационные файлы

WP-CLI может автоматически обнаруживать и считывать параметры из нескольких типов конфигурационных файлов (при их наличии). :

  1. Файл wp-cli.local.yml внутри текущей рабочей директории (или выше).
  2. Файл wp-cli.yml в текущей рабочей директории (или выше).
  3. Файл ~/.wp-cli/config.yml (путь может быть изменен с помощью установки переменной окружения WP_CLI_CONFIG_PATH).

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

Вот аннотированный пример файла wp-cli.yml:

# Global parameter defaults
path: wp-core
url: http://example.com
user: admin
color: false
disabled_commands:
  - db drop
  - plugin install
require:
  - path-to/command.php

# Subcommand defaults (e.g. `wp config create`)
config create:
	dbuser: root
	dbpass:
	extra-php: |
		define( 'WP_DEBUG', true );
		define( 'WP_POST_REVISIONS', 50 );

# Aliases to other WordPress installs (e.g. `wp @staging rewrite flush`)
# An alias can include 'user', 'url', 'path', 'ssh', or 'http'
@staging:
	ssh: wpcli@staging.wp-cli.org
	user: wpcli
	path: /srv/www/staging.wp-cli.org
@production:
	ssh: wpcli@wp-cli.org:2222
	user: wpcli
	path: /srv/www/wp-cli.org

# Aliases can reference other aliases to create alias groups
# Alias groups can be nested
@both:
 - @staging
 - @production

# '_' is a special value denoting configuration options for this wp-cli.yml
_:
	# Merge subcommand defaults from the upstream config.yml, instead of overriding
	merge: true
	# Inherit configuration from an arbitrary YAML file
	inherit: prod.yml

Обратите внимание на конфиг disabled_commands он позволяет указать список команд которые нельзя будет запустить.

Переменные окружения

Поведение WP-CLI может быть изменено во время выполнения с помощью переменных окружения:

  • WP_CLI_CACHE_DIR - Каталог для хранения файлового кэша WP-CLI. По умолчанию ~/.wp-cli/cache/.
  • WP_CLI_CONFIG_PATH - Путь к глобальному файлу config.yml. По умолчанию ~/.wp-cli/config.yml.
  • WP_CLI_CUSTOM_SHELL - Позволяет пользователю переопределить используемую по умолчанию оболочку /bin/bash.
  • WP_CLI_DISABLE_AUTO_CHECK_UPDATE - Отключить автоматическую проверку обновлений WP-CLI.
  • WP_CLI_PACKAGES_DIR - Каталог для хранения пакетов, установленных с помощью управления пакетами WP-CLI. По умолчанию ~/.wp-cli/packages/.
  • WP_CLI_PHP - Путь к бинарным файлам PHP, используемый при переопределении системного значения по умолчанию (работает только для не-Phar установки).
  • WP_CLI_PHP_ARGS - Аргументы для передачи бинарному файлу PHP при вызове WP-CLI (работает только при не-Phar установке).
  • WP_CLI_SSH_PRE_CMD - При использовании --ssh=<ssh>, выполните команду перед вызовом WP-CLI на удаленном сервере.
  • WP_CLI_STRICT_ARGS_MODE - Избегайте двусмысленности, указав WP-CLI рассматривать любые аргументы перед командой как глобальные, а после команды - как локальные.
  • WP_CLI_SUPPRESS_GLOBAL_PARAMS - Установите ''true'', чтобы не показывать глобальные параметры в конце экрана справки. Это экономит место на экране для опытных пользователей.

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

# Use vim to edit a post
$ EDITOR=vim wp post edit 1

Чтобы установить одно и то же значение переменной окружения для каждого сеанса оболочки, вам нужно включить определение переменной окружения в файл ~/.bashrc или ~/.zshrc.

# Always use vim to edit a post
export EDITOR=vim
2 комментария
    Войти