gallery_shortcode()

Создает вывод галереи для шорткода Gallery
Функция WordPress
INT 3.7.0, 2.5.0
WordPress Icon

Описание функции

Функция gallery_shortcode() строит вывод галереи для шорткода [gallery].

Шорткод [gallery] позволяет вставлять галерею изображений в контент страницы или записи. Функция gallery_shortcode() отвечает за построение HTML-кода галереи на основе переданных атрибутов и параметров.

Использование

gallery_shortcode( array $attr ) : string

Функция gallery_shortcode() принимает массив атрибутов $attr и возвращает строку с HTML-кодом галереи.

Пример использования:

$gallery = gallery_shortcode( array(
    'order'     => 'ASC',
    'orderby'   => 'menu_order ID',
    'id'        => get_the_ID(),
    'columns'   => 3,
    'size'      => 'thumbnail',
) );
echo $gallery;

В данном примере функция gallery_shortcode() формирует галерею с изображениями, отсортированными по возрастанию, для текущего поста с помощью функции get_the_ID(). Галерея будет иметь 3 колонки и использовать размер изображений «thumbnail». Результат выводится с помощью функции echo.

  • $attr (обязательный): Атрибуты шорткода галереи.
  • order (строка): Порядок изображений в галерее. По умолчанию ‘ASC’. Допустимые значения: ‘ASC’, ‘DESC’.
  • orderby (строка): Поле для сортировки изображений. По умолчанию ‘menu_order ID’. Принимает любое допустимое SQL выражение ORDERBY.
  • id (целое число): Идентификатор записи. По умолчанию используется текущая запись.
  • itemtag (строка): HTML-тег для каждого изображения в галерее. По умолчанию ‘dl’ или ‘figure’ при поддержке HTML5 галерей в теме.
  • icontag (строка): HTML-тег для иконки каждого изображения. По умолчанию ‘dt’ или ‘div’ при поддержке HTML5 галерей в теме.
  • captiontag (строка): HTML-тег для подписи каждого изображения. По умолчанию ‘dd’ или ‘figcaption’ при поддержке HTML5 галерей в теме.
  • columns (целое число): Количество колонок изображений для отображения. По умолчанию 3.
  • size (строка или массив): Размер изображений для отображения. Принимает имя зарегистрированного размера изображения или массив значений ширины и высоты в пикселях (в этом порядке). По умолчанию ‘thumbnail’.
  • ids (строка): Список идентификаторов вложений, которые нужно отобразить. По умолчанию пусто.
  • include (строка): Список идентификаторов вложений, которые нужно включить. По умолчанию пусто.
  • exclude (строка): Список идентификаторов вложений, которые нужно исключить. По умолчанию пусто.
  • link (строка): Что использовать в качестве ссылки для каждого изображения. По умолчанию пусто (ссылка на страницу вложения). Принимает значения ‘file’, ‘none’.

Функция возвращает строку с HTML-кодом галереи для шорткода [gallery].

<?php
/**
 * Example usage of gallery_shortcode()
 */
$gallery = gallery_shortcode( array(
    'order'     => 'ASC',
    'orderby'   => 'menu_order ID',
    'id'        => get_the_ID(),
    'itemtag'   => 'div',
    'icontag'   => 'span',
    'captiontag' => 'p',
    'columns'   => 4,
    'size'      => array( 800, 600 ),
    'ids'       => '1,2,3',
    'link'      => 'file',
) );
echo $gallery;
?>

В данном примере функция gallery_shortcode() формирует галерею с изображениями, отсортированными по возрастанию, для текущего поста с помощью функции get_the_ID(). Галерея будет использовать HTML-теги <div> для каждого изображения, <span> для иконки и <p> для подписи. Галерея будет иметь 4 колонки и использовать размер изображений 800×600 пикселей. Будут отображены только изображения с идентификаторами 1, 2 и 3. Ссылки будут вести на файлы изображений. Результат выводится с помощью функции echo.

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

Создание галереи изображений


$attr = array(
    'ids' => '1,2,3' // список ID вложений, которые нужно отобразить в галерее
);
echo gallery_shortcode($attr);

В этом примере мы создаем галерею изображений, используя функцию gallery_shortcode(). Мы передаем массив $attr с параметром ids, в котором указываем список ID вложений, которые нужно отобразить в галерее. Функция возвращает HTML-контент для отображения галереи.

Настройка порядка отображения изображений в галерее


$attr = array(
    'order' => 'DESC', // порядок отображения изображений (в данном случае - по убыванию)
    'orderby' => 'title' // поле, по которому происходит сортировка (в данном случае - по заголовку)
);
echo gallery_shortcode($attr);

В этом примере мы настраиваем порядок отображения изображений в галерее. Мы передаем параметры order и orderby в массиве $attr. Параметр order указывает порядок отображения (в данном случае — по убыванию), а параметр orderby указывает поле, по которому происходит сортировка (в данном случае — по заголовку).

Изменение размера изображений в галерее


$attr = array(
    'size' => 'medium' // размер изображений в галерее (в данном случае - средний)
);
echo gallery_shortcode($attr);

В этом примере мы изменяем размер изображений в галерее. Мы передаем параметр size в массиве $attr, указывая желаемый размер (в данном случае — средний). WordPress автоматически изменит размер изображений в соответствии с указанным размером.

Включение и исключение определенных изображений в галерее


$attr = array(
    'include' => '1,3,5', // список ID вложений, которые нужно включить в галерею
    'exclude' => '2,4' // список ID вложений, которые нужно исключить из галереи
);
echo gallery_shortcode($attr);

В этом примере мы включаем и исключаем определенные изображения в галерее. Мы передаем параметры include и exclude в массиве $attr, указывая список ID вложений, которые нужно включить и исключить соответственно.

Установка ссылок на изображения в галерее


$attr = array(
    'link' => 'file' // тип ссылки на изображения в галерее (в данном случае - ссылка на файл)
);
echo gallery_shortcode($attr);

В этом примере мы устанавливаем тип ссылки на изображения в галерее. Мы передаем параметр link в массиве $attr, указывая желаемый тип ссылки (в данном случае — ссылка на файл). По умолчанию, ссылки ведут на страницу вложения.

Вопросы и ответы

Как изменить порядок изображений в галерее?

Для изменения порядка изображений в галерее необходимо использовать параметр order функции gallery_shortcode(). По умолчанию порядок установлен как ‘ASC’ (по возрастанию), но вы можете изменить его на ‘DESC’ (по убыванию).


$attr = array(
    'order' => 'DESC'
);
echo gallery_shortcode($attr);

Как изменить поле, по которому сортируются изображения в галерее?

Для изменения поля, по которому сортируются изображения в галерее, используйте параметр orderby функции gallery_shortcode(). По умолчанию поле установлено как ‘menu_order ID’, но вы можете использовать любое допустимое выражение SQL ORDERBY.


$attr = array(
    'orderby' => 'post_date'
);
echo gallery_shortcode($attr);

Как изменить количество столбцов изображений в галерее?

Для изменения количества столбцов изображений в галерее используйте параметр columns функции gallery_shortcode(). По умолчанию установлено 3 столбца, но вы можете указать любое другое значение.


$attr = array(
    'columns' => 4
);
echo gallery_shortcode($attr);

gallery_shortcode() — это функция WordPress, которая используется для создания вывода галереи.

Она принимает один обязательный параметр — массив атрибутов галереи. Возвращает функция строку HTML-кода для отображения галереи.

Как изменить размер изображений в галерее?

Для изменения размера изображений в галерее можно использовать атрибут size. Он принимает значение размера изображений, которое может быть именем зарегистрированного размера изображения или массивом значений ширины и высоты в пикселях.

Пример кода:


$attr = array(
    'size' => 'medium'
);
echo gallery_shortcode($attr);

Как указать определенные изображения для отображения в галерее?

Для указания определенных изображений в галерее можно использовать атрибут ids. Он принимает список ID вложений, разделенных запятыми.

Пример кода:


$attr = array(
    'ids' => '1,2,3'
);
echo gallery_shortcode($attr);

Как исключить определенные изображения из галереи?

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

Пример кода:


$attr = array(
    'exclude' => '4,5,6'
);
echo gallery_shortcode($attr);

Как изменить ссылку для каждого изображения в галерее?

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

Пример кода:


$attr = array(
    'link' => 'file'
);
echo gallery_shortcode($attr);

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

Связанные элементы

  • Функция add_filter(): регистрирует функцию обратного вызова для выполнения фильтрации данных.
  • Функция apply_filters(): применяет все функции обратного вызова, зарегистрированные для указанного фильтра.
  • Функция do_action(): вызывает все функции обратного вызова, зарегистрированные для указанного действия.
  • Функция wp_enqueue_script(): регистрирует скрипт для загрузки на страницу.
  • Функция wp_enqueue_style(): регистрирует таблицу стилей для загрузки на страницу.
  • Функция wp_register_script(): регистрирует скрипт для использования в дальнейшем.
  • Функция wp_register_style(): регистрирует таблицу стилей для использования в дальнейшем.
Обсуждение