概要
wp_basename 関数は、指定されたパスからベース名（パスの最後にある名前の部分）を取得するためのWordPressの関数です。この関数は、ファイルやディレクトリの名前を扱う際に非常に便利です。具体的には、次のような機能を実装する際によく使用されます：
- アップロードされたファイルの名前を取得する
- プラグインやテーマのファイルパスからファイル名を抽出する
- 特定のリソースよりもユーザーに表示する場合のファイル名の取得
- カスタムフィールドやオプションで使用されるファイル名の操作
- トラブルシューティング時にファイルの位置を確認する
- URL構築時にファイル名を取り出す
- テーマ内でスタイルシートやスクリプトのファイル名を使用する
- デバッグ用途でのファイル名の記録
構文
string wp_basename( string $path )
パラメータ
$path(string): 基準となるパス。
戻り値
- (string): 指定されたパスのベース名。
関連する関数
使用可能なバージョン
wp_basename 関数は、WordPress 2.0.0 以降で使用可能です。
コアファイルのパス
wp-includes/functions.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 |
サンプルコード
サンプル1: アップロードされたファイルの名前を取得
このコードは、指定されたパスからファイル名を抽出し、表示します。
$upload_dir = wp_upload_dir();
$file_path = $upload_dir['path'] . '/example.jpg';
$file_name = wp_basename($file_path);
echo 'ファイル名: ' . $file_name; // 例: example.jpg
（引用元: https://developer.wordpress.org/reference/functions/wp_basename/）
サンプル2: テーマ内のスタイルシートファイル名を取得
この例では、テーマ内のCSSファイルのパスからファイル名を取得し、使用しています。
$style_path = get_template_directory() . '/style.css';
$style_name = wp_basename($style_path);
echo 'スタイルシート名: ' . $style_name; // 例: style.css
（引用元: https://developer.wordpress.org/reference/functions/wp_basename/）
サンプル3: プラグインのファイル名を取得
プラグインが読み込むファイルの名前を取得するコードです。
$plugin_path = plugin_dir_path(__FILE__) . 'my-plugin.php';
$plugin_name = wp_basename($plugin_path);
echo 'プラグイン名: ' . $plugin_name; // 例: my-plugin.php
（引用元: https://developer.wordpress.org/reference/functions/wp_basename/）
サンプル4: URLからファイル名の取得
このコードは、URLからファイル名を取得するサンプルです。
$url = 'http://example.com/wp-content/uploads/example.jpg';
$file_name = wp_basename(parse_url($url, PHP_URL_PATH));
echo 'リンク先のファイル名: ' . $file_name; // 例: example.jpg
（引用元: https://developer.wordpress.org/reference/functions/wp_basename/）
サンプル5: デバッグ情報の記録
ファイルパスを取得してログに記録する際に使用します。
$path = '/var/www/html/wp-content/themes/mytheme/functions.php';
$base_name = wp_basename($path);
error_log('読み込まれたファイル: ' . $base_name); // 例: functions.php
（引用元: https://developer.wordpress.org/reference/functions/wp_basename/）