plugin_dir_path() の使い方|説明・引数・注意点

説明

plugin_dir_path() は、プラグインのディレクトリのサーバー上のパスを返す関数です。

基本構文

plugin_dir_path( string $file ): string

引数

  • $file:プラグインのファイルパス(通常 __FILE__)

戻り値

末尾にスラッシュ付きのディレクトリパス。

使い方(サンプル)

require_once plugin_dir_path( __FILE__ ) . 'includes/class-main.php';

注意点

  • 戻り値の末尾にスラッシュが付きます。連結するとき、先頭にスラッシュを重ねないようにします。

実務での使いどころ

  • プラグインの中で、PHPファイルを require するとき。
  • プラグインのフォルダの場所を、定数として保持するとき。

よくあるミスと対処

  • URLが欲しいのに、これを使っている。この関数が返すのは、サーバー上のパス。URLには plugin_dir_url() を使う。
  • 引数に __FILE__ を渡し忘れる。
  • 末尾に / が付くことを忘れ、スラッシュが重なる。

NG例

require_once plugin_dir_path( __FILE__ ) . '/inc/helper.php'; // スラッシュが重なる

OK例

require_once plugin_dir_path( __FILE__ ) . 'inc/helper.php';

使い分け早見表

関数 返すもの
plugin_dir_path() プラグインのフォルダのパス(末尾に / あり)
plugin_dir_url() プラグインのフォルダのURL
plugins_url() プラグインのファイルのURL

関連項目

plugin_dir_url()、plugins_url()

公式リファレンス:plugin_dir_path() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました