Чек-лист проверки дополнения перед публикацией или обновлением
Эта инструкция будет полезна всем тем пользователям, которые разрабатывают под WordPress и в частности делают свои дополнения для вордпресс плагина WP-Recall.
Я как-то пытался описать проблемы с отображением, которые могут быть у других пользователей, но пока эти записи на форуме не доведены до финала. Ведь мы, разрабатывая на своей конфигурации, можем упустить как очевидные вещи, так и то, что конфигурация у пользователя будет отличаться. Тут я собрал чек-лист того, что можно и нужно сделать, прежде чем публиковать свой новый товар в каталоге цифрового магазина CodeSeller.ru.
Так в чем может быть проблема?
Самая частая проблема - несоответствие дизайна у пользователя, который использует ваш продукт, с тем, что у вас на демо-сайте или скриншоте. Все дело в том, что ВП шаблоны пишутся всякими креативными парнями, а это может привести к тому, что используемая ВП тема перезапишет стили вашего ВП плагина или WP-Recall аддона. Вот та самая незавершенная моя тема на форуме. Но! Вы как автор и не обязаны поддерживать корректное отображение на 100600 ВП шаблонах. ВП шаблоны от разработчиков ВП (twenty) поддерживать как бы нужно. А остальные шаблоны - тут уж вам решать и вам общаться с вашими клиентами. Но прогнав на 5-10 сторонних шаблонах - вы точно уменьшите число негативных возгласов.
Чек-лист проверки своего дополнения:
- Наличие иконки дополнения icon.jpg
- При удалении дополнения - он корректно удаляет за собой все что добавил в БД
- Если вы в коде используете вызов функций находящихся в других дополнениях или плагинах - используйте проверку. Этот доп (или плагин) у юзера может быть отключен
- Включить дебаг и проверить отсутствие notice и warning
- При работе на php версии 5.6 переключиться на версию 7.0 и 7.1 и проверить работу там. Включая дебаг
- Если дополнение использует свои скрипты - то убедиться что в консоли браузера все чисто
- Если дополнение подключает свои скрипты обязательно посмотреть работу и ошибки js в консоли при включенной настройке WP-Recall: минимизация скриптов
- Иногда стили (и скрипты) могут подключаться динамически. Проверить их верное подключение включив реколл кеширование и зайдя гостем
- Переключиться на сторонние ВП шаблоны и проверить соответствие дизайна/верстки. В комплект обязательно включите 2 последние ВП темы (twenty)
- Проверить отображение дизайна/верстки на других браузерах (EDGE, Chrome, Firefox)
- Проверить работу на мобильном устройстве
Комментарии и пояснения к пунктам:
1. Иконка в корне вашего дополнения отобразится в списке дополнений в админке. Это удобно для пользователя т.к. наглядно и запоминается
2. Создайте delete.php в корне дополнения - он будет срабатывать в момент удаления дополнения (Именно - при удалении дополнения. Не при деактивации). Разместите туда код удаления ваших таблиц и метаданных. Почистив за собой. Это правило хорошего тона.
3. Пункт 3 легко проигнорировать и забыть. Используйте для проверки такой способ - отключите дополнения, кроме вашего, и все плагины (кроме WP-Recall - конечно если вы пишете его доп) и пройдитесь по страницам где может быть видна работа вашего допа или плагина - если есть проблема - в логах ошибок сервера вы ее увидите
4. Понятное дело что нотисы никакого вреда не приносят - но чистый код покажет отсутствие подобных уведомлений
5. Я никогда не ловил проблем переключившись между 7.0 и 7.1 версией PHP, а вот с 5.6 на 7.0 - проблемы бывали. У пользователей могут быть любые из этих версий. Разрабатывать под версию ниже 5.6 - не имеет смысла. Их поддержка самими разработчиками закончилась.
6 и 7 - мониторинг консоли важное дело. Т.к. появись там js-ошибка вся динамика рухнет. А с 7 пунктом я часто имел проблемы когда в объединение шли уже сжатые js-библиотеки сторонних разработчиков. Такие скрипты можно из объединения исключить - подключив их не через реколл функцию rcl_enqueue_script() - описание здесь, а через ВП функцию wp_enqueue_script()
8. Бывает что мы подключаем стили (и скрипты) из php функции что выводит данные. Но если в общих настройках плагина будет включено кеширование и ваш код попадает в него - то он выполнится единожды, а потом вы не увидите подключение стилей. Будет отдан голый html без примененных к нему стилей. Проверяйте это поведение из под гостя, включив кеширование реколл.
9. Это важный пункт - выше я уже писал что каждый WordPress шаблон делается по своему и стили часто переопределяются текущим ВП шаблоном. Полностью конечно все не отловить. Но я например прогоняю через тем 10-ть точно. Все свои дочерние темы из каталога codeseller.ru - и через 3-4 стандартные вп шаблоны twenty**
10 и 11 - когда вы на других шаблонах все отловили что смогли, можно переключаться на тест в других браузерах. Я тестирую на последних версиях Хрома, Firefox и в EDGE браузере. Тестить в яндекс-браузере и в опере нет смысла. Все они работают на движке Chromium - так что на них не тратьте время (достаточно проверить в хроме). Ну а мобильное устройство - тестирование не в безымянных браузерах и не в отсталой opera-mini. Думаю достаточно хрома последней версии.
Если имеете продукты apple - у них свои браузеры.
Вот таким хитрым чек-листом сопровождается разработка нового дополнения для плагина WP-Recall. Но оно того стоит. Первое впечатление клиента - что все работает ка и должно и не перекосилось - это важно.
Если вам есть что дополнить или есть замечания и вопросы - комментарии открыты!
#WP-Recall #Разработка
Отличный мануал, действительно не пройдя по нему, могут быть проблемы.
Надо бы мне пару пунктов подтянуть)
Спасибо.
Написал так быстро потому что эти пункты вываливаются вечно из головы. Теперь есть где подсмотреть.
Конечно они - это всего лишь рекомендация - но следуя им мы во первых устраним мелкие промашки - а в глазах покупателей наших допов не промелькнет тень сомнения. Ну или эта тень будет полутенью ☁
Количество обращений за помощью это точно сократит
Надо бы записать выражение ?
Потом будет наш цитатник - разбогатеем ✈ ?
полезно и вполне оправдано, так можно защититься от многочисленных проблем в будущем
Это точно, да и первое впечатление с большей долей вероятности не будет испорчено (ох уж эти креативные ВП шаблоны). А это может стать плюсом к тому, что клиент превратится в постоянного.