Как помочь с отладкой плагина WordPress

Разработчики JoomUnited всегда работают так, чтобы ваши плагины работали наиболее оптимальным образом, конечно, в некоторых случаях может произойти какой-то сбой, например, несовместимость, которая возникает из-за третьего плагина, и что мы хотим, когда происходят такие сбои? Конечно, они быстро решаются ...    

В этом посте мы научим вас, как предоставить правильную информацию разработчику, чтобы он мог быстро понять и решить ошибку. Этот пост будет разделен на 3 шага, которые мы будем выполнять, чтобы дать правильную информацию разработчику при возникновении проблемы:

• Включите журнал отладки
• Установите плагин устранения неполадок
• Проверка ошибок JavaScript

Включите систему отладки и ведения журнала WordPress

Прежде всего, нам нужно знать, что WP_DEBUG ; как мы видим в Википедии, « WP_DEBUG — это PHP (постоянная глобальная переменная), которая может использоваться для запуска режима отладки во всем WordPress. По умолчанию она считается ложной и обычно устанавливается в значение true в файле wp-config.php в тестовых версиях WordPress».

Как мы видим WP_DEBUG - это константа, которая по умолчанию выключена , но мы можем включить ее на время отладки. 

В дополнение к этому, существует другая константа PHP WP_DEBUG_LOG , которая поможет нам автоматически создать текстовый файл со всеми ошибками ваших плагинов, и это именно то, что мы отправим разработчикам.  

Мы расскажем вам, как именно мы можем включить его и как это будет выглядеть, если возникнет ошибка с вашим плагином, WP Meta SEO будет использован для этого примера, но вы можете выполнить те же шаги для всех наших плагинов. В этом случае у нас есть проблема с WP Meta SEO, это может быть любая проблема, поэтому мы собираемся открыть wp-config.php файл, это можно сделать с помощью предпочитаемого вами программного обеспечения для редактирования текста, например, Notepad, Visual Studio Code, Brackets, просто откройте wp-config.php

Файл находится в корне вашего сервера, где установлен ваш сайт WordPress.

Откройте его в текстовом редакторе, затем нажмите CTRL + F или выберите «Правка» > «Найти…». Вы увидите поле, куда можно ввести искомое слово. В данном случае мы введем «WP_DEBUG» и будем нажимать Enter, пока не найдем:
«define( 'WP_DEBUG', false )».

Теперь, когда мы находимся на этой строке, удалите “false” и введите true, нажмите Enter и на следующей строке скопируйте define( 'WP_DEBUG_LOG', true ); и сохраните файл, он должен выглядеть как на следующем изображении.

Если эти две строки изменены, файл с именем “debug.php” появится в /wp-content/

И всё… мы завершили первый шаг, это один из файлов, который понадобится нашим разработчикам, чтобы ускорить процесс решения вашей проблемы. Все ошибки будут отслеживаться и записываться в этот самый текстовый файл.

Установите плагин диагностики WordPress

Плагин Health Check & Troubleshooting позволяет запускать проверку на конфликты, не затрагивая обычных посетителей вашего сайта. Он очень прост в использовании и установке, но в этом примере мы по-прежнему будем использовать WP Meta SEO . Чтобы установить и запустить проверку на конфликты с помощью Health Check & Troubleshooting, выполните следующие шаги:  

• Войдите на свой сайт Wordpress, вы окажетесь на панели управления вашего сайта
• Нажмите на «Плагины» в левой части страницы
• Нажмите «Добавить новый»
• Введите “Health Check & Troubleshooting" в строке поиска, как показано ниже

• Нажмите «Установить сейчас». Список плагинов автоматически обновится, найдите нужный плагин, нажмите «Установить сейчас», а затем «Активировать».

• Нажмите на «Состояние сайта». В левом меню есть раздел «Инструменты». Нажмите на него, а затем на «Состояние сайта».

• Перейдите на «Устранение неполадок» , ознакомьтесь с предупреждением и нажмите «Вход в режим устранения неполадок». 

Режим отладки автоматически отключает все плагины и переключается на тему по умолчанию. Режим отладки не влияет на обычных посетителей вашего сайта.  

• Воспроизведите проблему , с которой вы столкнулись

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

• Нажмите «Плагины» > «Установленные плагины»

  Меню “Плагины” развернется, предоставляя вам дополнительные возможности. Нажмите на “Установленные плагины”

• Нажмите «Включить при устранении неполадок» рядом с WP Meta SEO

• Воспроизведите проблему, с которой вы столкнулись только с активным WP Meta SEO и темой по умолчанию, если проблема возникает, проблема вызвана нашим плагином.

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

Проверка и отладка ошибок Javascript в плагинах WordPress

Мы будем искать ошибки Javascript с помощью консоли Chrome или Firefox, в зависимости от вашего браузера название может немного отличаться, но для Chrome и FireFox мы будем называть ее «Консоль». Чтобы открыть консоль, просто следуйте этим шагам:  

• Правый клик на inspect на внешнем интерфейсе в любой части сайта

• Выберите «Консоль». В правой части страницы откроются инструменты разработчика. Нажмите на «Консоль».

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

Если вы обнаружили ошибку JavaScript, пожалуйста, сделайте снимок экрана с развернутой версией ошибки и приложите его к своему сообщению/заявке.

Отправить / Поделиться отчетом о проблеме

Теперь, когда у вас есть вся эта информация, вы поможете разработчику ускорить процесс, просто возьмите всю информацию, которую вы собрали, и добавьте ее в свой тикет/пост, давайте вспомним, что необходимо:  

• debug.log
• Заметка с плагинами, вызывающими конфликты
• Скриншот консоли javascript с ошибкой

Если вы выполните эти шаги и отправите нам правильную информацию, разработчик сможет выполнить работу по отладке быстрее, и мы заранее благодарим вас :)    

Создайте и поделитесь новой учетной записью пользователя WordPress для целей поддержки

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

• Мы не храним старые учетные данные после решения проблемы (по соображениям безопасности)
• Мы рекомендуем удалить учетные записи администратора, созданные для целей поддержки
• Вся информация, предоставленная нашей команде, является безопасной и останется конфиденциальной

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

Затем перейдите в меню слева > Пользователи.

После этого перейдите к верхней части экрана, нажмите на Добавить новый кнопку или перейдите к Добавить новый кнопке в левом меню.

Далее, форма добавления нового пользователя появится на вашем экране. Есть 2 поля, которые необходимо заполнить: Имя пользователя, Эл. почта.

В поле Пароль вы можете использовать генератор случайных паролей или установить свой собственный. И вы можете отметить опцию Отправить уведомление пользователю , если хотите отправить новому пользователю письмо об их учетной записи.

Затем выберите роль пользователя в выпадающем списке. Это важный шаг для настройки прав доступа пользователей к вашему сайту. «Администратор» — это наивысший уровень доступа, предоставляющий пользователю доступ ко всем функциям вашего сайта. Вы можете установить другие роли, если хотите ограничить доступ пользователей.

Наконец, нажмите «Добавить нового пользователя» внизу. Готово, удачи!