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



お勧め

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

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

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。