Выделение поисковых запросов v1.8.3

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

Этот плагин легкий и не имеет опций. Все началось с очень простого слияния "Как выделить поисковые запросы с помощью jQuery" - хака темы от Тая Карисон и Search Hilite от Райана Борена. С тех пор он развивался благодаря множеству оптимизаций, поддержке HTML5 и bbPress.

Начиная с версии 1.6 он больше не зависит от библиотеки jQuery.

Функции

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

- Подсветка без учета символов и регистра (мягкая)

- Совместимость с BuddyPress / bbPress: выбор при поиске по форуму.

- Совместимость с кэшированием (WP Super Cache)

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

Что оно делает?

Этот плагин с низким уровнем воздействия находит все поисковые запросы на странице результатов поиска внутри каждого сообщения и выделяет их тегом <mark class="hilite term-N"> ... </mark>.

Обратите внимание, что N - это число, начинающееся с 0 для первого термина, используемого в поисковой фразе, и увеличивающееся на 1 для каждого дополнительного использованного термина. Любая часть поисковой фразы, заключенная в кавычки, считается одним термином.

Что НЕ делает?

Для выделения не установлены правила стиля CSS. Вы можете использовать любой стиль, который пожелаете, но чтобы сделать выделение видимым в браузерах, которые не поддерживают HTML5, таких как Internet Explorer 8 или старше, вам обязательно необходимо определить хотя бы одно правило.

Современные браузеры HTML5 по умолчанию используют свой собственный стиль выделения, который обычно представляет собой фон в виде желтого маркера.

Итак, что мне нужно сделать?

В большинстве случаев он должен просто работать. Но вы можете сделать две вещи, чтобы обеспечить соответствие браузеру и теме:

- Определите правила CSS: параметры конфигурации и предопределенный стиль выделения отсутствуют. Вы можете совершенно свободно определять любые правила оформления CSS в основной таблице стилей вашей темы (style.css) или на вкладке "Пользовательский CSS" в настройщике тем WordPress.

Базовые инструкции и примеры CSS вы можете найти в разделе часто задаваемых вопросов.

- Проверьте свою тему: в большинстве современных тем (включая собственную тему WP по умолчанию) содержимое сообщений и страниц отображается внутри div с информацией о классе. Это означает, что будут выделены поисковые запросы, найденные в содержимом публикации и страницы, но не похожие термины, которые случайно отображаются в заголовке, боковой панели или нижнем колонтитуле страницы.

Если ваша текущая тема не использует класс hentry (пока), этот плагин будет искать содержимое идентификаторов, основную и, наконец, оболочку, но если ни один из них не найден, он не будет работать для вас "из коробки". См. последний из часто задаваемых вопросов, чтобы узнать, как заставить его работать.

Доступные хуки и фильтры

- hlst_query_vars - Массив запроса запроса WordPress, который идентифицирует как поисковый запрос. Должен вернуть массив. Дефолт: ["search_terms","bbp_search"] (поиск WordPress и bbPress)

- hlst_input_get_args - Массив переменных GET, которые плагин будет идентифицировать как поисковый запрос. Должен вернуть массив. По умолчанию: ["hilite"] (для выделения по клику)

- hlst_selectors - Массив возможных идентификаторов элементов HTML DOM, которые будет использовать скрипт. Первый жизнеспособный идентификатор, элементы которого он найдет, будет сканироваться на наличие условий поиска, которые можно отметить, остальные игнорируются. Так что порядок здесь важен! Начните с элемента, ближайшего к элементу, но все еще содержащего весь заголовок, отрывок или контент публикации/страницы.

- hlst_events - Массив прослушивателей событий DOM, за которыми будет следить встроенный скрипт. По умолчанию: ["DOMContentLoaded","post-load"] (при готовности документа, для Jetpack Infinite Scroll и других).

- hlst_inline_script - встроенный скрипт, который будет добавлен в файл скрипта плагина. Может использоваться для добавления или изменения встроенного скрипта. Должен вернуть строку.

Известные проблемы и разработки

- Если ваша тема не переносит основной раздел контента ваших страниц в div с тегами статей класса "hentry" или HTML5, этот плагин может не работать для вас "из коробки". Однако вы можете заставить это работать. Подробности смотрите в последнем разделе часто задаваемых вопросов.

- Джош указал на конфликт с плагином кнопок ShareThis. С тех пор этот плагин был полностью переписан, поэтому, пожалуйста, дайте мне знать, если проблема все еще существует. Спасибо!

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