パスとURL

パスとURL - いろんな定数や関数があるんです

説明

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。
具体的な関数や定数について説明する前提条件は次の通りとする。
環境(OS)ドキュメントルートディレクトリドメイン名
Linux/var/www/htmllocalhost
WindowsC:\Apache2\htdocslocalhost
またWordPressは、ドキュメントルートディレクトリにwpディレクトリを作成し、そのディレクトリの中にインストール。サイトのアドレス(URL)は、「http://localhost/wp」ではなく「http://localhost」とする。
ディレクトリ
ディレクトリ関連の定数としては次のものがある。
定数直接対応する関数格納されている値の例(Linux)格納されている値の例(Windows)
ABSPATH-/var/www/html/wp/C:\Apache2\htdocs.it2easy\wp/
WP_CONTENT_DIR-/var/www/html/wp/wp-contentC:\Apache2\htdocs.it2easy\wp/wp-content
WP_LANG_DIR-/var/www/html/wp/wp-content/languagesC:\Apache2\htdocs.it2easy\wp/wp-content/languages
WP_PLUGIN_DIR-/var/www/html/wp/wp-content/pluginsC:\Apache2\htdocs.it2easy\wp/wp-content/plugins
TEMPLATEPATHget_template_directory/var/www/html/wp/wp-content/themes/mythemeC:\Apache2\htdocs.it2easy\wp/wp-content/themes/mytheme
STYLESHEETPATHget_stylesheet_directory/var/www/html/wp/wp-content/themes/mythemeC:\Apache2\htdocs.it2easy\wp/wp-content/themes/mytheme
WPINC-wp-includeswp-includes
LANGDIR-wp-content/languageswp-content/languages

これらの中で比較的よく使うのがABSPATH。Windows環境であっても末尾にスラッシュ(/)が付いているのがポイントだろう。

注意したいのはWordPress 3.0から使用できるようになった子テーマにおけるTEMPLATEPATHとSTYLESHEETPATHの使い分け。子テーマでTEMPLATEPATHの値は親テーマのパス名になり、STYLESHEETPATHの値は子テーマのパス名になる。子テーマを作成する際はこの点は押さえておきたいポイントである。

URL
URL関連の関数や定数としては次のものがある。
URL定数関数格納されている値の例
WordPressのアドレス(URL)get_option('siteurl')
get_bloginfo('wpurl')
site_url(get_site_url)
-http://localhost/wp
サイトのアドレス(URL)get_option('home')
get_bloginfo('url')
home_url(get_home_url)
-http://localhost
wp_contentディレクトリのURLWP_CONTENT_URL-http://localhost/wp/wp-content
プラグインディレクトリのURLWP_PLUGIN_URL-http://localhost/wp/wp-content/plugins
現在のテーマ(子テーマの場合は親テーマ)のURL-get_template_directory_urihttp://localhost/wp/wp-content/themes/mytheme
現在のテーマのURL-get_stylesheet_directory_urihttp://localhost/wp/wp-content/themes/mytheme

WordPressのアドレス(URL)とサイトのアドレス(URL)を取得する方法は、それぞれいくつかの方法が用意されている。取得したURLにコンテンツのパスを付与する場合は、site_url関数やhome_url関数を使う方が便利だろう。

TEMPLATEPATHとSTYLESHEETPATHと同様に子テーマにおけるget_template_directory_uri関数とget_stylesheet_directory_uri関数の使い分けは押さえておきたいポイントである。子テーマでは、get_template_directory_uri関数で取得できるのは親テーマのURLであり、自身のURLはget_stylesheet_directory_uri関数を使わなければならない。

その他
このように様々な定数・関数があるわけだが、最後にもう1つwp_upload_dir関数について触れておく。これは、アイキャッチ画像や投稿の添付ファイルの保存先のパス名やURLを取得する関数である。取得できる情報は連想配列になっており、対応するキー名を指定して使用する。
$upload_info = wp_upload_dir();
echo $upload_info['path']; // アップロード先パス名
echo $upload_info['url']; // アップロード先URL

こんな感じで、パスやURLに関係する定数や関数はけっこうたくさんある。中には勘違いしやすいのもあるので、きちんと覚えておきたい。

関連

お勧めコンテンツ

add_options_page(2011年5月26日 登録)

mixed add_options_page( string $page_title, string $menu_title, mixed string $capability, string $menu_slug [ , mixed $function = '' ] )
設定メニューにサブメニューを登録する。

stripslashes_from_strings_only(2015年12月12日 登録)

mixed stripslashes_from_strings_only( mixed $value )
文字列のスラッシュを取り除く。

is_super_admin(2010年6月28日 登録)

bool is_super_admin( [ mixed $user_id = false ] )
利用者が特権管理者(super admin)か調べる。

get_language_attributes(2015年8月26日 登録)

string get_language_attributes( string $doctype = 'html' )
HTMLタグの属性を取得する。

_n(2014年2月5日 登録)

string _n( string $single, string $plural, int $number [ , string $domain = 'default' ] )
数値フォーマットの翻訳テキストを取得する。

最終更新日時 : 2011-10-06 21:23