Skip to content

Filter hooks

K-Mix39 edited this page Nov 19, 2019 · 22 revisions

注意

バージョン0.6.0以降、バージョン0.5.0以下のフックを廃止しています。

Filter hooks 目次

検索条件拡張用Hook

検索フォーム用Hook

検索結果ページ用Hook

Filter hooks リファレンス

not_wiz_search_criteria_is_use_custom

0.11.0より対応

/**
 * 検索条件にカスタムフィールド設定を使用するか
 * 
 * @param $is_use カスタムフィールド設定を使用するかのフラグ
 * @return $is_use 使用する場合、true | 使用しない場合、false(デフォルト)
 */
add_filter(
	'not_wiz_search_criteria_is_use_custom',
	function( $is_use ) {
		return $is_use;
	}
);

MEMO: Snow Monkey Members Postに対応させる場合、trueにする必要があります。

not_wiz_search_criteria_form_display

/**
 * 検索フォームの該当項目を表示するかを設定
 * 
 * @param $is_display 該当項目の表示フラグ
 * @param $name 該当項目のクエリ名
 * @return $is_display 該当項目を表示する場合、true | 表示しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_form_display',
	function( $is_display, $name ) {
		return $is_display;
	},
	10,
	2
);

not_wiz_search_criteria_form_render

/**
 * 検索フォームの該当項目の表示方法を設定
 *
 * @param $slug 表示方法のslug
 * @param $name 該当項目のクエリ名
 * @return $slug セレクトボックスの場合、'select' | ラジオボタンの場合、'radio'
 */
add_filter(
	'not_wiz_search_criteria_form_render',
	function( $slug, $name ) {
		return $slug;
	},
	10,
	2
);

not_wiz_search_criteria_form_label

/**
 * 検索フォームの該当項目のラベル文字列を設定
 * 
 * @param $label ラベル文字列
 * @param $name 該当項目のクエリ名
 * @return $label ラベル文字列
 */
add_filter(
	'not_wiz_search_criteria_form_label',
	function( $label, $name ) {
		return $label;
	},
	10,
	2
);

not_wiz_search_criteria_form_text

/**
 * 検索フォームの該当項目の項目値テキストを設定
 * 
 * @param $text 該当項目値テキスト
 * @param $name 該当項目のクエリ名
 * @param $value 該当項目の値
 * @return $text 該当項目値テキスト
 */
add_filter(
	'not_wiz_search_criteria_form_text',
	function( $text, $name, $value ) {
		return $text;
	},
	10,
	3
);

not_wiz_search_criteria_form_options

/**
 * 検索フォームの該当項目のオプション配列を設定
 * 
 * @param $option_data オプション配列
 * @param $name 該当項目のクエリ名
 * @return $option_data オプション配列
 */
add_filter(
	'not_wiz_search_criteria_form_options',
	function( $option_data, $name ) {
		return $option_data;
	},
	10,
	2
);

not_wiz_search_criteria_form_display_taxonomy

/**
 * 検索フォームの該当タクソノミーを表示するかを設定
 * 
 * @param $is_display 表示フラグ
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当タクソノミーの名前
 * @return $is_display 表示フラグ 表示する場合、true | 表示しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_form_display_taxonomy',
	function( $is_display, $post_type, $taxonomy_name ) {
		return $is_display;
	},
	10,
	3
);

not_wiz_search_criteria_form_label_taxonomy

/**
 * 検索フォームの該当タクソノミーのラベル文字列を設定
 * 
 * @param $label ラベル文字列
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当タクソノミーの名前
 * @return $label ラベル文字列
 */
add_filter(
	'not_wiz_search_criteria_form_label_taxonomy',
	function( $label, $post_type, $taxonomy_name ) {
		return $label;
	},
	10,
	3
);

not_wiz_search_criteria_form_text_taxonomy

/**
 * 検索フォームの該当タクソノミーの項目値テキストを設定
 * 
 * @param $text 項目値テキスト
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当タクソノミーの名前
 * @param $value タクソノミーの項目値
 * @return $text 項目値テキスト
 */
add_filter(
	'not_wiz_search_criteria_form_text_taxonomy',
	function( $text, $post_type, $taxonomy_name, $value ) {
		return $text;
	},
	10,
	4
);

not_wiz_search_criteria_form_options_taxonomy

/**
 * 検索フォームの該当タクソノミーのオプション配列を設定
 * 
 * @param $option_data オプション配列
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当タクソノミーの名前
 * @return $option_data オプション配列
 */
add_filter(
	'not_wiz_search_criteria_form_options_taxonomy',
	function( $option_data, $post_type, $taxonomy_name ) {
		return $option_data;
	},
	10,
	3
);

not_wiz_search_criteria_form_change

/**
 * 検索フォームのエリア外要素を変更
 * 
 * @param $is_change 変更フラグ
 * @param $name 変更する項目
 * @return $is_change 変更する場合、true | 変更しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_form_change',
	function( $is_change, $name ) {
		return $is_change;
	},
	10,
	2
);

not_wiz_search_criteria_results_change

/**
 * 検索結果ページの結果エリア外要素を変更
 * 
 * @param $is_change 変更フラグ
 * @param $name 変更する項目
 * @return $is_change 変更する場合、true | 変更しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_results_change',
	function( $is_change, $name ) {
		return $is_change;
	},
	10,
	2
);

not_wiz_search_criteria_results_display_parts

/**
 * 検索結果ページの結果エリアパーツを表示するかを設定
 * 
 * @param $is_display 表示フラグ
 * @param $name エリア名
 * @param $parts_name パーツ値
 * @return $is_display 表示する場合、true | 表示しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_results_display_parts',
	function( $is_display, $name, $parts_name ) {
		return $is_display;
	},
	10,
	3
);

not_wiz_search_criteria_results_label_parts

/**
 * 検索結果ページの結果エリアパーツのラベル文字列を設定
 * 
 * @param $label ラベル文字列
 * @param $name エリア名
 * @param $parts_name パーツ値
 * @param $vars ラベル文字列の為の値配列
 * @return $label ラベル文字列
*/
add_filter(
	'not_wiz_search_criteria_results_label_parts',
	function( $label, $name, $parts_name, $vars ) {
		return $label;
	},
	10,
	4
);

not_wiz_search_criteria_results_display_results

/**
 * 検索結果ページの検索条件エリアを表示するかを設定
 * 
 * @param $is_display 表示フラグ
 * @return $is_display 表示する場合、true | 表示しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_results_display_results',
	function( $is_display ) {
		return $is_display;
	},
	10,
	1
);

not_wiz_search_criteria_results_display

/**
 * 検索結果ページの該当検索条件項目を表示するかを設定
 * 
 * @param $is_display 表示フラグ
 * @param $name 項目のクエリ名
 * @return $is_display 表示する場合、true | 表示しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_results_display',
	function( $is_display, $name ) {
		return $is_display;
	},
	10,
	2
);

not_wiz_search_criteria_results_label

検索結果ページの該当検索条件項目のラベル文字列を設定

/**
 * 検索フォームの該当項目のラベル文字列を設定
 * 
 * @param $label ラベル文字列
 * @param $name 該当項目のクエリ名
 * @return $label ラベル文字列
 */
add_filter(
	'not_wiz_search_criteria_results_label',
	function( $label, $name ) {
		return $label;
	},
	10,
	2
);

not_wiz_search_criteria_results_text

/**
 * 検索結果ページの該当検索条件項目の項目値テキストを設定
 * 
 * @param $text 該当検索条件項目の項目値テキスト
 * @param $name 該当項目のクエリ名
 * @param $value 該当項目の値
 * @return $text  該当検索条件項目の項目値テキスト
 */
add_filter(
	'not_wiz_search_criteria_results_text',
	function( $text, $name, $value ) {
		return $text;
	},
	10,
	3
);

not_wiz_search_criteria_results_options

/**
 * 検索結果ページの該当検索条件項目のオプション配列を設定
 * 
 * @param $option_data 該当検索条件項目のオプション配列
 * @param $name 該当検索条件項目のクエリ名
 * @return $option_data 該当検索条件項目のオプション配列
 */
add_filter(
	'not_wiz_search_criteria_results_options',
	function( $option_data, $name ) {
		return $option_data;
	},
	10,
	2
);

not_wiz_search_criteria_results_display_taxonomy

/**
 * 検索結果ページの該当検索条件項目タクソノミーを表示するかを設定
 * 
 * @param $is_display 表示フラグ
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当検索条件項目タクソノミーの名前
 * @return $is_display 表示フラグ 表示する場合、true | 表示しない場合、false
 */
add_filter(
	'not_wiz_search_criteria_results_display_taxonomy',
	function( $is_display, $post_type, $taxonomy_name ) {
		return $is_display;
	},
	10,
	3
);

not_wiz_search_criteria_results_label_taxonomy

/**
 * 検索結果ページの該当検索条件項目タクソノミーのラベル文字列を設定
 * 
 * @param $label ラベル文字列
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当検索条件項目タクソノミーの名前
 * @return $label ラベル文字列
 */
add_filter(
	'not_wiz_search_criteria_results_label_taxonomy',
	function( $label, $post_type, $taxonomy_name ) {
		return $label;
	},
	10,
	3
);

not_wiz_search_criteria_results_text_taxonomy

/**
 * 検索結果ページの該当検索条件項目タクソノミーの項目値テキストを設定
 * 
 * @param $text 項目値テキスト
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当タクソノミーの名前
 * @param $value タクソノミーの項目値
 * @return $text 項目値テキスト
 */
add_filter(
	'not_wiz_search_criteria_results_text_taxonomy',
	function( $text, $post_type, $taxonomy_name, $value ) {
		return $text;
	},
	10,
	4
);

not_wiz_search_criteria_results_options_taxonomy

/**
 * 検索結果ページの該当検索条件項目タクソノミーのオプション配列を設定
 * 
 * @param $option_data オプション配列
 * @param $post_type 該当の投稿タイプの値
 * @param $taxonomy_name 該当検索条件項目タクソノミーの名前
 * @return $option_data オプション配列
 */
add_filter(
	'not_wiz_search_criteria_results_options_taxonomy',
	function( $option_data, $post_type, $taxonomy_name ) {
		return $option_data;
	},
	10,
	3
);

not_wiz_search_criteria_results_meta

/**
 * 検索結果ページの追加メタ項目の設定
 * 
 * @param $metas 追加メタ項目配列
 * @param $position 追加される位置。 前の部分: 'before' | 後の部分: 'after'
 * @return $option_data 追加メタ項目配列
 */
add_filter(
	'not_wiz_search_criteria_results_options_taxonomy',
	function( $metas, $position ) {
		// 前の部分にリンクを追加
		if ( 'before' === $positon ) {
			$metas['link'] = '<a href="">リンク</a>';
		}
		return $metas;
	},
	10,
	2
);
Clone this wiki locally
You can’t perform that action at this time.