get_post_galleries()


WordPressの関数get_post_galleries()は、特定の投稿内のギャラリー情報を取得するために使用されます。この関数は、投稿のIDを基にギャラリー情報を配列として返します。

構文

get_post_galleries( int $post_id, bool $html = true );

引数の説明:

  • $post_id (int) — ギャラリー情報を取得する投稿のID。
  • $html (bool) — trueの場合、ギャラリーのHTMLを返し、falseの場合はショートコードの情報を返します。

使用例

例 1. 投稿内のすべてのギャラリーを取得

このコードは、特定の投稿内のすべてのギャラリーを取得します。

<?php
$post_id = get_the_ID();
$galleries = get_post_galleries( $post_id );
?>

例 2. ギャラリーのHTMLを表示

取得したギャラリーのHTMLを直接出力します。

<?php
$post_id = get_the_ID();
$galleries = get_post_galleries( $post_id, true );
if ( ! empty( $galleries ) ) {
    foreach ( $galleries as $gallery ) {
        echo $gallery;
    }
}
?>

例 3. ショートコード情報を取得

ギャラリーのショートコード情報を配列で取得します。

<?php
$post_id = get_the_ID();
$galleries = get_post_galleries( $post_id, false );
print_r( $galleries );
?>

例 4. 投稿内にギャラリーが存在するか確認

このコードは、投稿内にギャラリーが存在するかどうかを確認します。

<?php
$post_id = get_the_ID();
$galleries = get_post_galleries( $post_id );
if ( ! empty( $galleries ) ) {
    echo 'ギャラリーが見つかりました。';
} else {
    echo 'ギャラリーはありません。';
}
?>

例 5. 最初のギャラリーのみを取得して表示

投稿内の最初のギャラリーのみを表示します。

<?php
$post_id = get_the_ID();
$galleries = get_post_galleries( $post_id );
if ( ! empty( $galleries ) ) {
    echo reset( $galleries );
}
?>

注意事項

ギャラリーが存在しない場合、この関数は空の配列を返します。
$post_idが無効な場合、この関数はnullを返します。

関連機能：