wp_get_attachment_caption()

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

Получение подписи к вложению

/**
 * Retrieves the caption for an attachment.
 *
 * @param int $post_id Optional Attachment ID. Default is the ID of the global $post.
 * @return string|false Attachment caption on success, false on failure.
 */
function get_attachment_caption( $post_id = 0 ) {
    $post_id = (int) $post_id;
    $post = get_post( $post_id );
    if ( ! $post ) {
        return false;
    }
    $caption = $post->post_excerpt;
    if ( ! $caption ) {
        $caption = $post->post_content;
    }
    return $caption;
}
// Example usage
$attachment_id = 123;
$caption = get_attachment_caption( $attachment_id );
echo $caption;

В данном примере кода используется функция get_attachment_caption(), которая позволяет получить подпись к вложению по его ID. В функцию передается необязательный параметр $post_id, который по умолчанию равен ID текущего поста. Функция возвращает строку с подписью в случае успеха и false в случае ошибки.

В примере кода создается переменная $attachment_id, которая содержит ID вложения. Затем вызывается функция get_attachment_caption() с передачей этого ID в качестве аргумента. Результат функции сохраняется в переменной $caption. Наконец, подпись выводится на экран с помощью функции echo.

Изменение подписи к вложению

/**
 * Updates the caption for an attachment.
 *
 * @param int $post_id Attachment ID.
 * @param string $caption New attachment caption.
 * @return bool True on success, false on failure.
 */
function update_attachment_caption( $post_id, $caption ) {
    $post_id = (int) $post_id;
    $caption = sanitize_text_field( $caption );
    $post = get_post( $post_id );
    if ( ! $post ) {
        return false;
    }
    $post->post_excerpt = $caption;
    wp_update_post( $post );
    return true;
}
// Example usage
$attachment_id = 123;
$new_caption = 'New caption';
$result = update_attachment_caption( $attachment_id, $new_caption );
if ( $result ) {
    echo 'Caption updated successfully.';
} else {
    echo 'Failed to update caption.';
}

В данном примере кода используется функция update_attachment_caption(), которая позволяет изменить подпись к вложению по его ID. В функцию передается ID вложения ($post_id) и новая подпись ($caption). Функция возвращает true в случае успеха и false в случае ошибки.

В примере кода создается переменная $attachment_id, которая содержит ID вложения, и переменная $new_caption, которая содержит новую подпись. Затем вызывается функция update_attachment_caption() с передачей этих значений в качестве аргументов. Результат функции сохраняется в переменной $result. Наконец, выводится сообщение об успешном или неуспешном обновлении подписи.

Удаление подписи к вложению

/**
 * Deletes the caption for an attachment.
 *
 * @param int $post_id Attachment ID.
 * @return bool True on success, false on failure.
 */
function delete_attachment_caption( $post_id ) {
    $post_id = (int) $post_id;
    $post = get_post( $post_id );
    if ( ! $post ) {
        return false;
    }
    $post->post_excerpt = '';
    wp_update_post( $post );
    return true;
}
// Example usage
$attachment_id = 123;
$result = delete_attachment_caption( $attachment_id );
if ( $result ) {
    echo 'Caption deleted successfully.';
} else {
    echo 'Failed to delete caption.';
}

В данном примере кода используется функция delete_attachment_caption(), которая позволяет удалить подпись к вложению по его ID. В функцию передается ID вложения ($post_id). Функция возвращает true в случае успеха и false в случае ошибки.

В примере кода создается переменная $attachment_id, которая содержит ID вложения. Затем вызывается функция delete_attachment_caption() с передачей этого ID в качестве аргумента. Результат функции сохраняется в переменной $result. Наконец, выводится сообщение об успешном или неуспешном удалении подписи.

Проверка наличия подписи к вложению

/**
 * Checks if an attachment has a caption.
 *
 * @param int $post_id Attachment ID.
 * @return bool True if the attachment has a caption, false otherwise.
 */
function has_attachment_caption( $post_id ) {
    $post_id = (int) $post_id;
    $post = get_post( $post_id );
    if ( ! $post ) {
        return false;
    }
    $caption = $post->post_excerpt;
    if ( ! $caption ) {
        return false;
    }
    return true;
}
// Example usage
$attachment_id = 123;
if ( has_attachment_caption( $attachment_id ) ) {
    echo 'Attachment has a caption.';
} else {
    echo 'Attachment does not have a caption.';
}

В данном примере кода используется функция has_attachment_caption(), которая позволяет проверить наличие подписи у вложения по его ID. В функцию передается ID вложения ($post_id). Функция возвращает true, если у вложения есть подпись, и false в противном случае.

В примере кода создается переменная $attachment_id, которая содержит ID вложения. Затем вызывается функция has_attachment_caption() с передачей этого ID в качестве аргумента. Результат функции используется для вывода сообщения о наличии или отсутствии подписи.

Получение подписи к вложению по умолчанию

/**
 * Retrieves the default caption for an attachment.
 *
 * @param int $post_id Optional Attachment ID. Default is the ID of the global $post.
 * @return string|false Default attachment caption on success, false on failure.
 */
function get_default_attachment_caption( $post_id = 0 ) {
    $post_id = (int) $post_id;
    $post = get_post( $post_id );
    if ( ! $post ) {
        return false;
    }
    $caption = get_post_meta( $post_id, '_wp_attachment_image_alt', true );
    return $caption;
}
// Example usage
$attachment_id = 123;
$default_caption = get_default_attachment_caption( $attachment_id );
echo $default_caption;

В данном примере кода используется функция get_default_attachment_caption(), которая позволяет получить подпись по умолчанию для вложения по его ID. В функцию передается необязательный параметр $post_id, который по умолчанию равен ID текущего поста. Функция возвращает строку с подписью по умолчанию в случае успеха и false в случае ошибки.

В примере кода создается переменная $attachment_id, которая содержит ID вложения. Затем вызывается функция get_default_attachment_caption() с передачей этого ID в качестве аргумента. Результат функции сохраняется в переменной $default_caption. Наконец, подпись по умолчанию выводится на экран с помощью функции echo.