wp_upload_dir

（2.0.0以降）
wp_upload_dir - アップロードディレクトリ（パス名）を取得する

説明

array wp_upload_dir( [ string $time = null [ , bool $create_dir = true [ , bool $refresh_cache = false ] ] ] )
アップロードディレクトリ（パス名）を取得する。

パラメータ

  • $time
    年月を'yyyy/mm'の書式で指定（省略時はnull）。
  • $create_dir
    [4.5.0]存在しないディレクトリを作成する場合はtrueを指定（省略時はtrue）。
  • $refresh_cache
    [4.5.0]キャッシュを更新する場合はtrueを指定（省略時はfalse）。

返り値

アップロードパスを格納した連想配列を返す。配列の内容は次の通り。
キー名意味値の例
pathアップロード先のフルパス名C:\Program Files (x86)\Apache Group\Apache2\htdocs\wp/wp-content/uploads/2011/04
urlアップロード先のURLhttp://localhost/wp/wp-content/uploads/2011/04
subdirベースディレクトリからのサブディレクトリ名/2011/04
basedirアップロード先ペースディレクトリのパス名C:\Program Files (x86)\Apache Group\Apache2\htdocs\wp/wp-content/uploads
baseurlアップロード先ペースディレクトリのURLhttp://localhost/wp/wp-content/uploads
errorエラーfalse
※値の例は、Windows環境のもの。

注意

パラメータ$timeを省略した場合は、その時点の日付に基づいたアップロードパスを取得できる。最新（3.1.1）のWordPressのアップロードディレクトリは、デフォルトで年月ベースのディレクトリに整理するようになっており、その年月ペースの部分が連想配列subdirの値となる。この設定は管理者ページの「設定」－「メディア」で確認・変更することができ、プログラムからは get_option( 'uploads_use_yearmonth_folders' )で確認できる。
なおディレクトリが存在しない場合、それらのサブディレクトリを作成するが、作成に失敗した場合には配列のerrorの値にメッセージ（文字列）が格納されるようになっている。

使用例

  • 現在のアップロードディレクトリ（パス名）を取得する。
    <?php $upload_dir = wp_upload_dir(); ?>
  • 2011年3月のアップロードディレクトリを取得する。
    <?php $upload_dir = wp_upload_dir( '2011/03' ); ?>

フィルター

[2.0.0]アップロードディレクトリを作成を試す前に'upload_dir'フィルターを呼び出す。パラメータ$uploadsは返り値となるディレクトリ情報の連想配列となる。
$uploads = apply_filters( 'upload_dir', $uploads );

アクション

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

ソースファイル

/wp-includes/functions.php

最終更新 : 2018年05月27日 10:53

関連

参考

Code Reference: wp_upload_dir

お勧め

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

query_posts（WP_Queryクラス）で投稿タグを絞り込む（2011年9月14日 更新）

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

classic editorプラグインを試してみた（2018年12月10日 更新）

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」（バージョン0.5.0）が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました（2014年4月15日 更新）

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。