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

最終更新 : 2016年04月22日 16:52



お勧め

ログアウト後はいつもサイトトップ(2015年5月7日 更新)

ログアウト後に表示(リダイレクト)されるページは、標準ではログインページ(wp-login.php)である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない(2015年3月21日 更新)

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

4.4では投稿ページも専用テンプレートが適用できる(2015年11月7日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

xmlrpc.phpへのアクセスについてちょっと考えた(2015年7月11日 更新)

少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。