wp_get_attachment_url() の概要
wp_get_attachment_url()
は、WordPressのメディアライブラリにアップロードされた添付ファイルのURLを取得するための関数です。画像やPDF、音声ファイルなどのメディアが投稿に紐づいている場合、その添付ファイルのURLを簡単に取得できます。引数として添付ファイルのIDを指定するだけで、ファイルの完全なURLを返してくれるため、テンプレートファイルやカスタム出力に便利です。メディアファイルのリンク生成やAPIレスポンスでの出力など、幅広い場面で活用できます。
パラメータ
パラメータ名 | 型 | 必須 | 説明 |
---|
$attachment_id | int | 必須 | 取得したい添付ファイルの投稿ID(attachment 投稿タイプ) |
戻り値
型 | 説明 |
---|
string | 添付ファイルのURL。ファイルが存在しない場合は false を返す |
使用例
1. 添付ファイルのURLを取得して表示する
$attachment_id = 123;
$url = wp_get_attachment_url($attachment_id);
echo $url;
2. 画像タグとして出力する
$attachment_id = 123;
$url = wp_get_attachment_url($attachment_id);
if ( $url ) {
echo '<img src="' . esc_url($url) . '" alt="">';
}
3. ACF(Advanced Custom Fields)と併用する
$attachment_id = get_field('custom_file'); // カスタムフィールドからIDを取得
$url = wp_get_attachment_url($attachment_id);
if ( $url ) {
echo '<a href="' . esc_url($url) . '">ファイルをダウンロード</a>';
}
関連する関数
wp_get_attachment_image_url()
:画像のURLを取得(サイズ指定可能)
wp_get_attachment_image()
:画像タグを取得
get_attached_file()
:サーバー上のファイルパスを取得
wp_get_attachment_metadata()
:添付ファイルのメタ情報を取得
wp_get_attachment_image_src()
:画像のURL・幅・高さなどを配列で取得