wp_upload_dir:WordPress私的マニュアル

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	アップロード先のURL	http://localhost/wp/wp-content/uploads/2011/04
subdir	ベースディレクトリからのサブディレクトリ名	/2011/04
basedir	アップロード先ペースディレクトリのパス名	C:\Program Files (x86)\Apache Group\Apache2\htdocs\wp/wp-content/uploads
baseurl	アップロード先ペースディレクトリのURL	http://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

参考

Code Reference: wp_upload_dir

wp_upload_dir

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧めコンテンツ