説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。