この記事は最後に更新してから1年以上経過しています。
説明
テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。具体的な関数や定数について説明する前提条件は次の通りとする。
環境(OS) | ドキュメントルートディレクトリ | ドメイン名 |
---|---|---|
Linux | /var/www/html | localhost |
Windows | C:\Apache2\htdocs | localhost |
ディレクトリ
ディレクトリ関連の定数としては次のものがある。定数 | 直接対応する関数 | 格納されている値の例(Linux) | 格納されている値の例(Windows) |
---|---|---|---|
ABSPATH | - | /var/www/html/wp/ | C:\Apache2\htdocs.it2easy\wp/ |
WP_CONTENT_DIR | - | /var/www/html/wp/wp-content | C:\Apache2\htdocs.it2easy\wp/wp-content |
WP_LANG_DIR | - | /var/www/html/wp/wp-content/languages | C:\Apache2\htdocs.it2easy\wp/wp-content/languages |
WP_PLUGIN_DIR | - | /var/www/html/wp/wp-content/plugins | C:\Apache2\htdocs.it2easy\wp/wp-content/plugins |
TEMPLATEPATH | get_template_directory | /var/www/html/wp/wp-content/themes/mytheme | C:\Apache2\htdocs.it2easy\wp/wp-content/themes/mytheme |
STYLESHEETPATH | get_stylesheet_directory | /var/www/html/wp/wp-content/themes/mytheme | C:\Apache2\htdocs.it2easy\wp/wp-content/themes/mytheme |
WPINC | - | wp-includes | wp-includes |
LANGDIR | - | wp-content/languages | wp-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ディレクトリのURL | WP_CONTENT_URL | - | http://localhost/wp/wp-content |
プラグインディレクトリのURL | WP_PLUGIN_URL | - | http://localhost/wp/wp-content/plugins |
現在のテーマ(子テーマの場合は親テーマ)のURL | - | get_template_directory_uri | http://localhost/wp/wp-content/themes/mytheme |
現在のテーマのURL | - | get_stylesheet_directory_uri | http://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に関係する定数や関数はけっこうたくさんある。中には勘違いしやすいのもあるので、きちんと覚えておきたい。
最終更新 : 2011年10月06日 21:23
関連
お勧め
add_shortcode(2018年5月27日 更新)
get_user_setting(2022年1月31日 更新)
have_posts(2018年5月27日 更新)
in_category(2018年5月27日 更新)
add_feed(2024年6月24日 更新)