get_search_form()

WordPressのget_search_form()関数は、検索フォームを取得するために使用されます。この関数は、テーマ内で検索フォームを表示する際に便利です。

構文

get_search_form( bool $echo = true );

• $echo(bool) — フォームを表示するかどうかを指定します。デフォルトはtrueで、フォームを表示します。falseに設定すると、フォームを返すだけで表示しません。

例1: 検索フォームを表示する

基本的な使い方で、検索フォームを表示します。

<?php get_search_form(); ?>

例2: 検索フォームを返すだけで表示しない

フォームを表示せずに、HTMLを返すだけの例です。

<?php $search_form = get_search_form( false ); echo $search_form; ?>

例3: カスタム検索フォームテンプレートを使用する

カスタムの検索フォームテンプレートを使用する例です。searchform.phpファイルを作成し、その中にカスタムHTMLを記述します。

<?php get_search_form(); ?>

例4: 検索フォームにクラスを追加する

検索フォームにカスタムクラスを追加する例です。

<?php add_filter( 'get_search_form', 'custom_search_form' ); function custom_search_form( $form ) { return str_replace( 'search-form', 'search-form custom-class', $form ); } get_search_form(); ?>

例5: 検索フォームのプレースホルダーテキストを変更する

検索フォームのプレースホルダーテキストを変更する例です。

<?php add_filter( 'get_search_form', 'modify_search_placeholder' ); function modify_search_placeholder( $form ) { return str_replace( '検索', 'サイト内検索', $form ); } get_search_form(); ?>

注意点

• カスタム検索フォームを使用する場合、searchform.phpファイルをテーマディレクトリに作成する必要があります。
• get_search_form()は、デフォルトでフォームを表示しますが、$echoをfalseに設定することで、フォームのHTMLを返すだけにすることができます。