wp_basename()


WordPressの関数wp_basename()は、指定されたファイルパスから基本ファイル名を取得するために使用されます。この関数は、パスに含まれるディレクトリ名や拡張子を取り除いて、ファイル名だけを返します。

構文

wp_basename( string $path, string $suffix = '' );

引数の説明

  • $path (string) — ファイルパスを指定します。このパスから基本ファイル名が抽出されます。
  • $suffix (string) — (省略可能)一致する場合、ファイル名の末尾から削除するサフィックスを指定します。

例 1: 基本ファイル名を取得

指定したパスから基本ファイル名を取得します。

<?php
echo wp_basename( '/var/www/html/wp-content/uploads/image.jpg' );
// 出力: image.jpg
?>

例 2: 拡張子を除いたファイル名を取得

サフィックスを指定して拡張子を除外します。

<?php
echo wp_basename( '/var/www/html/wp-content/uploads/image.jpg', '.jpg' );
// 出力: image
?>

例 3: ディレクトリ名を含むパスでの使用

パスが長い場合でもファイル名を正確に取得します。

<?php
echo wp_basename( '/home/user/documents/project/file.pdf' );
// 出力: file.pdf
?>

例 4: サフィックスが一致しない場合の動作

指定したサフィックスがファイル名に存在しない場合、元のファイル名をそのまま返します。

<?php
echo wp_basename( '/path/to/example.docx', '.pdf' );
// 出力: example.docx
?>

例 5: 動的なパスを処理

動的に生成されたパスからファイル名を取得します。

<?php
$file_path = get_template_directory() . '/assets/js/script.js';
echo wp_basename( $file_path );
// 出力: script.js
?>

注意事項

  • $pathが空の場合、関数は空文字列を返します。
  • サフィックスを指定する際は、正確に一致する必要があります。部分一致は適用されません。

関連機能: