Вивчаємо теги шаблонів: частина восьма

У минулій статті з нашої серії ми пройшлися по 7 порції тегів шаблонів WordPress. Сьогодні ж ми раді представити останню порцію тегів шаблонів. Ми розглянемо теги, пов’язані з закладками і інші теги шаблонів.

Попередження щодо закладок: з виходом WordPress версії 3.5 «закладки» за замовчуванням приховані в консолі адміністратора. Щоб працювати з закладками, потрібно встановити плагін Link Manager.

Отримуємо і виводимо список закладок: wp_list_bookmarks()

Тег отримує і виводить список закладок; стара функція WordPress.

Параметри

Цей тег шаблону приймає один параметр:

• $args (array, необов’язковий): Масив включає в себе наступні аргументи:

— ‘orderby‘ (string): Як сортувати закладки: ‘name‘, ‘link_id‘, ‘url‘, ‘target‘, ‘description‘, ‘owner‘ (користувач, який додав закладку), ‘rating‘, ‘updated‘ (дата оновлення), ‘rel‘ (XFN закладки взаємин), ‘notes‘, ‘rss‘, ‘length‘ (довжина назви закладки), ‘rand‘ (випадково). За замовчуванням: ‘name‘;
— ‘order‘ (рядок запиту): Сортувати за зростанням (‘ASC‘) або за спаданням (‘DESC‘). За замовчуванням: ‘ASC‘;
— ‘limit‘ (integer): кількість елементів, які будуть відображені. За замовчуванням: -1, або всі закладки;
— ‘category‘ (string): список розділених комами ID категорій, з яких беруться елементи. За замовчуванням: », чи всі категорії;
— ‘exclude_category‘ (string): ID категорій закладок, які потрібно виключити. За замовчуванням: »;
— ‘category_name‘ (string): Назва категорії, з якої треба виводити закладки (переписує ‘category‘). За замовчуванням: »;
— ‘hide_invisible‘ (integer): Показувати невидимі посилання. За замовчуванням: 1;
— ‘show_updated‘ (integer): Показувати інформацію про дату останньої зміни. За замовчуванням: 0;
— ‘echo‘ (integer): вивести на екран (1) або повернути закладки (0). За замовчуванням: 1;
— ‘categorize‘ (integer): Групувати закладки за категоріями (1) або ні (0). За замовчуванням: 1;
— ‘title_li‘ (string): Обертає результат в тег

і виводить заголовок перед списком закладок. За замовчуванням: ‘Bookmarks‘;
— ‘title_before‘ (string): HTML-код, який потрібно додати перед кожним заголовком. За замовчуванням: ‘

‘;
— ‘title_after‘ (string): HTML-код, який потрібно додати після кожного заголовка. За замовчуванням: ‘

‘;
— ‘class‘ (string): CSS-класи, які будуть вказані в кожній категорії. За замовчуванням: ‘linkcat‘;
— ‘category_before‘ (string): HTML-код, який потрібно додати перед кожною категорією. За замовчуванням: ‘

‘;
— ‘category_after‘ (string): HTML-код, який потрібно додати після кожної категорії. За замовчуванням: ‘

‘;
— ‘category_orderby‘ (string): Як сортувати категорії: ‘name‘, ‘id‘, ‘slug‘, і ‘count‘. За замовчуванням: ‘name‘;
— ‘category_order‘ (string): Сортувати категорії за зростанням (‘ASC‘) або за спаданням (‘DESC‘). За замовчуванням: ‘ASC‘.

Застосування

‘rand’,
// Виводимо тільки 5 закладок.
‘limit’ => 5,
// Отримуємо закладки з певної категорії.
‘category_name’ => ‘Friends’,
// Нічого не виводимо.
‘echo’ => 0,
// Використання довільних класів CSS.
‘class’ => ‘friends-bookmark-list’
);
$bookmarks_list = wp_list_bookmarks( $args );
?>

Отримуємо масив закладок: get_bookmarks()

Тег повертає масив ваших закладок з WordPress.

Параметри

Тег шаблону приймає один параметр:

• $args (array, необов’язковий): Масив включає в себе наступні аргументи:

— ‘orderby‘ (string): Як сортувати закладки: ‘name‘, ‘ID‘, ‘title‘, ‘date‘ і т. д. За замовчуванням: ‘name‘;
— ‘order‘ (string): Сортувати за зростанням (‘ASC‘) або за спаданням (‘DESC‘). За замовчуванням: ‘ASC‘;
— ‘limit‘ (integer): кількість елементів, які будуть відображені. За замовчуванням: -1, або всі закладки;
— ‘category‘ (string): список розділених комами ID категорій, з яких беруться елементи. За замовчуванням: »;
— ‘category_name‘ (string): Назва категорії, з якої потрібно виводити закладки. За замовчуванням: »;
— ‘hide_invisible‘ (integer або bool): Показувати посилання, зазначені як «невидимі». За замовчуванням: 1|TRUE;
— ‘show_updated‘ (integer або bool): Показувати інформацію про дату останньої зміни. За замовчуванням: 0|FALSE;
— ‘include‘ (string): ID категорій закладок, які потрібно включити в список. За замовчуванням: »;
— ‘exclude‘ (string): ID категорій закладок, які потрібно виключити. За замовчуванням: ».

Застосування

‘title’,
‘order’ => ‘ASC’,
‘limit’ => 15,
‘hide_invisible’ => false,
‘exclude’ => ‘12,16,23’
);
$bookmarks_array = get_bookmarks( $args );
?>

Отримуємо дані закладок: get_bookmark()

Тег отримує всі дані про зазначену закладці.

Параметри

Цей тег шаблону приймає три параметри:

• $bookmark (змішаний тип, обов’язковий): ID закладки або об’єкта. За замовчуванням: NULL;
• $output (string, необов’язковий): Тип значення, що повертається: OBJECT, ARRAY_N або ARRAY_A. За замовчуванням: OBJECT;
• $filter (string, необов’язковий): Екранувати чи видачу. Якщо ви хочете екранувати результат, то потрібно встановити значення ‘display‘. За замовчуванням: ‘raw‘.

Застосування

Отримуємо дані з полів окремої закладки: get_bookmark_field()

Тег дозволяє витягувати дані з полів певних закладок.

Параметри

Цей тег шаблону приймає три параметри:

• $field (integer, обов’язкове): Назва поля. За замовчуванням: NULL;
• $bookmark (integer, обов’язкове): ID закладки або об’єкта. За замовчуванням: NULL;
• $context (string, необов’язковий): Як фільтрувати значення поля: ‘raw‘, ‘edit‘, ‘attribute‘, ‘js‘, ‘db‘ або ‘display‘. За замовчуванням: ‘display‘.

Застосування

Отримуємо і виводимо на посилання «Редагувати закладку»: get_edit_bookmark_link() і edit_bookmark_link()

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

Параметри

get_edit_bookmark_link() приймає один параметр:

• $bookmark_id (integer, обов’язковий): ID закладки. За замовчуванням: 0.

edit_bookmark_link() приймає чотири параметри:

• $text (string, необов’язковий): Текст посилання. За замовчуванням: ‘Редагувати’;
• $before (string, необов’язковий): Текст або HTML-код, який буде показаний до основного висновку. За замовчуванням: »;
• $after (string, необов’язковий): Текст або HTML-код, який буде показаний після основного висновку. За замовчуванням: »;
• $bookmark_id (integer, обов’язкове): ID закладки. За замовчуванням: 0.

Застосування

Отримуємо і виводимо інформацію про вашому сайті: get_bloginfo() і bloginfo()

Популярні теги, які повертають і виводять загальну інформацію про вашому сайті.

Параметри

get_ bloginfo() приймає два параметри:

• $show (string, необов’язковий): Інформація, яку можна отримувати. Можна використовувати одне із наступних значень:

— ‘url‘ (string): URL головної сторінки;
— ‘wpurl‘ (string): URL до встановленого WordPress;
— ‘description‘ (string): опис сайту;
— ‘rdf_url‘ (string): URL розсилки RDF/RSS 1.0;
— ‘rss_url‘ (string): URL розсилки RSS 0.92;
— ‘rss2_url‘ (string): URL розсилки RSS 2.0;
— ‘atom_url‘ (string): URL розсилки Atom;
— ‘comments_rss2_url‘ (string): URL розсилки RSS 2.0 для коментарів;
— ‘comments_atom_url‘ (string): URL розсилки Atom для коментарів;
— ‘pingback_url‘ (string): URL XML—RPC файлу Pingback;
— ‘stylesheet_url‘ (string): URL основного CSS-файл шаблону;
— ‘stylesheet_directory‘ (string): URL директорії з основним CSS-файл шаблону;
— ‘template_directory‘ або ‘template_url‘ (string): URL директорії активної теми оформлення;
— ‘admin_email‘ (string): email-адресу, введений при установці WordPress;
— ‘charset‘ (string): кодування сайту;
— ‘html_type‘ (string): Тип вмісту HTML сторінки вашого WordPress;
— ‘version‘ (string): версія WordPress;
— ‘language‘ (string): мова системи WordPress;
— ‘text_direction‘ (string): напрямок написання в мові (ltr – правосторонній, rtr – лівосторонній);
— ‘name‘ (string): назва сайту. За замовчуванням: ‘name‘.

• $filter (string, необов’язковий): Визначає фільтр, через який повинні проходити значення, що повертаються. За замовчуванням: ‘raw‘.

bloginfo() приймає один параметр:

• $show (string, необов’язковий): Ті ж дані, що представлені вище. За замовчуванням: ‘blogname‘.

Застосування

Повертаємо й відображаємо класи : get_body_class() і body_class()

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

Параметри

Обидва тега шаблонів приймають лише один параметр:

• $class (string або array, необов’язковий): Додаткові CSS-класи, які потрібно додати. За замовчуванням: ».

Застосування

Отримуємо і виводимо навігаційне меню: wp_nav_menu()

Тег повертає або виводить навігаційне меню. Цей тег шаблону застосовується у всіх темах WordPress, починаючи з 2013 року.

Параметри

Цей тег шаблону приймає один параметр:

• $args (array, необов’язковий): Масив включає в себе наступні аргументи:

— ‘menu‘ (string): ID, slug або назва меню. За замовчуванням: »;
— ‘menu_class‘ (string): CSS-клас UL-елементів меню. За замовчуванням: ‘menu‘;
— ‘menu_id‘ (string): ID UL-елемента меню. За замовчуванням: menu slug, incremented;
— ‘container‘ (string): Обертати елементи UL, і в які теги. За замовчуванням: DIV;
— ‘container_class‘ (string): CSS-клас контейнера. За замовчуванням: ‘menu-{menu slug}-container‘;
— ‘container_id‘ (string): ID-елемента оболонки. За замовчуванням: »;
— ‘fallback_cb‘ (функція callback або bool): Назва callback-функції, яка буде запускатися у разі відсутності меню. Встановіть значення false, щоб відключити функцію. За замовчуванням: ‘wp_page_menu‘;
— ‘before‘ (string): Текст перед посиланням. За замовчуванням: »;
— ‘after‘ (string): Текст після посилання. За замовчуванням: »;
— ‘link_before‘ (string): Текст перед анкором кожній посилання в меню. За замовчуванням: »;
— ‘link_after‘ (рядок запиту): Текст після анкора кожній посилання в меню. За замовчуванням: »;
— ‘echo‘ (bool): Виводити на екран або повернути для обробки. За замовчуванням: TRUE;
— ‘depth‘ (integer): Скільки рівнів в ієрархії відображати. За замовчуванням: 0, або все;
— ‘walker‘ (object): стан довільного класу walker. За замовчуванням: »;
— ‘theme_location‘ (string): Розташування теми оформлення, яку потрібно використовувати. Параметр повинен бути зареєстрований в register_nav_menu(), щоб його могли бачити і обирати користувачі. За замовчуванням: »;
— ‘items_wrap‘ (string): Як повинні бути оформлені пункти списку. За промовчанням:

%3$s

.

Застосування

‘primary-nav’,
‘link_before’ => «,
‘theme_location’ => ‘primary’
);
wp_nav_menu( $args );
?>

Отримуємо і виводимо заголовки сторінок: wp_title()

Тег повертає або виводить заголовки сторінок.

Параметри

Цей тег шаблону приймає три параметри:

• $sep (string, необов’язковий): Текст, який буде використовуватися в якості розділювача. За замовчуванням: ‘«‘;
• $echo (bool, необов’язковий): Вивести на екран (TRUE) або повернути для обробки (FALSE). За замовчуванням: TRUE;
• $seplocation (string, необов’язковий): Розташування роздільника та напрям «хлібних крихт». Встановіть значення ‘right‘, якщо хочете показувати посилання в зворотному порядку. За замовчуванням: ».

Застосування

Отримуємо і виводимо URL головної сторінки: get_home_url() і home_url()

Теги повертають URL головної сторінки.

Параметри

get_home_url() приймає три параметри:

• $blog_id (integer, необов’язковий): ID блогу. За замовчуванням: NULL;
• $path (string, необов’язковий): Довільний шлях, який буде використовуватися в якості URL. За замовчуванням: »;
• $scheme (string, необов’язковий): Схема, яка задає контекст URL домашньої сторінки (‘http‘, ‘https‘, або ‘relative‘). За замовчуванням: NULL.

home_url() приймає два параметри:

• $path (string, необов’язковий): Довільний шлях, який буде використовуватися в якості URL. За замовчуванням: »;
• $scheme (string, необов’язковий): Схема, яка задає контекст URL домашньої сторінки (‘http‘, ‘https‘, або ‘relative‘). За замовчуванням: NULL.

Примітка: get_home_url() отримує URL домашньої сторінки певного блогу, а home_url() отримує URL поточного сайту. Запам’ятайте: ні одна з цих функцій не виводить результат.

Застосування

Отримуємо і виводимо URL сайту: get_site_url() і site_url()

Теги отримують і виводять «URL сайту» — адресу, за якою встановлено WordPress.

Параметри

get_site_url() приймає три параметри:

• $blog_id (integer, необов’язковий): ID блогу. За замовчуванням: поточний сайт;
• $path (string, необов’язковий): Довільний шлях, який буде використовуватися в якості URL. За замовчуванням: »;
• $scheme (string, необов’язковий): Схема, яка задає контекст URL домашньої сторінки (‘http‘, ‘https‘, або ‘relative‘). За замовчуванням: звичайна або захищене з’єднання, в залежності від is_ssl().

Примітка: Як і у випадку з home_url() і get_home_url(), не варто розглядати ці функції, як «одна отримує, друга виводить». get_site_url() отримує URL певного блогу, функція site_url() отримує URL поточного сайту. Запам’ятайте: жодна з функцій не виводить результат.

Застосування

Отримуємо ID поточного блогу: get_current_blog_id()

Тег просто отримує ID поточного блогу.

Параметри

Цей тег шаблону не приймає параметрів.

Застосування

Повертаємо й виводимо URL адмін-панелі (консолі): get_admin_url() і admin_url()

Ці теги повертають і виводять URL консолі.

Параметри

get_admin_url() приймає три параметри:

• $blog_id (integer, необов’язковий): ID блогу. За замовчуванням: поточний сайт;
• $path (string, необов’язковий): Довільний шлях, який буде використовуватися в якості URL. За замовчуванням: »;
• $scheme (string, необов’язковий): Схема, яка буде використовуватися. ‘admin‘ враховує задану схему (за допомогою функції is_ssl()), але ви можете переписати її за допомогою цього параметра. Приймаються значення ‘http‘, ‘https‘, ‘admin‘, ‘rpc‘, ‘login‘ і ‘login_post‘. За замовчуванням: ‘admin‘.

admin_url() приймає два параметри:

• $path (string, необов’язковий): Довільний шлях, який буде використовуватися в якості URL. За замовчуванням: ».
• $scheme (string, необов’язковий): Схема, яка буде використовуватися. ‘admin‘ враховує задану схему (за допомогою функції is_ssl()), але ви можете переписати її, виставивши параметр на ‘http‘ або ‘https‘. За замовчуванням: ‘admin‘.

Застосування

Повертаємо й виводимо постійне посилання на тип розсилки: get_feed_link() і the_feed_link()

Теги повертають і виводять постійне посилання на розсилку.

Параметри

get_feed_link() приймає один параметр:

• $feed_type (string, необов’язковий): Тип розсилки. За замовчуванням: тип розсилки за замовчуванням.

the_feed_link() приймає два параметри:

• $anchor (string, необов’язковий): Текст посилання. За замовчуванням: »;
• $feed_type (string, необов’язковий): Тип розсилки. За замовчуванням: тип розсилки за замовчуванням.

Застосування

Закінчення посилання зі слешем або без: user_trailingslashit()

Тег перевіряє структуру постійної посилання, і додає (або видаляє) слеш в кінці заданого URL.

Параметри

Цей тег шаблону приймає два параметри:

• $string (string, необов’язковий): URL зі слешем на кінці або без нього. За замовчуванням: NULL;
• $type_of_url (string, необов’язковий): Технічно цей параметр поки ще не застарів, але його не використовують у вигляді функції.

Застосування

Визначаємо день, з якого починається тиждень: calendar_week_mod()

Цей «дивний» тег отримує кількість днів, що пройшли з початку тижня. Виробляється це за допомогою простого ділення з залишком.

Параметри

Цей тег шаблону приймає один параметр:

• $number (integer, обов’язковий): Кількість днів, що пройшли з початку тижня. За замовчуванням: 0.

Застосування

Отримуємо і виводимо календар: get_calendar()

Цей тег шаблону отримує і виводить календар.

Параметри

Цей тег шаблону приймає два параметри:

• $initial (bool, необов’язковий): Використовувати вихідні назви календаря (TRUE) чи ні (FALSE). За замовчуванням: TRUE;
• $echo (bool, необов’язковий): Вивести на екран (TRUE) або повернути для обробки (FALSE) результат. За замовчуванням: TRUE.

Застосування

На завершення

Сподіваємося, вам сподобалася остання порція тегів шаблонів. Це була заключна серія, але далі ми опублікуємо невелику статтю, резюмирующую все те, що ми з вами вивчили.

Якщо у вас виникли питання або зауваження, обов’язково напишіть про це в коментарях. І якщо вам сподобалася наша стаття, не забудьте поділитися нею з друзями!

Переклад статті «The Tuts+ Guide to Template Tags: Eighth Batch» був підготовлений дружною командою проекту Сайтостроение від А до Я.