wp_upload_dir()


WordPressのwp_upload_dir()関数は、現在のアップロードディレクトリのパスとURLを取得するために使用されます。この関数を使用すると、テーマやプラグインでアップロードされたファイルにアクセスしたり操作したりすることができます。

構文

wp_upload_dir();

返り値

この関数は以下のキーを含む連想配列を返します:

  • path (string) — アップロードディレクトリのサーバーパス。
  • url (string) — アップロードディレクトリのURL。
  • subdir (string) — サブディレクトリのパス (例: /2024/12)。
  • basedir (string) — 基本アップロードディレクトリのサーバーパス。
  • baseurl (string) — 基本アップロードディレクトリのURL。
  • error (bool) — エラーが発生した場合はtrue

使用例

例1: アップロードディレクトリのパスを取得

現在のアップロードディレクトリのパスを取得します。

<?php
$upload_dir = wp_upload_dir();
echo $upload_dir['path'];
?>

例2: アップロードディレクトリのURLを取得

現在のアップロードディレクトリのURLを取得します。

<?php
$upload_dir = wp_upload_dir();
echo $upload_dir['url'];
?>

例3: 基本アップロードディレクトリのパスを取得

基本アップロードディレクトリのパスを取得します。

<?php
$upload_dir = wp_upload_dir();
echo $upload_dir['basedir'];
?>

例4: 特定のファイルの完全パスを生成

アップロードディレクトリ内の特定のファイルの完全パスを生成します。

<?php
$upload_dir = wp_upload_dir();
$file_path = $upload_dir['path'] . '/example.jpg';
echo $file_path;
?>

例5: 年月ごとのサブディレクトリを確認

アップロードディレクトリのサブディレクトリを確認します。

<?php
$upload_dir = wp_upload_dir();
if ( ! empty( $upload_dir['subdir'] ) ) {
    echo '現在のサブディレクトリ: ' . $upload_dir['subdir'];
}
?>

注意事項

wp_upload_dir()は、upload_pathupload_url_pathの設定に依存するため、カスタマイズされている場合は返り値が異なる場合があります。


関連機能: