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

Глобальні параметри (аргументи, опції) можна додати до будь-якої команди. Ведуть ці параметри однаково для будь-якої команди. Вони впливають на те, як загалом 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

дозволяє користувачам вибрати WordPress context, в якому WP-CLI є відповідним для виконання його комбінації(s).

• cli: The context which has been the default before introduction of this flag. Це є деякий в-поміж frontend і admin request, щоб отримати по одному з quirks WordPress при керуванні на консолі.

• admin: У контексті, що simulates running a command as it it would be executed in the administration backend. Це означає, що використовувався для отримання інших функцій з модулями, що обмежена функціональність при is_admin() check.

• auto: Перемикання між cli і admin depending on which command is being used. Для цього початкового виконання, всі wp plugin і wp theme commands will use admin, while all other commands will use cli.

• frontend: [WIP] This does nothing yet.

Де

• []– те, що в квадратних дужках, можна вказувати можна не вказувати.
• {}– значення у фігурних дужках – це значення параметра, що змінюються.
• |– цим символом показано, що можна вказати або одне або інше значення.

Приклади

Отримаємо всі метаполі запису 18 у сайту мережі woman.example.com:

wp post meta list 18 --url=woman.example.com

Запустимо команду з будь-якої директорії, вказано шлях ВП (де знаходиться файл 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 (eg `wp config create`)
config create:
	dbuser: root
	dbpass:
	extra-php: |
		define( 'WP_DEBUG', true );
		define( 'WP_POST_REVISIONS', 50);

# Aliases to other WordPress installs (eg `wp @staging rewrite flush`)
# В іншому випадку може бути 'user', 'url', 'path', 'ssh', або 'http'
@staging:
	ssh: [email protected]
	user: wpcli
	path: /srv/www/staging.wp-cli.org
@production:
	ssh: [email protected]: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

Змінні оточення

Поведінка 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.

# Будь ласка, використовуйте vim для edit a post
export EDITOR=vim