ワードプレスのwp_get_upload_dir関数の使用方法・解説

概要

wp_get_upload_dir 関数は、WordPressのアップロードディレクトリ情報を取得するために使用されます。この関数は、メディアのアップロードやファイル操作を行う際に幅広く利用されることがあります。具体的には以下のような場面で使用されます。

1. メディアファイルのパスを取得する
2. アップロードディレクトリのURLを取得する
3. アップロードファイルの保存先を指定する
4. カスタムアップロードディレクトリを設定する
5. メディアギャラリーをカスタマイズする際
6. プラグインやテーマでファイルをアップロードする際
7. ユーザーのメディアライブラリへのアクセスを構築する際
8. ファイル管理システムを実装する際

構文

wp_get_upload_dir();

パラメータ

この関数にはパラメータはありません。

戻り値

wp_get_upload_dir は、アップロードディレクトリに関する情報が格納された配列を返します。具体的には次のようなキーを持っています。

• path – アップロードディレクトリのパス
• url – アップロードディレクトリのURL
• subdir – サブディレクトリがある場合、そのサブディレクトリ名
• basedir – ベースディレクトリのパス
• baseurl – ベースURL

関連する関数

• wp_upload_bits
• wp_handle_upload
• wp_handle_sideload
• wp_mime_type_icon

使用可能なバージョン

wp_get_upload_dir 関数は、WordPress 2.6.0以降で使用可能です。

コアファイルのパス

この関数は、WordPressのコアファイルである wp-includes/media.php に含まれています。

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded	〇
wp_roles_init
setup_theme
after_setup_theme	〇
set_current_user
init
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head	〇

非推奨または削除されたバージョン

wp_get_upload_dir 関数は特定のバージョンで非推奨または削除されていません。