この記事は最後に更新してから1年以上経過しています。
説明
来月にリリースされるWordPress 5.5に向けてBeta 1～4と公開が続いている。「WordPress 5.5 Beta 4（以降Beta 4）」のソースコードを見ていくと、テンプレートパーツを取得する関数にパラメータが追加されていた。
はじめに、この記事は公開された5.5 Beta 4をもとにしており、正式リリースの際に変更される可能性があることを予めお断りする。
追加されるパラメータの影響
今回パラメータが追加された関数は、テンプレートパーツを取得するか、それに関連するものである。具体的な例として get_header関数の宣言は次のように変更されている。
function get_header( $name = null, $args = array() ) {青字の$argsが追加されたパラメータであり、その内容は配列となる。追加されたパラメータ$argsは、関数中のアクションにも影響を与えている。
| 関数 | アクション |
| get_header | do_action( 'get_header', $name, $args ); |
|---|---|
| get_footer | do_action( 'get_footer', $name, $args ); |
| get_sidebar | do_action( 'get_sidebar', $name, $args ); |
| get_template_part | do_action( "get_template_part_{$slug}", $slug, $name, $args ); do_action( 'get_template_part', $slug, $name, $templates, $args ); |
パラメータ$argsはテンプレートパーツを読み込む locate_template関数のパラメータとして引き継がれ、最終的にテンプレートパーツファイルを読み込む load_template関数へ引き継がれる。このパラメータ$argsが一連の処理の流れの中で何かに使用される様子はないが、テンプレートパーツからアクセス可能である。
このことを確認のため、標準テーマ「Twenty Twenty」のindex.phpにあるget_header関数のパラメータを追加する
get_header( null, array( 'test' => 'OK' ) );続いてheader.phpに次の行を追加する。
var_dump( $args );ブラウザでトップページにアクセスし、出力されたHTMLソースを確認。index.phpのget_header関数に指定した配列の内容がheader.phpで出力されている。
array(1) {
["test"]=>
string(2) "OK"
}
返り値がfalse
上記の4つの関数はもう1つ変更されている。それは各関数で呼ばれているlocate_template関数の返り値を判定し、その返り値が''（テンプレートパーツのファイルが存在しない）の場合は各関数の返り値としてfalseを返すようになったことである。
if ( ! locate_template( $templates, true, false, $args ) ) {
return false;
}
なおテンプレートパーツのファイルが読み込まれた場合は何も返さない（nullが返る）ので、テンプレートファイルで判定する場合はfalseかどうかの判定となる。
最終更新 : 2020年08月12日 08:26
関連
お勧め
add_shortcode（2018年5月27日 更新）
void add_shortcode( string $tag, mixed $func )
ショートコード（独自タグ）を追加する。ショートコードは、投稿記事内でテキスト内容がない[tag]や、テキストを内包する[tag]テキスト[/tag]の書式で使用できる独自タグのこと。標準の状態では、 the_content関数によって表示する直前のフィルター処理内でパラメータ$funcで指定した関数・メソッドが実行される。
get_user_setting（2022年1月31日 更新）
mixed get_user_setting( string $name [ , string $default = false ] )
ユーザーインターフェイス設定を取得する。
have_posts（2018年5月27日 更新）
bool have_posts( )
次の投稿データが存在するかを調べる。
in_category（2018年5月27日 更新）
bool in_category( mixed $category [ , mixed $post = null ] )
投稿情報が指定したカテゴリーに属しているか調べる。
add_feed（2024年6月24日 更新）
string add_feed( string $feedname, callable $callback )
フィードを追加する。