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

説明

plugins_url() は、プラグイン内のファイルのURLを返す関数です。

基本構文

plugins_url( string $path = '', string $plugin = '' ): string

引数

  • $path:プラグインディレクトリからの相対パス
  • $plugin:基準にするプラグインのファイルパス(通常 __FILE__)

戻り値

ファイルのURL。

使い方(サンプル)

echo esc_url( plugins_url( 'assets/logo.png', __FILE__ ) );

注意点

  • シンボリックリンクを使うと、期待したパスにならないことがあります。

実務での使いどころ

  • プラグインの中の、CSSや画像のURLを作るとき。
  • plugins_url( 'img/a.png', __FILE__ ) のように、プラグインのファイルを基準にしてURLを作るとき。

よくあるミスと対処

  • wp-content/plugins のパスを、直接書いている。サイトによって、プラグインの場所は違う。
  • 第2引数に __FILE__ を渡さず、意図したプラグインの場所にならない。

NG例

$url = '/wp-content/plugins/my-plugin/img/a.png'; // 場所を決め打ちしている

OK例

$url = plugins_url( 'img/a.png', __FILE__ );

使い分け早見表

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

関連項目

plugin_dir_url()、plugin_dir_path()

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

コメント

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