WordPressの自作テーマ用主要関数 Part1

こんにちは、Azusaです。

本日から少しずつですが、WordPressの自作テーマを作成する際によく使うと思われる関数について、自分用の備忘録も兼ねて書いていこうと思います。

主要な引数については出来る限り解説を入れていきますが、初心者では余り使う機会がなさそうな引数等に関しては省略して記載していきますので、高度な使い方をしたい方は公式のリファレンス(英語)を参照してください。

第1回の本日は、ヘッダーやフッター等の各種テンプレートを別のテンプレートファイルから読み込む場合に使う関数を紹介していきます！

get_header()

まずはヘッダーファイルを読み込むget_header関数です。

第1引数にヘッダーファイルの名前を指定し、第2引数にそのヘッダーファイルに渡すための引数をリスト形式で指定します。

第1引数に何も指定しない場合は、”header.php”が読み込まれます。

get_header();

↓

"header.php"が読み込まれる

そして、第一引数に何かを指定した場合、例えば”test”と指定した場合は、”header-“に指定した文字列(“test”)を追記した名前のPHPファイル(“header-test.php”)が読み込まれます。

get_header('test');

↓

"header-test.php"が読み込まれる

テーマを作り始めたばかりの方は、ヘッダーを別ファイルにすることもあまりなさそうですので、引数無しで”header.php”を作成して読み込むといいと思います。

存在しないファイルを読み込もうとした場合は”false”が返ってきます。

get_footer()

get_footer関数は上記のget_header関数のフッターバージョンです、引数も同じで、読み込まれるファイルの名称が”footer.php”や”footer-test.php”のように変化するだけです。

2つの関数で基本的なヘッダーとフッターを定義しておき、基本的には下記コードのようにのメイン部分を出力する関数をサンドイッチするような構成で使用することになるかと思います。

// index.php

get_header();

メイン部分を出力する関数();

get_footer();

get_sidebar()

get_sidebar関数も同じで、”sidebar.php”もしくは”sidebar-test.php”のような名称のファイルを読み込むことができます。

サイドバーは3カラム構成等で複数利用することも多々ありますので、引数に名称を指定して読み込むことも多いのかなといった印象です。

1つしかサイドバーが必要ないのであれば、ヘッダーやフッターのように何も指定せずに”sidebar.php”を読み込むことも可能です。

get_template_part()

get_template_part関数は第1引数が必須となっています。

例えば、

get_template_part('test');

と指定した場合は、”test.php”が読み込まれます。

この関数の場合、何も指定せずに呼び出すことはできませんので、必ず対応するファイルを作成し、引数にそのファイル名を指定して呼び出すようにしてください。

第2引数と第3引数は、これまでに紹介した”get_header”関数などの第1,2引数がそれぞれずれて対応しています。

get_template_part('test', 'aaa');

と書くと、”test-aaa.php”が呼び出されます。

bloginfo(), get_bloginfo()

bloginfo関数とget_bloginfo関数は出力される情報は同じですが、関数自体が情報に置き換えられるように動作するか返り値として情報が与えられるかの違いがあります。

返り値を出力したい場合にechoが使われることが多いですが、get_bloginfo関数の返り値をechoで出力したものがbloginfo関数で出力されるものと同じです。

bloginfo('name');


echo(get_bloginfo('name'));

上記2つのコードは、どちらも同じ結果となり、当サイトで言えば”Akiの開発室. -Aki’s Development Room.-“が出力されます。

トップページのタイトルなどを指定するときに、

<title><?php bloginfo('name'); ?></title>

or

<title><?php echo(get_bloginfo('name')); ?></title>

のように書くことで、WordPressの設定で指定しているウェブサイトの名称を代入することができます。

“name”の他にも下記表のように様々な情報を出力することができます。

上記以外にも存在しますが、基本的なテーマでは上記だけあれば多分十分なはず…。

気になる方は見出しの関数名をクリックすると公式のリファレンスに飛びますので、そちらで確認していただければと思います。

ちょっと長くなってきたので第1弾はここらへんで終わりにします！

少しずつですが、地道に更新していくつもりですので、もしよろしければPart2以降もお付き合いくださいませ♪

ではでは～ﾉｼ

2021/10/11 追記 :

まとめページはこちらです↓