wp_get_original_image_path

説明

string | false wp_get_original_image_path( int $attachment_id [ , bool $unfiltered = false ] )
オリジナルの画像ファイルのパス名を取得する。

パラメータ

  • $attachment_id
    メディア(添付ファイル)の投稿IDを指定。
  • $unfiltered
    [5.4.0] get_attached_file関数の第2パラメータを指定(省略時はfalse)。

返り値

パラメータ$attachment_idが有効な場合はアップロードされたオリジナルの画像ファイルのパス名を返す。無効な場合はfalseを返す。

注意

5.3.0ではJPEGファイルの向き情報を検知し、必要に応じて向きを調整する機能が追加された。向きが調整された場合、オリジナルファイルはそのまま残し、向きを調整して作られたファイルがメディアの投稿情報に紐づけられる。そんなオリジナルの画像ファイルのパス名を取得する目的で追加されたのが本関数である。

[5.4.0]パラメータ$unfilteredは、画像ファイルのパス名を取得する際に呼び出すget_attached_file関数の第2パラメータとなる。


使用例

  • メディアの投稿IDが41のオリジナルの画像ファイルのパス名を取得する
    <?php $path = wp_get_original_image_path( 41 ); ?>

フィルター

[5.3.0]パス名を返す前に'wp_get_original_image_path'フィルターを呼び出す。パラメータ$original_imageにはパス名が、$attachment_idには本関数が受け取ったメディアの投稿IDが格納されている。
return apply_filters( 'wp_get_original_image_path', $original_image, $attachment_id );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/post.php

最終更新 : 2020年04月02日 16:53



お勧め

囲み型ショートコードとwpautop(2018年5月27日 更新)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。