• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/plugins url

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/plugins url」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

plugins または mu-plugins ディレクトリーの絶対 URL を取得します(末尾のスラッシュなし)。$path を使えば、そのディレクトリー下の特定のファイルを対象にできます。$path 引数には plugins または mu-plugins ディレクトリーからの相対パスを直接書きます。または簡単に __FILE__ を第2引数へ渡せば、$path を現在の PHP スクリプトファイルの親ディレクトリーからの相対パスとして扱うことができます。

使い方

<?php plugins_url( $path, $plugin ); ?>

デフォルトの使い方

<?php $url = plugins_url(); ?>


パラメータ

$path
文字列) (オプション) URL を取得したいプラグインファイルのパス。plugins または mu-plugins ディレクトリーからの相対パス。$plugin を指定すると、そこからの相対パス。
初期値: なし
$plugin
文字列) (オプション) plugins または mu-plugins の代わりに、$path が相対パスの起点とする親ディレクトリー。
初期値: なし

戻り値

(文字列) 
plugins または mu-plugins ディレクトリーへの絶対 URL(末尾のスラッシュなし)。オプション指定によっては、そのディレクトリー内のファイルが対象となる。

用例

デフォルトの例

<?php
$plugins_url = plugins_url();
?>

$plugins_url 変数は plugins または mu-plugins ディレクトリーの絶対 URL になります。例えば: "http://www.example.com/wp-content/plugins"

一般的な使い方

plugins_url() 関数は一般的にプラグインファイルで使われます。$plugin パラメータに __FILE__ PHP マジック定数を渡すと、$path はそのプラグインファイルの親ディレクトリーからの相対パスと見なされます:

<?php
echo '<img src="' . plugins_url( 'images/wordpress.png', __FILE__ ) . '" > ';
?>

上記は、次のような HTML マークアップを出力するでしょう:

<img src="http://www.example.com/wp-content/plugins/my-plugin/images/wordpress.png">

プラグインディレクトリー内のサブディレクトリーへ置かれたファイルの中で plugins_url() 関数を使う場合、PHP の dirname() 関数を使うべきです:

<?php
echo '<img src="' . plugins_url( 'images/wordpress.png', dirname(__FILE__) ) . '" > ';
?>

上記は、次のような HTML マークアップを出力するでしょう:

<img src="http://www.example.com/wp-content/plugins/images/wordpress.png">

訳注: 出力例のように1階層分飛ばされるので、サブディレクトリーでこのようにすれば、プラグインディレクトリーの親ディレクトリーを正しく指定できます。


参考

  • URL を合成するとき定数 WP_PLUGIN_URL、または WPMU_PLUGIN_URL$plugin パスが WPMU_PLUGIN_DIR パスで始まるとき)を使います。WordPress の内部定数を直接使うのは 推奨されない ことに注意してください。
  • apply_filters() を使い、合成した URL に "plugins_url" フィルターを適用します。これは次のようなコードで行われます:
    return apply_filters( 'plugins_url', $url, $path, $plugin );
  • plugins_url() 関数はプラグインのグローバルなコンテキスト内で呼び出してはいけません。そうではなく、この関数が呼び出された時点で "plugins_url" フィルターが確実にフック済みである "init" または "admin_init" などの フック 内で呼び出すのは大丈夫です。これはいろいろな構成のサイトが正しく動作するためにとても重要です。もしプラグインファイルのグローバルなコンテキストから plugins_url() を呼び出すと、他のプラグインがこのフィルターを利用できません。(ただし mu-plugins /en は他のプラグインより先に実行されるのでこのフィルターを利用できます。)

変更履歴

ソースファイル

plugins_url()wp-includes/link-template.php にあります。

関連項目

プラグインのパス: plugins_url(), plugin_dir_url() /en, plugin_dir_path() /en, plugin_basename()

WordPress ディレクトリ:
home_url() ホーム URL http://www.example.com
site_url() サイトディレクトリ URL http://www.example.com または http://www.example.com/wordpress
admin_url() 管理画面ディレクトリ URL http://www.example.com/wp-admin
includes_url() /en インクルードディレクトリ URL http://www.example.com/wp-includes
content_url() /en コンテンツディレクトリ URL http://www.example.com/wp-content
plugins_url() /en プラグインディレクトリ URL http://www.example.com/wp-content/plugins
wp_upload_dir() /en アップロードディレクトリ URL (配列を返す) http://www.example.com/wp-content/uploads



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/plugins_url最新版との差分