Огромный сборник статей от WPTec для начинающих

Мнение

Авторам плагинов WordPress следует избегать путаницы при именовании блоков

4 мая команда разработчиков StudioPress внесла небольшое, но существенное изменение для пользователей в свой плагин Atomic Blocks (теперь переименованный в Genesis Blocks). Он удалил брендинг «AB» из заголовков блоков. Это небольшое обновление изменило заголовки блоков, такие как AB Accordion и AB Button на Accordion и Button соответственно. На первый взгляд, это изменение, вероятно, не имело большого значения для разработчиков проекта. Однако по крайней мере для одного огромного пользователя это создало рабочую нагрузку.

Если пользователи неукоснительно следовали кодам GitHub, они бы пропустили это обновление. Вместе с несколькими другими изменениями кода для, казалось бы, несвязанного тикета, команда оставила сообщение, которое гласило: «Удалите ненужные буквы AB из заголовков блоков».

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

Проблема заключалась в том, что в журнале изменений не было сообщения об этом. У пользователей не было никаких указаний на то, что блоки из плагина переименовываются. Как правило, это не будет иметь большого значения, поскольку команда разработчиков просто удалила префикс «AB» из неизменившихся заголовков. Однако что происходит, когда заголовок одного из этих блоков совпадает с заголовком основного блока?

Это была проблема, с которой столкнулся Маркус Тибесар. Блок AB Button внезапно стал блоком Button. Думая, что он использует основную кнопку WordPress, он широко использовал ее на своем сайте. Добавьте к этому его решение отказаться от плагина после того, как StudioPress переименовала свой плагин в Genesis Blocks, и очистить это стало чем-то вроде катастрофы.

«Я использую блок кнопок уже несколько месяцев, но обнаружил, что на самом деле использую блок кнопок Atomic Blocks!» написал Tibesar в комментарии к сообщению о ребрендинге Atomic Blocks.

Теоретически ему следовало обновлять только те устаревшие блоки из атомных блоков, которые он сознательно использовал. Но он застрял с блоками, которые он неосознанно добавил к своим сообщениям и страницам не по своей вине.

Этот конкретный сценарий был усугублен тем, что WordPress 5.4, выпущенный 31 марта, представил новый блок кнопок (множественное число). Старый блок Button был удален из обычного модуля вставки. Хотя не все проблемы с именованием блоков настолько запутаны, все же возникает вопрос: как авторы плагинов могут избежать подобных проблем с пользовательским интерфейсом?

Легко возложить вину на StudioPress – и команда, возможно, могла бы использовать выговор за то, что не поняла, что изменение произошло. Тем не менее, это приводит к нескольким моментам, которые необходимо выяснить большему сообществу WordPress. Во-первых, нужно ли авторам плагинов использовать согласованную схему именования с префиксом для своих блоков. Во-вторых, что WordPress может сделать для устранения проблем.

Префикс “Все вещи”

Это обычная поговорка в мире разработки WordPress, верно ? Рекомендации по использованию префиксов и пространств имен обычно применяются к фактическому коду, в котором возникают конфликты. Однако бывают случаи, когда использование префикса общедоступного текста оправдано.

И в те времена плагины используют общее пространство.

Редактор блоков – одно из таких общих пространств. Поскольку в каталог попадает все больше и больше подключаемых модулей блоков, настало время, чтобы их авторы рассмотрели, как схемы именования блоков влияют на конечных пользователей. Проблема, конечно, не ограничивается блоками Atomic / Genesis. Это постоянная тенденция с несколькими плагинами библиотеки блоков. Некоторые из них работают лучше, чем другие, но каждый раз, когда пользователь устанавливает такой плагин, возникает проблема.

Самый простой способ для авторов плагинов – просто поставить перед всеми настраиваемыми блоками брендинг своей компании (например, кнопку AB). С другой стороны, не каждый блок имеет общий заголовок с одним из основных блоков. Например, блоку с названием «Карусель продуктов» может не потребоваться дальнейшее выделение себя среди других блоков. Маловероятно, что конечные пользователи используют несколько плагинов электронной коммерции с блоками с одинаковым названием.

«Все, повторять все, должны иметь префикс», – сказал Тибесар. «Префиксы устраняют любую путаницу относительно того, выбираем ли мы, пользователи, основной блок или сторонний блок. Самые популярные плагины появляются вверху списка, и непонятно, откуда они пришли, когда префиксы отсутствуют ».

По крайней мере, сторонние блоки должны иметь префикс, если их заголовки соответствуют одному из основных блоков. Например, конечные пользователи не должны видеть два разных блока Cover в устройстве для вставки блоков. Вместо этого они должны увидеть основную обложку и второй блок с уникальным названием. Префикс – это простой способ сделать это. Но я мог бы жить с чем угодно, что не вызывает путаницы у пользователей.

Обнаружение случаев использования блока

В конце 2019 года команда Гутенберга выпустила первый прототип потенциальной области управления блоками для администратора WordPress. На экране «Управление блоками» из прототипа была показана область, которая позволяла пользователям управлять каждым блоком на своем сайте. Одним из наиболее важных фрагментов информации на этом экране был счетчик «Экземпляров», который отображал количество раз, когда блок использовался. Кроме того, он связан с экраном с каждым постом, в котором есть определенный блок.

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

Он сказал, что абсолютно приветствует эту функцию в WordPress. «Новые пользователи испытывают искушение загружать миллионы плагинов для блоков, чтобы о них позже забыть. Кроме того, сопровождающие будут использовать этот инструмент при очистке поврежденных сайтов. Простая возможность увидеть,  какие  блоки и где использовались  , позволит издателям набрать количество плагинов блоков, установленных на их сайтах, особенно при появлении новых плагинов и технологий ».

Поскольку этой функции еще нет в ядре, ему пришлось обратиться к плагину Find My Blocks , который помог ему определить 22 сообщения и страницы, на которых он по незнанию использовал блок кнопок из Atomic / Genesis Blocks. В долгосрочной перспективе это то, что нужно решать непосредственно в WordPress. Вряд ли это будет последний раз, когда пользователю нужно убираться в доме и избавляться от старых блоков.

Рекомендуем прочитать
Мнение

Плагин Delete Me для WordPress помогает владельцам веб-сайтов предоставить право на забвение GDPR

Мнение

Команда Gutenberg наращивает юзабилити-тестирование в WordCamp US

Мнение

Плагин распространителя теперь в бета-версии: новое решение для синдикации контента WordPress от 10up

Мнение

Gutenberg 1.8 добавляет большую расширяемость для разработчиков плагинов

Подпишитесь на рассылку
и будьте в курсе новостей Wordpress

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *