Функция the_attachment_link() в WordPress: использование и примеры

Функция the_attachment_link() │ WP 2.0.0

Эта функция позволяет вывести ссылку на страницу вложения с использованием изображения или иконки.

Использует

Функция основана на wp_get_attachment_link().

Производительность:

  • Вызов функции 1 раз занимает 0.00291 секунды (очень медленно)
  • Вызов функции 50,000 раз — 5.22 секунды (быстро)
  • Версия PHP: 7.1.2, WordPress: 4.7.3

Возвращаемое значение

Функция возвращает null. Это значит, что она ничего не возвращает.

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

Синтаксис функции выглядит следующим образом:

the_attachment_link( $post, $fullsize, $deprecated, $permalink );

Где параметры функции:

  • $post (int|WP_Post): ID записи или объект записи.
  • $fullsize (true|false): Использовать ли изображение в полном размере. По умолчанию: false.
  • $deprecated (true|false): Устаревший параметр. Не используется. По умолчанию: false.
  • $permalink (true|false): Включать ли постоянную ссылку. По умолчанию: false.

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

Пример 1: Отображение ссылки на полное изображение вложения (ссылка ведет на сам файл изображения):

the_attachment_link( 4, true );

Результат будет таким:


    

Пример 2: Отображение ссылки на страницу вложения, которая будет вести к странице вложения в структуре WordPress:

the_attachment_link( 4, false, false, true );

Результат будет таким:


    

Изменения

Функция была введена в версии 2.0.0.

Код функции the_attachment_link()

Находится в файле wp-includes/post-template.php:

function the_attachment_link( $post = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
    if ( ! empty( $deprecated ) ) {
        _deprecated_argument( __FUNCTION__, '2.5.0' );
    }

    if ( $fullsize ) {
        echo wp_get_attachment_link( $post, 'full', $permalink );
    } else {
        echo wp_get_attachment_link( $post, 'thumbnail', $permalink );
    }
}

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

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

  • edit_term_link() — ссылка для редактирования термина.
  • get_next_posts_link() — ссылка на следующие записи.
  • get_previous_comments_link() — ссылка на предыдущие комментарии.
  • get_previous_posts_link() — ссылка на предыдущие записи.
  • the_author_link() — ссылка на автора.

Функции для работы с вложениями:

  • get_attached_file() — получить файл вложения.
  • wp_get_attachment_link() — получить ссылку на вложение.
  • wp_get_attachment_url() — получить URL вложения.
  • wp_delete_attachment() — удалить вложение.

Эти функции помогут вам лучше управлять вложениями в WordPress.

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *