説明
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 |
注意
パラメータ$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
関連
お勧め
スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)
PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。使っていないか確認しないとね!(2017年11月18日 更新)
2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここではプラグインのロード順を制御する(2014年6月9日 更新)
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
wp_titleからwp_get_document_titleへ(2018年5月27日 更新)
先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)
投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。