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

最終更新 : 2018年05月27日 10:53



お勧め

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。