GET_BOOKMARKS() │ WP 2.1.0

Функция get_bookmarks() используется для получения списка закладок в WordPress. Она сначала пытается извлечь данные из кэша, а если это не удаётся, строит запрос на основе заданных аргументов и выполняет его. Результаты будут сохранены в кэше для последующего использования.

Хуки функции

• get_bookmarks

Возврат

Функция возвращает массив объектов закладок.

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

Для использования функции get_bookmarks() нужно передать ей аргументы.

$bookmarks = get_bookmarks( $args );

Аргументы

$args (string|array) — строка или массив аргументов для получения закладок. По умолчанию: пустая строка.

• orderby (string): Параметр для сортировки ссылок. Возможные значения:

  • id
  • link_id
  • name
  • link_name
  • url
  • link_url
  • visible
  • link_visible
  • rating
  • link_rating
  • owner
  • link_owner
  • updated
  • link_updated
  • notes
  • link_notes
  • description
  • link_description
  • length
  • rand

  По умолчанию: name

• order (string): Указывает, будет ли сортировка восходящей или нисходящей. Возможные значения:

  • ASC (восходящий)
  • DESC (нисходящий)

  По умолчанию: ASC

• limit (int): Количество закладок для отображения. Можно указать любое положительное число или -1 для отображения всех.

  По умолчанию: -1

• category (string): Список идентификаторов категорий, из которых нужно получить ссылки. Список разделяется запятыми.

  По умолчанию: пустая строка

• category_name (string): Название категории, для которой нужно получить ссылки.

  По умолчанию: пустая строка

• hide_invisible (int|true|false): Параметр, отвечающий за отображение или скрытие ссылок, помеченных как "невидимые".

  • Принимает: 1|true или 0|false

  По умолчанию: 1|true

• show_updated (int|true|false): Отображать ли время последнего обновления закладки.

  Принимает: 1|true или 0|false

  По умолчанию: 0|false

• include (string): Список идентификаторов закладок, которые необходимо включить.

  По умолчанию: пустая строка

• exclude (string): Список идентификаторов закладок, которые необходимо исключить.

  По умолчанию: пустая строка

• search (string): Поисковые термины. Будет отформатировано для SQL-запроса с подстановочными знаками до и после.

  По умолчанию: пустая строка

Примеры

Пример 1: Вывод ссылок из категории "Связанные сайты"

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

$bookmarks = get_bookmarks( array(
    'orderby'        => 'name',
    'order'          => 'ASC',
    'category_name'  => 'Related Sites'
) );

// Проходим по каждой закладке и выводим отформатированный результат
foreach ( $bookmarks as $bookmark ) { 
    printf( '%2$s
', 
        esc_attr( $bookmark->link_url ), 
        $bookmark->link_name 
    );
}

Примечания

• Глобальный объект: $wpdb — это объект абстракции базы данных WordPress.

Изменения

• С версии 2.1.0 - функция была введена.

Полный код функции get_bookmarks()

Чтобы лучше понять, как работает эта функция, ниже представлено её полное описание на PHP:

function get_bookmarks( $args = '' ) {
global $wpdb;

$defaults = array(
    'orderby'        => 'name',
    'order'          => 'ASC',
    'limit'          => -1,
    'category'       => '',
    'category_name'  => '',
    'hide_invisible' => 1,
    'show_updated'   => 0,
    'include'        => '',
    'exclude'        => '',
    'search'         => '',
);

$parsed_args = wp_parse_args( $args, $defaults );

// Логика работы функции...

}

Связанные функции

• edit_bookmark_link() — редактирование ссылки закладки.
• get_bookmark() — получение одной закладки.
• wp_list_bookmarks() — вывод списка закладок.

Эти функции помогут вам эффективно работать с закладками в WordPress и управлять ими.