概要
display_header_textフィルタは、WordPressのテーマでヘッダーに表示されるテキストを制御するために使用されます。このフィルタを利用することで、開発者はヘッダーのテキストを動的に変更することが可能になります。以下に、このフィルタがよく使われる機能をいくつか挙げます。
- ヘッダーに表示するサイト名の変更
- カスタムメッセージの追加
- ヘッダーのテキストを条件に応じて表示しない
- 多言語対応のためのテキスト変更
- プラグインによるテキストの動的操作
- カスタムデザインに合わせたテキスト調整
- メンテナンスモード時の特別なメッセージ表示
- 特定のユーザーのみに表示されるメッセージの追加
構文
add_filter('display_header_text', 'your_function_name');
パラメータ
display_header_text（bool）: ヘッダーのテキストが表示されるかどうかを示す真偽値。
戻り値
- 真偽値（bool）: ヘッダーのテキストを表示する場合は
trueを、表示しない場合はfalseを返す。
関連する関数
使用可能なバージョン
このフィルタは、WordPressの初期バージョンから利用可能です。特に非推奨や削除の記録はありません。
コアファイルのパス
/wp-includes/general-template.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | 〇 |
| wp_head | 〇 |
サンプルコード
サンプル1: ヘッダーのテキストをカスタマイズ
add_filter('display_header_text', function($show) {
return true; // ヘッダーのテキストを表示
});
このコードは、ヘッダーのテキストを表示するように設定します。デフォルトでテキスト表示がオフになっている場合でも、常に表示されるようになります。
サンプル2: ヘッダーのテキストを条件に応じて変更
add_filter('display_header_text', function($show) {
if(is_home()) {
return true; // ホームページではテキストを表示
}
return false; // その他のページでは表示しない
});
このコードは、ホームページにいる場合のみヘッダーのテキストを表示します。それ以外のページでは表示されません。
サンプル3: ヘッダーに特定のテキストを追加
add_filter('display_header_text', function($text) {
return 'My Custom Header Text'; // カスタムテキストに変更
});
この例では、ヘッダーに特定のカスタムテキストを追加し、元のテキストを上書きします。
サンプル4: 多言語対応
add_filter('display_header_text', function($text) {
if(function_exists('pll_current_language')){
$lang = pll_current_language();
return ($lang == 'en') ? 'Welcome' : 'ようこそ'; // 言語に応じてテキストを変更
}
return $text;
});
このコードは、多言語プラグインを使用して、現在の言語に応じたテキストをヘッダーに表示します。
サンプル5: メンテナンスモード用のカスタムメッセージ
add_filter('display_header_text', function($show) {
if(is_maintenance_mode()) {
return 'メンテナンス中です。しばらくお待ちください。'; // メンテナンス中のメッセージ
}
return $show;
});
このコードは、サイトがメンテナンスモードの場合に特定のメッセージを表示します。メンテナンスが行われていないときは、デフォルトの表示状態を保ちます。