Группы WordPress Разработка

3 января 2018 в 22:07

Автор: Владимир Otshelnik-Fm

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

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

Предыстория:

Вначале один пользователь сообщил мне что активировав мое дополнение для WordPress плагина WP-Recall он не может перейти в консоль управления мультисайтом (Управление сетью->Консоль)
Вот сюда:

Ок,

"Какую ошибку выдает на момент перехода? Что в Error.log сервера?"

- ответ был такой:
PHP Fatal error: Uncaught Error: Call to undefined function wp_get_current_user() in our-site.ru/wp-includes/capabilities.php:598

Самая засада в том, что мое дополнение не использует функцию wp_get_current_user. Больше никаких подробностей не сообщалось.
Я свои дополнения не тестировал в работе режима мультисайта и не заявляю о его поддержке (потому что малый процент использование его только лишь добавит мне проблем и траты времени на его тестирование и отладку). Поэтому не придал проблеме должного внимания. Но интересное пошло потом - еще один пользователь сообщил мне о проблеме с 2-мя моими дополнениями. Это было накануне новогодних праздников. Так вот после них я и решил глянуть - в чем проблема. Один репорт - случайность, два - закономерность, а три - это уже проблема. Проблемы должны решаться. Что я и сделал вчера.

Поиск виновного:

Установил на поддомене чистый вордпресс, активировал на нем режим мультисайта, взяв дефолтные настройки сети (каждый новый сайт в подкаталоге).
Активировал проблемный доп и перешел по скрину выше в управление мультисайтом. Белый экран.
Полез в логи и вот что увидел:

PHP Fatal error: Uncaught Error: Call to undefined function wp_get_current_user() in .otshelnik-fm.ru/wp-includes/capabilities.php:598
Stack trace:
# 0 .otshelnik-fm.ru/wp-admin/network/settings.php(16): current_user_can('manage_network_...')
# 1 .otshelnik-fm.ru/wp-content/wp-recall/add-on/hello-private-message/index.php(3): require_once('...')
# 2 .otshelnik-fm.ru/wp-content/plugins/wp-recall/functions/addons.php(96): include_once('...')
# 3 .otshelnik-fm.ru/wp-content/plugins/wp-recall/wp-recall.php(400): rcl_include_addon('...', 'hello-private-m...')
# 4 .otshelnik-fm.ru/wp-content/plugins/wp-recall/wp-recall.php(354): WP_Recall->include_addon('hello-private-m...'
# 5 .otshelnik-fm.ru/wp-content/plugins/wp-recall/wp-recall.php(181): WP_Recall->include_addons()
# 6 .otshelnik-fm.ru/wp-includes/capabilities.php on line 598

wp_get_current_user - эту функцию мой доп не использует, но по стеку видно что add-on/hello-private-message/index.php(3) - в 3-й строке доп подключает файл. Но php скрипт не обрывается, а выполняется дальше. Стек трейс мой доп упомянул - значит косвенно он участвует в падении.

Смотрим, что в 3-й строке:
require_once('settings.php'); - и всё!
WTF? Почему подключая файл settings.php, который лежит в корне дополнения, я получаю белый экран? Я закомментировал эту строчку и смог войти в панель управления мультисайтом.

Вернул как было.

Я еще был далек от понимания. В файле settings.php - настройки для админки, но там нет вызова этой функции. Стер весь файл settings.php - он пустой. И снова получаю белый экран с этой же ошибкой.

Тут я понимаю что стек трейс я читаю неверно. Что после подключения settings.php файла я оказываюсь выше по стеку:
/wp-admin/network/settings.php(16): current_user_can('manage_network_...')
а урл, который в админке с белым экраном, такой:
.otshelnik-fm.ru/wp-admin/network/
- и тут пришло озарение: что путь подключения, функция require_once, берет не от корня моего дополнения, а от урл моего нахождения /wp-admin/network/settings.php(16) - вот он settings.php и подключается. Только с другого пути. Перечитал описание функций require_once и require и include и башка вскипела.

Константы __DIR__ и __FILE__ выдают мне пути до моего дополнения.

Я переименовал файл в корне моего дополнения на sssettings.php и исправил в 3й строке подключение к нему на новое имя. Белый экран пропал. Я попал в консоль управления мультисайтом.

Решение проблемы:

Решений несколько:

1. Как вариант - не иметь в корне дополнения (или вашего плагина) файла settings.php и вообще таких имен:

2. Или перенести в подпапку inc свой файл settings.php (подозреваю что имя подпапки не должно совпадать с именем подпапки по вышеуказанному пути - не дай боже второй раз совпадение будет)

3. Подключать файл указав полный путь до дополнения:
require_once rcl_addon_path(__FILE__).'settings.php'; - функция wp-recall - содержит полный путь до вашего дополнения на сервере. Можете и ВП аналогичные функции использовать

4. Вводить проверку:

if( is_admin() && !is_network_admin() ){
    require_once 'settings.php';
}

- мы проверяем что мы в админке, но не на странице управления мультисайтом.

Выводы:

Не все очевидно с багами которые нам встречаются. Мультисайтовая сборка доставляет нам еще один опыт. Виновен ли php - или сам мультисайт? У меня прозрение не наступило - сказать не могу. Но мы получили такой опыт.

Гугл не давал мне результатов кроме одного. Теперь стоит запомнить эту ошибку и внимательнее смотреть к репортам пользователей. Возможно одного пользователя я потерял. Но второй меня заставил все таки пошевелиться и отнестись внимательнее к проблеме. Входных данных конечно было мало и это возможно остановило меня при первом репорте.

Дополнения я свои исправлю. Но не буду утверждать что я поддерживаю работу в режиме мультисайта - тестировать еще одну сущность, да крайне редкую не буду. Только по факту обращения с проблемами.

upd: подобную проблему обнаружил подключая файл из корня: require_once 'setup.php';
- решение такое же, как в заметке выше.