Команда WP-CLI wp doctor: Диагностика WordPress

Команда wp doctor позволяет провести серию проверок для выявления возможных проблем в установке WordPress. Этот инструмент помогает разработчикам и администраторам сайтов быстро находить слабые места и оптимизировать работу WordPress.

Установка пакета

Команда wp doctor не входит в базовую комплектацию WP-CLI. Для её использования необходимо установить дополнительный пакет wp-cli/doctor-command.

Шаги установки:

1. Убедитесь, что WP-CLI обновлён до последней версии:

wp cli update

2. Установите пакет с помощью следующей команды:

wp package install wp-cli/doctor-command

После установки команда wp doctor станет доступной для использования.

Основные команды

Команда wp doctor предоставляет два основных действия:

1. wp doctor check
   Выполняет серию диагностических проверок для выявления проблем.
2. wp doctor list
   Показывает список доступных проверок и их описание.

Команда wp doctor check

Эта команда запускает проверки, чтобы выявить возможные проблемы в WordPress.

Синтаксис:

wp doctor check [{checks}...] [--all] [--spotlight] [--config={file}] [--fields={fields}] [--format={format}]

Аргументы и параметры:

• [{checks}...]: Названия конкретных проверок, которые нужно запустить. Если не указано, необходимо использовать --all.
• [--all]: Запуск всех доступных проверок.
• [--spotlight]: Фокус только на предупреждениях и ошибках, игнорирует успешные проверки.
• [--config={file}]: Использует пользовательский файл конфигурации проверок.
• [--fields={fields}]: Указывает, какие поля отображать. По умолчанию: name,status,message.
• [--format={format}]: Определяет формат вывода. Возможные значения:
  • table (по умолчанию)
  • json
  • csv
  • yaml
  • count

Пример 1: Проверка всех доступных тестов

wp doctor check --all

Пример 2: Проверка состояния обновлений ядра WordPress

wp doctor check core-update

Пример вывода:

+-------------+---------+-----------------------------------------------------------+
| name        | status  | message                                                   |
+-------------+---------+-----------------------------------------------------------+
| core-update | warning | A new major version of WordPress is available for update. |
+-------------+---------+-----------------------------------------------------------+

Пример 3: Использование пользовательского файла проверок

Создайте файл doctor.yml с определением пользовательских тестов:

plugin-w3-total-cache:
  check: Plugin_Status
  options:
    name: w3-total-cache
    status: uninstalled

Запуск:

wp doctor check --config=doctor.yml

Пример вывода:

+-----------------------+--------+
| name                  | status |
+-----------------------+--------+
| plugin-w3-total-cache | error  |
+-----------------------+--------+

Пример 4: Вывод результата в формате JSON

Для интеграции с другими системами можно использовать формат JSON:

wp doctor check autoload-options-size --format=json

Команда wp doctor list

Отображает список всех доступных проверок и их описание.

Синтаксис:

wp doctor list [--config={file}] [--fields={fields}] [--format={format}]

Аргументы и параметры:

• [--config={file}]: Использует пользовательский файл конфигурации проверок.
• [--fields={fields}]: Указывает, какие поля отображать. По умолчанию: name,description.
• [--format={format}]: Определяет формат вывода (table, json, csv, count).

Пример использования wp doctor list

wp doctor list

Пример вывода:

+----------------------------+--------------------------------------------------------------------------------+
| name                       | description                                                                    |
+----------------------------+--------------------------------------------------------------------------------+
| autoload-options-size      | Warns when autoloaded options size exceeds threshold of 900 kb.                |
| constant-savequeries-falsy | Confirms expected state of the SAVEQUERIES constant.                           |
| constant-wp-debug-falsy    | Confirms expected state of the WP_DEBUG constant.                              |
| core-update                | Errors when new WordPress minor release is available; warns for major release. |
| core-verify-checksums      | Verifies WordPress files against published checksums; errors on failure.       |
+----------------------------+--------------------------------------------------------------------------------+

Примеры доступных проверок

• autoload-options-size: Проверяет общий размер автозагружаемых опций.

wp doctor check autoload-options-size

• cron-count: Проверяет общее количество зарегистрированных задач Cron.

wp doctor check cron-count

• plugin-update: Предупреждает о доступных обновлениях плагинов.

wp doctor check plugin-update

• php-in-upload: Проверяет наличие PHP-файлов в директории загрузок.

wp doctor check php-in-upload

• language-update: Указывает на доступные обновления языковых файлов.

wp doctor check language-update

Преимущества использования wp doctor

1. Экономия времени: Позволяет быстро выявить проблемы, которые могли бы быть обнаружены только при детальном анализе.
2. Автоматизация: Легко интегрируется в системы CI/CD.
3. Гибкость: Возможность создавать собственные тесты для уникальных требований проекта.
4. Простота: Понятные результаты в удобных форматах для анализа.

Заключение

Команда wp doctor — это мощный инструмент для диагностики WordPress. Она помогает автоматизировать процесс поиска проблем и улучшать производительность сайта. Настройка пользовательских проверок через файл doctor.yml делает её ещё более универсальной и полезной. Используйте wp doctor для оптимизации ваших проектов и поддержания их в идеальном состоянии!