• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get attached file

提供: WordPress Codex 日本語版
移動先: 案内検索

添付ファイルの ID を指定して、そのファイルのパスを取得します。

'get_attached_file' フィルターを用いて、返されるパスを変更できますが、フィルターを適用させないこともできます。

この関数の内部では、'_wp_attached_file' という名前の投稿メタ情報(カスタムフィールド)を取得して返します。つまり、カスタムフィールドの取り扱いとフィルター適用の面倒を省いてくれる便利な関数です。

使い方

<?php get_attached_file( $attachment_id, $unfiltered ); ?>

パラメータ

$attachment_id
整数) (必須) 添付ファイルの ID.
初期値: なし
$unfiltered
真偽値) (オプション) フィルター適用を禁止するかどうか。
初期値: false - 適用する

戻り値

(文字列) 
添付ファイルのファイルパス。

用例

// フルパスを取得。
$fullsize_path = get_attached_file( $attachment_id );
// ファイル名のみ。
$filename_only = basename( get_attached_file( $attachment_id ) );

参考

  • apply_filters() を使ってフィルターフック 'get_attached_file' を呼び出します。パラメータはファイルパスと $attachment_id です。
  • get_post_meta() を使って $attachment_id から '_wp_attached_file' メタ情報(カスタムフィールド)を取得します。

変更履歴

バージョン 2.0.0 : 新規導入。

ソースファイル

get_attached_file()wp-includes/post.php にあります。

添付ファイル関数: get_children(), get attached media(), the_attachment_link(), get_attachment_link(), wp_get_attachment_link(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_url(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), is_attachment(), wp_get_attachment_metadata()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_attached_file最新版との差分