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



お勧め

テーブルブロックを定形に整える(2021年12月27日 更新)

ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。