フックリファレンス

フィルターフック

unitone_block_pattern_categories

/**
 * ブロックカテゴリーをフィルタリングする。
 *
 * @param array $block_pattern_categories カテゴリー情報の配列
 *   @var string $label カテゴリーのラベル
 * @return array
 */
add_filter(
	'unitone_block_pattern_categories',
	function ( $block_pattern_categories ) {
		return $block_pattern_categories;
	}
);

unitone_oembed_blog_card_cache_directory

/**
 * ブログカードのキャッシュを保存するディレクトリを変更する。
 *
 * @param string $directory ブログカードのキャッシュを保存するディレクトリのパス
 * @return string
 */
add_filter(
	'unitone_oembed_blog_card_cache_directory',
	function ( $directory ) {
		return $directory;
	}
);

unitone_oembed_blog_card_loading_template

/**
 * ブログカードのローディング用テンプレートを変更する。
 *
 * @param string $template ローディング用テンプレートの HTML
 * @param string $url ブログカードの URL
 * @return string
 */
add_filter(
	'unitone_oembed_blog_card_loading_template',
	function ( $template, $url ) {
		return $template;
	},
	10,
	2
);

unitone_oembed_blog_card_url_template

/**
 * ブログカードの URL 用テンプレートを変更する。
 * ※ブログカードに表示するデータが取得できなかったときに URL だけが表示されるテンプレート。
 *
 * @param string $template URL 用テンプレートの HTML
 * @param string $url ブログカードの URL
 * @return string
 */
add_filter(
	'unitone_oembed_blog_card_url_template',
	function ( $template, $url ) {
		return $template;
	},
	10,
	2
);

unitone_oembed_blog_card_template

/**
 * ブログカードのテンプレートを変更する。
 *
 * @param string $template テンプレートの HTML
 * @param array $cache ブログカードの生成に使用するデータの配列
 * @return string
 */
add_filter(
	'unitone_oembed_blog_card_template',
	function ( $template, $cache ) {
		return $template;
	},
	10,
	2
);

unitone_oembed_blog_card_block_editor_template

/**
 * ブログカードのエディター用テンプレートを変更する。
 * 
 * @param string $template エディター用テンプレートの HTML
 * @param string $url ブログカードの URL
 * @return string
 */
add_filter(
	'unitone_oembed_blog_card_block_editor_template',
	function ( $template, $url ) {
		return $template;
	},
	10,
	2
);

unitone_block_types_allowed_to_add_block_list_data

/**
 * フロントで data-unitone-block-list 属性を追加するブロックタイプをフィルタリングする。
 * ※エディター上では .block-editor-block-list__layout、.block-editor-block-list__block に position: relative がつく。
 * ※フロントはそうではないため、data-unitone-block-list=layout、data-unitone-block-list=block を追加することで position: relative にする。
 *
 * @param boolean $result 追加する場合は true を返す
 * @param string $block_name ブロックタイプの名前
 * @return boolean
 */
add_filter(
	'unitone_block_types_allowed_to_add_block_list_data',
	function ( $result, $block_name ) {
		return $result;
	},
	10,
	2
);

unitone_is_outer_block_link

/**
 * ブロックリンク(ブロック全体をリンク化したもの)を a 要素でラップする形に変更する。
 * ※デフォルトは JavaScript を使い、ブロック内の a 要素を擬似的にクリックさせている。
 * ※true を返すと、a 要素でラップされるようになり、ブロック内の全てのリンクは span 化される。
 *
 * @param boolean $result ブロックリンクを a 要素でラップする形にする場合は true
 * @param string $block_content ブロックの HTML
 * @param array $block ブロッグの情報
 * @return boolean
 */
add_filter(
	'unitone_is_outer_block_link',
	function ( $result, $block_content, $block ) {
		return $result;
	},
	10,
	3
);

unitone_breadcrumbs

/**
 * パンくずをフィルタリングする。
 *
 * @param array $breadcrumbs パンくず情報の配列
 *   @var string $title タイトル
 *   @var string $link URL
 * @return array
 */
add_filter(
	'unitone_breadcrumbs',
	function ( $breadcrumbs ) {
		return $breadcrumbs;
	}
);

unitone_child_pages_args

/**
 * 子ページの一覧ブロックのクエリーを変更する。
 *
 * @param array $args WP_Query で使用する引数
 * @return array
 */
add_filter(
	'unitone_child_pages_args',
	function ( $args ) {
		return $args;
	}
);

unitone_child_pages

/**
 * 子ページの一覧ブロックの出力 HTML を変更する。
 *
 * @param string $html HTML
 * @param WP_Query $the_query WP_Query オブジェクト
 * @param array $attributes ブロックの属性値の配列
 * @return string
 */
add_filter(
	'unitone_child_pages',
	function ( $html, $the_query, $attributes ) {
		return $html;
	},
	10,
	3
);
目次

マニュアル