WordPress: шорткоды

· WordPress, Разработка плагинов и Шорткоды · 1 мин чтения

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

Шорткоды — это макросы, которые могут быть использованы для вывода какого-либо динамичного контента. Например, создания галереи из картинок приложенных к посту или отображения видео.

Почему стоит использовать шорткоды?

Шорткоды — это простой способ сделать контент чистым и семантически простым для конечного пользователя, в тоже время разрешая разработчикам внедрять собственные динамичные элементы.

Плюсы:

  • Не нужно использовать HTML внутри текста поста — это означает, что стили и прочее могут быть добавлены позже.
  • Могут принимать параметры, позволяя пользователям управлять действием шорткода.

Встроенные шорткоды

Шорткоды обозначаются следующим форматом:

[vash-shortcode]

vash-shortcode — это название шорткода. Его нужно обязательно обертывать в квадратные скобки — [].

По умолчанию, в WordPress предусмотрены следующие шорткоды:

  • caption – шорткод, позволяющий выводить цитаты
  • gallery — шорткод, позволяющий выводить фото галереи
  • audio — шорткод, позволяющий выводить и проигрывать аудиофайлы
  • video — шорткод, позволяющий выводить и проигрывать видео
  • playlist — шорткод, позволяющий выводить видео или аудио файлы списком
  • embed — шорткод, позволяющий обертывать элементы

Лучшие практики шорткодов

Лучшие практики при разработке шорткодов в темах или плагине:

  • Всегда возвращайте! Шорткоды — это фильтры, поэтому если вы ничего не возвращаете, то это может создать массу багов.
  • Используйте префикс для собственных шорткодов, чтобы избежать конфликта с другими.
  • Всегда чистите вводимую и выводимую информацию.
  • Предоставляйте пользователю полную документацию по использованию, со всеми параметрами и атрибутами.

Дополнительные источники