get_search_form

(2.7.0以降)
get_search_form - 検索フォームを読み込む

説明

void get_search_form( [ bool $echo = true ] )
サイト内検索フォームのテンプレートファイルを読み込んで表示する。

パラメータ

  • $echo
    [3.0.0]表示する場合はtrue、内容を取得する場合はfalseを指定(省略時はtrue)

返り値

パラメータ$echoがfalseの場合は検索フォームのHTMLを返す。パラメータ$echoがtrueの場合は返り値はありません。

注意

テーマ内の検索フォームテンプレートファイルsearchform.phpが存在しない場合は、WordPress標準の検索フォームが表示される。

使用例

  • テーマ内の検索フォームテンプレートファイルsearchform.phpを読み込む。
    <?php get_search_form( ); ?>

フィルター

[3.6.0]'search_form_format'フィルターを呼び出す。パラメータ$formatはHTMLフォーマットの内容として'html5'または'xhtml'が格納されている。
$format = apply_filters( 'search_form_format', $format );
[2.7.0]表示または値を返す直前に'get_search_form'フィルターを呼び出す。パラメータ$formには検索フォームのHTMLが格納されている。
$result = apply_filters( 'get_search_form', $form );

アクション

[3.6.0]はじめにpre_get_search_formアクションを呼び出す。
do_action( 'pre_get_search_form' );

ソースファイル

/wp-includes/general-template.php

関連

お勧めコンテンツ

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 登録)

投稿記事ごとに設定されているカスタムフィールドの値はget_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2017年9月26日 登録)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 登録)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

プラグインのロード順を制御する(2014年6月9日 登録)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

親子の固定ページで同じテンプレートを使う(2013年3月20日 登録)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

最終更新日時 : 2016-08-30 11:03