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



お勧め

5.3の新機能:JPEG画像の向きを自動調整(2019年10月17日 更新)

WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

テーブルの1列目をth要素にしてみる(2021年12月21日 更新)

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。