Шорткоды

wp-shortcode

Обзор

Для того, чтобы обеспечить дополнительный уровень безопасности для вашего сайта, WordPress не позволит вам добавить PHP код к записи. Это оберегает пользователей от случайного запуска кода, который вызывает сбой в работе сайта. Однако, Вы можете позволить пользователям внедрять динамический контент, который требует использования PHP для выполнения задачи. Для этого вы должны ввести шорткоды (shortcodes).

Шорткод — аналог макроса, где одна команда может расширяться для выполнения ряда задач. Короче говоря, шорткод действует как «ярлык», который может быть использован для представления фото галереи, списка записей, контактной формы или других частей динамической функциональности. WordPress поддерживает шорткоды, начиная с версии 2.5.

Вот простой пример шорткода для добавления галереи в запись или страницу:

[ gallery ] (пробелы по бокам не нужны!)

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

[ gallery id="1" size="medium" ]

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

Почему шорткоды?

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

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

Параметры

Как минимум, использование Shortcode API включает в себя регистрацию как шорткода, так и callback-функции с помощью add_shortcode(). Это как если бы вы позволили конечному пользователю использовать PHP функции в пределах контента своей записи, но в гораздо более безопасной, более защищенной манере.

Колбек-функция, используемая в add_shortcode() может иметь до трех параметров:

  • $atts, ассоциативный массив атрибутов, или пустая строка, если атрибуты не заданы
  • $content, вложенный контент (если шорткод обернут вокруг какого-то контента)
  • $tag, текущий тег шорткода, полезно для общих колбек-функций

Шорткоды — лучшие практики

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

  • Возвращайте вывод, не выводите его (return вместо echo). Шорткоды, по существу, фильтры, так что отправка вывода или изменение глобальных переменных может создать ошибки, которые трудно отследить.
  • Добавляйте префикс к именам шорткода, чтобы избежать противоречий с другими плагинами.
  • Обрабатывайте ввод данных и экранируйте вывод.
  • Предоставьте пользователям четкую документацию для всех параметров шорткода.
Навигация по разделам:

Оставить комментарий

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