説明
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
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた(2019年6月4日 更新)
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード(2018年5月27日 更新)
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。