説明
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
関連
お勧め
Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿ページにキーワード検索ウィジェットを追加する(2012年6月2日 更新)
「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)
少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)
ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。
タイトルのみをキーワード検索する(2014年4月3日 更新)
WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。