Шорткод: Шорткоды в WordPress

05.05.2021 alexxlab

Содержание

Что такое шорткоды и как их использовать?

НовичкамПлагины

Dmitry26.06.2012

15 16 367 2 minutes read

Приветствую, уважаемые читатели wpnice. Сегодня поговорим о такой полезной функции в вашем блоге как шорткоды. А последующие две публикации я посвящу обзору двух самых популярных плагинов по использованию шорткодов. Первый плагин бесплатный — Shortcodes Ultimate. И еще один, платный — Styles with Shortcodes. Изначально хотел сразу приступить к обзору плагинов, но все таки, решил сначала сделать небольшую статью о том, что такое вообще шорткоды.

Что такое шорткоды [shortcodes]?

Говоря простым языком, это возможность превратить сложный PHP код для вывода какого то контента в код короткий, простой и понятный. Если вы знакомы с PHP, то легко сможете создавать шортсоды сами. По крайней мере, простые. В интернете можно найти немало туториалов на эту тему. Если же вы шарахаетесь от любого программирования как «черт от ладана», тогда можете использовать уже готовые плагины для быстрой вставки и использования шорткодов.

Что дают шорткоды?

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

Шоркоды стали использоваться в WordPress c версии 2.5. Собственно говоря, многие привычные плагины именно тем и занимаются, что выводят необходимый пользователю контент именно в виде шорткодов. Например, плагин — Video Sidebar Widgets или всем известная галерея — Nextgen Gallery. Я уж не говорю о таком популярном плагине как Visual Composer.

Визуально шорткоды выглядят как правило, в виде текста заключенного квадратные скобки — [ shortcode ]. Их легко запомнить и достаточно просто вставить в контент вашей страницы, записи или даже в текстовый виджет в сайдбаре.

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

Как их использовать?

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

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

Примеры использования щорткодов

Что такое шорткод?

Смотри выше по тексту

Больной пошел на поправку. Но не дошел.

Воспитанный мужчина не сделает замечания женщине, плохо несущей шпалу.

Граждане! Летайте самолетами Аэрофлота! Спешите! Их осталось совсем немного.

Кнопка

Большая кнопка

Поговорка 1
Поговорка 2
Поговорка 3

Tab 1 | Если вы, посмотрев в зеркало, никого там не увидели. Значит, вы неотразимы!

Tab 2 | Если гора не идет к Магомету, … Значит, травка была не очень……

Tab 3 | Если тебе лизнули зад, не расслабляйся — это смазка!

Разумеется, это далеко не все. В принципе, возможности шорткодов практически не ограничены и конечно не связаны только с текстом. Это может быть вывод слайдеров, видео и аудио и прочих элементов. Использование шорткодов будет особенно актуально в первую очередь, для владельцев бесплатных шаблонов, так как большинство современных премиум тем, уже имеют встроенные наборы шорткодов.

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

Читайте так же:
Shortcodes Ultimate — шорткоды для вашего блога
4 бесплатных WordPress плагина шорткодов

Шорткоды и виджеты — Онлайн-лейка – WordPress плагин для краудфандинга и сбора пожертвований в Сети

Новые шорткоды (в версии 3.6 и новее)

Карточка кампании/прогрессбар

Шорткод: [leyka_bar campaign_id=»id кампании»]

Как это выглядит:

Параметры, которые можно использовать в шорткоде:
— recurring="1" (значение «1» означает, что целевая сумма относится к рекуррентным пожертвованиям, в собранной сумме тоже учитываются только рекурренты; значение «0» считает все пожертвования)
— show_target_amount="1" (показывать или не показывать целевую сумму)
— show_collected_amount="1" (показывать или не показывать собранную сумму)
— button_text="Пожертововать" (меняет текст кнопки)
— show_image="1" (показывать или не показывать миниатюру)
— show_button="1" (показывать или не показывать кнопку)
— show_excerpt="1"(показывать или не показывать описание кампании)
— show_title="1"(показывать или не показывать заголовок кампании)
— show progressbar="1"(показывать или не показывать прогрессбар)

Параметры цветов:
— color_background="#FFFFFF" (цвет фона)
— color_fulfilled="#FFFFFF" (цвет заполненной части прогрессбара)
— color_unfulfilled="#FFFFFF" (цвет незаполненной части прогрессбара)
— color_button="#FFFFFF" (цвет кнопки)
— color_title="#FFFFFF" (цвет заголовка)
— color_target_amount"#FFFFFF" (цвет целевой суммы)
— color_collected_amount="#FFFFFF" (цвет собранной суммы)
— color_excerpt="#FFFFFF"(цвет текста описания кампании)

Шорткоды для списков

Список пожертвований: [leyka_donations_list campaign_id=»0″]

Как это выглядит:

История пожертвований
26 October 2022, 00:16	Ормсорморп	Регулярное	1 000 ₽
26 October 2022, 00:08	Явывыв	Регулярное	100 ₽
25 October 2022, 20:19	Andrei	Регулярное	500 ₽
25 October 2022, 19:15	test test	Регулярное	100 ₽
25 October 2022, 17:34	Иван Иванович	Регулярное	100 ₽

(при значении 1 дата отображается, при значении 0 нет)
— show_amount="1" (при значении 1 размер пожертвования отображается, при значении 0 нет)
— unstyled="true" (вся таблица заворачивается в стиль, у которого нет свойств, и вы можете сделать свой стиль силами дизайнеров и разработчиков)

Список комментариев к пожертвованиям: [leyka_donations_comments_list campaign_id=»0″ length=»5″]

Как это выглядит:

Параметры, которые можно использовать в шорткоде:
— campaign_id="10" (если в значении указать id кампании, то считается только число по конкретной кампании)
— length="5" (число записей в списке)
— show_name="1" (при значении 1 имя донора отображается, при значении 0 нет)
— show_date="1" (при значении 1 дата отображается, при значении 0 нет)
— unstyled="true" (вся таблица заворачивается в стиль, у которого нет свойств, и вы можете сделать свой стиль силами дизайнеров и разработчиков)

Простой список имён доноров: [leyka_supporters_list campaign_id=»0″ length=»25″]

Как это выглядит:

Нас поддержали

Ормсорморп, Явывыв, Andrei, Test test, Иван Иванович, Rwe sdadqwe, Test, 34242, Qwerty, Евгений Краснощеков, Aleksandr, Владислав Балабанович, Kjkhk hgjhgjh, Sddf fdgdfgdgdfg, Анна, 3342d, Weqwe, Vlad Vlad, Roman Patsev, Сергей Накоряков, Владимир Семенов, 2525, Леонид Глебов, Cdscds sdcscd, Петр Веремеев и ещё 294

Параметры, которые можно использовать в шорткоде:
— campaign_id="10" (если в значении указать id кампании, то считается только число по конкретной кампании)
— length="25" (число записей в списке)
— expandable="1" (список с кнопкой “ещё”, “ещё” кликабельно, при значении «0» «ещё» некликабельно)

Шорткоды для числовых данных без оформления

Количество доноров: [leyka_donors_count campaign_id=»0″ recurring=»0″]

Параметры, которые можно использовать в шорткоде:
— campaign_id="10" (если в значении указать id кампании, то считается только число по конкретной кампании)
— recurring="1" (при значении «0» считаются все доноры, при значении «1» только рекуррентные)

Пример: количество рекуррентных доноров по кампании с id=10: [leyka_donors_count campaign_id=»10″ recurring=»1″]

Количество пожертвований: [leyka_donations_count campaign_id=»0″ recurring=»0″]

Параметры, которые можно использовать в шорткоде:
— campaign_id="10" (если в значении указать id кампании, то считается только число по конкретной кампании)
— recurring="1" (при значении «0» считаются все пожертвования, при значении «1» только рекуррентные)

Пример: количествво активных рекуррентных подписок по всем кампаниям: [leyka_donations_count campaign_id=»0″ recurring=»1″]

Сумма пожертвований: [leyka_amount_collected campaign_id=»0″ recurring=»0″]

Параметры, которые можно использовать в шорткоде:
— campaign_id="10" (если в значении указать id кампании, то считается только число по конкретной кампании)
— recurring="1" (при значении «0» считается сумма всех пожертвований, при значении «1» только рекуррентных)

Пример: общий набранный объём активных рекуррентных подписок по всем кампаниям: [leyka_amount_collected campaign_id=»0″ recurring=»1″]

Старые шорткоды (в версиях до 3. 6)

параметры

id — означает ID кампании.

Если шорткод вставляется на странице кампании, ID можно не указывать; он определится сам.

Значение 0 или 1 и обозначают показывать (1) или не показывать(0) тот или иной элемент разметки.

[su_tabs vertical=»yes»][su_tab title=»Вывести градусник с кнопкой»] [leyka_scale show_button=1]

show_button — показывать кнопку

Как это выглядит на сайте:

[/su_tab] [su_tab title=»Вывести карточку кампании с набором элементов»]

[leyka_campaign_card show_title=1 show_thumb=1 show_excerpt=1 show_scale=1 show_button=1]

Как это выглядит на сайте:

[/su_tab]

[su_tab title=»Вывести платежную форму»] [leyka_payment_form]

Как это выглядит на сайте:

Банковская карта

Размер пожертвования 100 300 500 1000 или 5 10 20 50 или 100 300 500 1000 или 1 3 5 10 15 50 или 1 3 5 10 100 или 100 300 500 1000 или Валюта₽BYN₴$€сом

Ежемесячные пожертвования

Ваше имя

Публичная оферта о заключении договора пожертвования

Благотворительный фонд «Солнце», в лице #LEGAL_FACE_RP#,
предлагает гражданам сделать пожертвование на ниже приведенных условиях:

1. Общие положения
1.1. В соответствии с п. 2 ст. 437 Гражданского кодекса Российской Федерации данное предложение является публичной офертой (далее – Оферта).
1.2. В настоящей Оферте употребляются термины, имеющие следующее значение:
«Пожертвование» — «дарение вещи или права в общеполезных целях»;

«Жертвователь» — «граждане, делающие пожертвования»;
«Получатель пожертвования» — «Благотворительный фонд «Солнце»».

1.3. Оферта действует бессрочно с момента размещения ее на сайте Получателя пожертвования.
1.4. Получатель пожертвования вправе отменить Оферту в любое время путем удаления ее со страницы своего сайта в Интернете.
1.5. Недействительность одного или нескольких условий Оферты не влечет недействительность всех остальных условий Оферты.

2. Существенные условия договора пожертвования:
2.1. Пожертвование используется на содержание и ведение уставной деятельности Получателя пожертвования.
2.2. Сумма пожертвования определяется Жертвователем.

3.3. Совершение Жертвователем любого из действий, предусмотренных п. 3.2. Оферты, считается акцептом Оферты в соответствии с п. 3 ст. 438 Гражданского кодекса Российской Федерации.
3.4. Датой акцепта Оферты – датой заключения договора пожертвования является дата поступления пожертвования в виде денежных средств от Жертвователя на расчетный счет Получателя пожертвования.

4. Заключительные положения:

4.1. Совершая действия, предусмотренные настоящей Офертой, Жертвователь подтверждает, что ознакомлен с условиями Оферты, целями деятельности Получателя пожертвования, осознает значение своих действий и имеет полное право на их совершение, полностью и безоговорочно принимает условия настоящей Оферты.
4.2. Настоящая Оферта регулируется и толкуется в соответствии с действующим российском законодательством.

5. Подпись и реквизиты Получателя пожертвования

Благотворительный фонд «Солнце»

ОГРН: 1107799025949
ИНН/КПП: 7715089673/771501001
Адрес места нахождения: 122493, Москва, ул. Китай-город, 17, офис 4

Банковские реквизиты:
Номер банковского счёта: 40703810438040005125

Банк: ОАО «Сбербанк России» г. Москва
БИК банка: 044030920
Номер корреспондентского счёта банка: 30101810000000000920

Директор
Иван Петрович Сидоров

Я принимаю Договор оферты

Согласие на обработку персональных данных

Пользователь, оставляя заявку, оформляя подписку, комментарий, запрос на обратную связь, регистрируясь либо совершая иные действия, связанные с внесением своих персональных данных на интернет-сайте https://leyka. te-st.ru, принимает настоящее Согласие на обработку персональных данных (далее – Согласие), размещенное по адресу https://leyka.te-st.ru/personal-data-usage-terms/.

Принятием Согласия является подтверждение факта согласия Пользователя со всеми пунктами Согласия. Пользователь дает свое согласие организации «Благотворительный фонд «Солнце»», которой принадлежит сайт https://leyka.te-st.ru на обработку своих персональных данных со следующими условиями:

Пользователь дает согласие на обработку своих персональных данных, как без использования средств автоматизации, так и с их использованием.
Согласие дается на обработку следующих персональных данных (не являющимися специальными или биометрическими):
• фамилия, имя, отчество;
• адрес(а) электронной почты;
• иные данные, предоставляемые Пользователем.

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

1. Целью обработки персональных данных является предоставление полного доступа к функционалу сайта https://leyka. te-st.ru.

2. Основанием для сбора, обработки и хранения персональных данных являются:
• Ст. 23, 24 Конституции Российской Федерации;
• Ст. 2, 5, 6, 7, 9, 18–22 Федерального закона от 27.07.06 года №152-ФЗ «О персональных данных»;
• Ст. 18 Федерального закона от 13.03.06 года № 38-ФЗ «О рекламе»;
• Устав организации «Благотворительный фонд «Солнце»»;
• Политика обработки персональных данных.

3. В ходе обработки с персональными данными будут совершены следующие действия с персональными данными: сбор, запись, систематизация, накопление, хранение, уточнение (обновление, изменение), извлечение, использование, передача (распространение, предоставление, доступ), обезличивание, блокирование, удаление, уничтожение.

4. Передача персональных данных, скрытых для общего просмотра, третьим лицам не осуществляется, за исключением случаев, предусмотренных законодательством Российской Федерации.

5. Пользователь подтверждает, что указанные им персональные данные принадлежат лично ему.

6. Персональные данные хранятся и обрабатываются до момента ликвидации организации «Благотворительный фонд «Солнце»». Хранение персональных данных осуществляется согласно Федеральному закону №125-ФЗ «Об архивном деле в Российской Федерации» и иным нормативно правовым актам в области архивного дела и архивного хранения.

7. Пользователь согласен на получение информационных сообщений с сайта https://leyka.te-st.ru. Персональные данные обрабатываются до отписки Пользователя от получения информационных сообщений.

8. Согласие может быть отозвано Пользователем либо его законным представителем, путем направления Отзыва согласия на электронную почту – [email protected] с пометкой «Отзыв согласия на обработку персональных данных». В случае отзыва Пользователем согласия на обработку персональных данных организация «Благотворительный фонд «Солнце»» вправе продолжить обработку персональных данных без согласия Пользователя при наличии оснований, указанных в пунктах 2 — 11 части 1 статьи 6, части 2 статьи 10 и части 2 статьи 11 Федерального закона №152-ФЗ «О персональных данных» от 27. 07.2006 г. Удаление персональных данных влечет невозможность доступа к полной версии функционала сайта https://leyka.te-st.ru.

9. Настоящее Согласие является бессрочным, и действует все время до момента прекращения обработки персональных данных, указанных в п.7 и п.8 данного Согласия.

10. Место нахождения организации «Благотворительный фонд «Солнце»» в соответствии с учредительными документами: 122493, Москва, ул. Китай-город, 17, офис 4.

Соглашаюсь на обработку моих персональных данных

CloudPayments — это конструктор IT-решений для участников рынка электронной коммерции. Партнеры получают самый полный набор ключевых технических опций, позволяющих создать клиентоориентированную систему оплаты на сайте или в мобильном приложении. Партнеры имеют возможность принимать платежи не только в рублях, но и других валютах мира.

Банковская платёжная квитанция

Размер пожертвования 100 300 500 1000 или 5 10 20 50 или 100 300 500 1000 или 1 3 5 10 15 50 или 1 3 5 10 100 или 100 300 500 1000 или ₽

Ваше имя

Публичная оферта о заключении договора пожертвования

3. Порядок заключения договора пожертвования:
3.1. В соответствии с п. 3 ст. 434 Гражданского кодекса Российской Федерации договор пожертвования заключается в письменной форме путем акцепта Оферты Жертвователем.
3.2. Оферта может быть акцептована путем перечисления Жертвователем денежных средств в пользу Получателя пожертвования платежным поручением по реквизитам, указанным в разделе 5 Оферты, с указанием в строке «назначение платежа»: «пожертвование на содержание и ведение уставной деятельности», а также с использованием пластиковых карт, электронных платежных систем и других средств и систем, позволяющих Жертвователю перечислять Получателю пожертвования денежных средств.
3.3. Совершение Жертвователем любого из действий, предусмотренных п. 3.2. Оферты, считается акцептом Оферты в соответствии с п. 3 ст. 438 Гражданского кодекса Российской Федерации.
3.4. Датой акцепта Оферты – датой заключения договора пожертвования является дата поступления пожертвования в виде денежных средств от Жертвователя на расчетный счет Получателя пожертвования.

4. Заключительные положения:
4.1. Совершая действия, предусмотренные настоящей Офертой, Жертвователь подтверждает, что ознакомлен с условиями Оферты, целями деятельности Получателя пожертвования, осознает значение своих действий и имеет полное право на их совершение, полностью и безоговорочно принимает условия настоящей Оферты.
4.2. Настоящая Оферта регулируется и толкуется в соответствии с действующим российском законодательством.

5. Подпись и реквизиты Получателя пожертвования

Благотворительный фонд «Солнце»

ОГРН: 1107799025949
ИНН/КПП: 7715089673/771501001
Адрес места нахождения: 122493, Москва, ул. Китай-город, 17, офис 4

Банковские реквизиты:
Номер банковского счёта: 40703810438040005125
Банк: ОАО «Сбербанк России» г. Москва
БИК банка: 044030920
Номер корреспондентского счёта банка: 30101810000000000920

Директор
Иван Петрович Сидоров

Я принимаю Договор оферты

Согласие на обработку персональных данных

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

5. Пользователь подтверждает, что указанные им персональные данные принадлежат лично ему.

Соглашаюсь на обработку моих персональных данных

Платёж с помощью банковской квитанции позволяет вам сделать пожертвование через любой банк. Вы можете распечатать заполненную квитанцию и принести её в банк, чтобы выполнить платёж.

Платежи с помощью SMS

Чтобы пожертвовать, отправьте SMS «donate 500» на короткий номер 3443

Платежи с помощью SMS — доступный способ сбора пожертвований. Платёж списывается с мобильного счёта донора при отправке SMS на короткий 4-значный номер.

Банковская карта

[/su_tab]

[su_tab title=»Вывести список пожертвований по кампании»] [leyka_donors_list num=20 show_purpose=1 show_name=1 show_date=1]

если id=»all» — выводятся просто N последних пожертвований

Как это выглядит на сайте:

[/su_tab]

[su_tab title=»Вывести текст договора оферты»][leyka_service_terms_text]

Как это выглядит на сайте:

Публичная оферта о заключении договора пожертвования

5. Подпись и реквизиты Получателя пожертвования

Благотворительный фонд «Солнце»

ОГРН: 1107799025949
ИНН/КПП: 7715089673/771501001
Адрес места нахождения: 122493, Москва, ул. Китай-город, 17, офис 4

Директор
Иван Петрович Сидоров

[/su_tab]

[/su_tabs]

Виджеты

Плагин «Лейка» по умолчанию генерит три вида виджетов:

— список кампаний
— карточка кампании
— список пожертвований

Их настройки в целом эквивалентны настройкам шорткодов.

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

Если нужно выводить форму где-то ещё, нужно в настройках Лейки (во вкладке Разработчикам/Дополнительно) снять отметку с чекбокса «Загрузка скриптов и стилей плагина по необходимости».

Что такое шорткод в WordPress?

акции 33 Делиться Твитнуть Делиться Facebook-мессенджер WhatsApp Эл. адрес

Шорткоды в WordPress — это небольшие фрагменты кода, которые позволяют вам выполнять различные действия без особых усилий. Они были представлены в WordPress 2.5, и причина их введения заключалась в том, чтобы позволить людям выполнять код внутри сообщений, страниц и виджетов WordPress без непосредственного написания кода. Это позволяет вам встраивать файлы или создавать объекты, которые обычно требуют много кода, всего в одну строку. Например, шорткод для встраивания видео может выглядеть так:

 [видео]

Они также могут иметь атрибуты. Например, встроенный шорткод видео WordPress может иметь атрибут src:

В WordPress есть несколько встроенных функций. и видео. Другие могут быть добавлены плагинами с помощью Shortcode API.

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

[video]

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

Дополнительное чтение

Как использовать шорткоды в виджетах боковой панели WordPress
Как разрешить PHP в сообщениях и на страницах WordPress

Акции 33 Делиться Твитнуть Делиться Facebook-мессенджер WhatsApp Эл. адрес

О редакции

Редакция WPBeginner — это команда экспертов WordPress во главе с Сайедом Балхи. Мы создаем учебные пособия по WordPress с 2009 года, и WPBeginner стал крупнейшим в отрасли сайтом с бесплатными ресурсами WordPress.

Создайте свои собственные короткие коды | Hugo

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

Hugo также поставляется со встроенными короткими кодами для обычных случаев использования. (См. Управление контентом: короткие коды.)

Создание пользовательских коротких кодов

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

Местоположение файла

Чтобы создать шорткод, поместите HTML-шаблон в каталог layouts/shortcodes исходной организации. Внимательно относитесь к имени файла, так как имя шорткода будет отражать имя файла, но без .html расширение. Например, layouts/shortcodes/myshortcode.html будет вызываться либо с {{< myshortcode />}} , либо с {{% myshortcode /%}} в зависимости от типа выбранных вами параметров.

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

 {{}}

Обратите внимание на косую черту.

Порядок поиска шаблона шорткода

Шаблоны шорткода имеют простой порядок поиска:

/layouts/shortcodes/. html
/themes//layouts/shortcodes//layouts/shortcodes/<.

Позиционные и именованные параметры

Вы можете создавать шорткоды, используя следующие типы параметров:

Позиционные параметры
Именованные параметры
Позиционные или именованные параметры (т. е. «гибкие»)

В шорткодах с позиционными параметрами важен порядок параметров. Если шорткод имеет одно обязательное значение (например, шорткод youtube ниже), позиционные параметры работают очень хорошо и требуют меньше ввода от авторов контента.

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

Разрешение обоих типов параметров (например, «гибкий» шорткод) полезно для сложных макетов, где вы хотите установить значения по умолчанию, которые могут быть легко переопределены пользователями.

Доступ к параметрам

Доступ ко всем параметрам короткого кода можно получить с помощью метода .Get . Передаете ли вы ключ (то есть строку) или число методу .Get , зависит от того, обращаетесь ли вы к именованному или позиционному параметру соответственно.

Чтобы получить доступ к параметру по имени, используйте .Получить метод , за которым следует именованный параметр в виде строки в кавычках:

 {{ .Get "class" }}

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

 {{ .Get 0 }}

Для второй позиции вы должны просто использовать:

 {{ .Get 1 }}

с отлично подходит, когда вывод зависит от установленного параметра:

 {{ with . Get "class" }}{{ end }}

.Get также можно использовать для проверки наличия параметра. Это наиболее полезно, когда условие зависит от одного из значений или от обоих:

 {{ if or (.Get "title") (.Get "alt") }} alt="{{ with .Get "alt" }} {{ . }}{{ else }}{{ .Get "title" }}{{ end }}"{{ end }}

.Inner

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

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

 {{< innershortcode />}}

Любой шорткод, ссылающийся на . Внутренний должен быть закрытым или самозакрытым.

. Params

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

$.Params: это параметры, передаваемые непосредственно в объявление шорткода (например, идентификатор видео YouTube)
$.Page.Params: относится к параметрам страницы; «страница» в этом случае относится к файлу контента, в котором объявлен шорткод (например, к полю shortcode_color во вступительной части контента можно получить доступ через $.Page.Params.shortcode_color ).
$.Page.Site.Params: относится к глобальным переменным, определенным в файле конфигурации вашего сайта.

.IsNamedParams

Переменная .IsNamedParams проверяет, использует ли объявление шорткода именованные параметры, и возвращает логическое значение.

Например, вы можете создать шорткод image , который может принимать либо именованный параметр src , либо первый позиционный параметр, в зависимости от предпочтений автора контента. Допустим, image шорткод называется следующим образом:

 {{< image src="images/my-image.jpg" >}}

Затем вы можете включить следующее как часть шаблона шорткода:

 {{ if .IsNamedParams }}

{{ еще }}

{{ конец }}

См. пример шорткода Vimeo ниже для .IsNamedParams в действии.

Хотя вы можете создавать шаблоны коротких кодов, которые принимают как позиционные, так и именованные параметры, вы не может объявлять шорткоды в контенте со смесью типов параметров. Таким образом, шорткод, объявленный как {{< image src="images/my-image.jpg" "Это мой замещающий текст" >}} , вернет ошибку.

Вы также можете использовать переменную .Page для доступа ко всем обычным переменным страницы.

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

Проверка существования

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

Примеры пользовательских коротких кодов

Ниже приведены примеры различных типов коротких кодов, которые вы можете создать с помощью файлов шаблонов коротких кодов в ./layouts/шорткоды .

Одиночное слово Пример:

год

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

 {{< год >}}

/layouts/shortcodes/year.html

 {{ now.Format "2006" }}

Однопозиционный пример:

youtube

Встроенные видео — обычное дополнение к содержимому Markdown, которое может быстро стать неприглядным. Ниже приведен код, используемый встроенным шорткодом YouTube от Hugo: 9.0003

 {{< youtube 09jf3ow9jfw >}}

Загрузит шаблон по адресу /layouts/shortcodes/youtube.html :

/layouts/shortcodes/youtube.html

youtube-embed.html

 
    <тип iframe="текст/html"
       
        src="https://www.youtube.com/embed/09jf3ow9jfw"
        разрешить полноэкранную рамку = "0">

Одиночное имя Пример:

image

Допустим, вы хотите создать свой собственный шорткод img , а не использовать встроенный шорткод Hugo . Ваша цель — иметь возможность вызывать шорткод следующим образом в ваших файлах контента:

content-image.md

 {{< img src="/media/spf13.jpg" title="Steve Francia" >}}

Вы создали шорткод на /layouts/shortcodes/img.html , который загружает следующий шаблон шорткода:

/layouts/shortcodes/img.html

 

    {{ с .Get "ссылка" }}{{ end }}
        
    {{ if .Get "link" }}{{ end }}
    {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr") }}
    {{ if isset .Params "title" }}
         {{ .Get "title" }} {{ end }}
        {{ if or (.Get "caption") (.Get "attr") }}
        {{ .Получить "заголовок" }}
        {{ с .Get "attrlink" }}  }}"> {{ end }}
            {{ .Получить атрибут }}
        {{ if .Get "attrlink" }} {{ end }}
         {{ конец }}
    
    {{ конец }}

Будет отображаться как:

img-output.html

 <рисунок>
    
    
         Стив Франсиа

Один гибкий Пример:

vimeo

 {{< vimeo 49718712 >}}
{{<вимео >}}

Будет загружен шаблон, найденный по адресу /layouts/shortcodes/vimeo.html :

/layouts/shortcodes/vimeo.html

 {{ если .IsNamedParams }}

{{ еще }} <дел>

Будет отображаться как:

vimeo-iframes. html

 
  

<дел>

Парный пример:

Highlight

Следующее взято из Highlight , который является встроенным шорткодом, поставляемым с Hugo.

Highlight-Example.md

 {{< HTML Highlight >}}
  
     Этот HTML-код 
  
{{< /highlight >}}

Шаблон для шорткода highlight использует следующий код, который уже включен в Hugo:

 {{ .Get 0 | выделить .Внутренний }}

Визуализированный вывод блока кода примера HTML будет следующим: <body> Этот HTML-код </body> </html>

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

Следующий пример надуман, но демонстрирует концепцию. Предположим, у вас есть шорткод галереи , который ожидает один параметр с именем class :

layouts/shortcodes/gallery.html

 
  {{ .Внутренний }}

У вас также есть шорткод img с одним именованным параметром src , который вы хотите вызывать внутри галереи и других шорткодов, чтобы родитель определял контекст каждого img :

layouts/shortcodes/img.html

 {{- $src := .Get "src" -}}
{{- с .Parent -}}
  
{{- еще -}}
  
{{- конец -}}

Затем вы можете вызвать свой шорткод в своем контенте следующим образом:

 {{< галерея >}}
  {{< img src="/images/one.jpg" >}}
  {{< img src="/images/two.jpg" >}}
{{< /галерея >}}
{{< img src="/images/three. jpg" >}}

Это выведет следующий HTML. Обратите внимание, как первые два шорткода img наследуют значение class content-gallery , установленное с вызовом родительской галереи , тогда как третьи img использует только src :

Обработка ошибок в шорткодах

Используйте функцию шаблона errorf и переменную .Position для получения полезных сообщений об ошибках в шорткодах:

 {{ with .Get "name" }}
{{ еще }}
{{ errorf "отсутствует значение для параметра 'имя': %s" .Position }}
{{ конец }}

Если вышеуказанное не удается, вы увидите ОШИБКА журнал, аналогичный приведенному ниже:

 ОШИБКА 2018/11/07 10:05:55 отсутствует значение для имени параметра: "/Users/bep/dev/go/gohugoio/hugo/docs/content/en/variables/ короткие коды. md:32:1"

Дополнительные примеры коротких кодов

Дополнительные примеры коротких кодов можно найти в каталоге коротких кодов для spf13.com и в каталоге коротких кодов для документов Hugo.

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

Начиная с версии Hugo 0.52, вы можете встраивать свои шорткоды, например. где вы их используете в файле содержимого. Это может быть полезно для сценариев, которые вам нужны только в одном месте.

Эта функция отключена по умолчанию, но ее можно включить в конфигурации вашего сайта:

config.

 enableInlineShortcodes: правда

 enableInlineShortcodes = истина

 {
   "enableInlineShortcodes": правда
}

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

Шорткод: Шорткоды в WordPress

Что такое шорткоды и как их использовать?

Что такое шорткоды [shortcodes]?

Что дают шорткоды?

Как их использовать?

Примеры использования щорткодов

Что такое шорткод?

Похожие

Шорткоды и виджеты — Онлайн-лейка – WordPress плагин для краудфандинга и сбора пожертвований в Сети

Новые шорткоды (в версии 3.6 и новее)

Карточка кампании/прогрессбар

Шорткод: [leyka_bar campaign_id=»id кампании»]

Шорткоды для списков

Шорткоды для числовых данных без оформления

Что такое шорткод в WordPress?

Дополнительное чтение

О редакции

Создайте свои собственные короткие коды | Hugo

Создание пользовательских коротких кодов

Местоположение файла

Порядок поиска шаблона шорткода

Позиционные и именованные параметры

Доступ к параметрам

Проверка существования

Примеры пользовательских коротких кодов

Одиночное слово Пример:

Однопозиционный пример:

Одиночное имя Пример:

{{ .Get "title" }}

Стив Франсиа

Один гибкий Пример:

Парный пример:

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

Обработка ошибок в шорткодах

Дополнительные примеры коротких кодов

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

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