はじめに
Cocoonのフックを使えば、簡単にサイトの表示や機能をカスタマイズできます。
この記事では、Cocoonに用意されているフィルターフックと、アクションフックの使用例について説明します。
WordPress標準の返却値関数
WordPressには便利な標準関数が用意されています（表1参照）。
これを活用すれば、フックの返却値を簡単に設定できます。
| 関数名 | 概要 |
|---|---|
| __return_true | trueを返却します。 |
| __return_false | falseを返却します。 |
| __return_zero | 0を返却します。 |
| __return_empty_array | 空の配列を返却 |
| __return_null | nullを返却します。 |
| __return_empty_string | 空文字列を返却 |
Cocoonフィルターフック
カテゴリーラベルの表示を制御
カテゴリーラベルの表示をカスタマイズできます（表2参照）。
以下のコードを使用します。
add_filter('is_carousel_entry_card_category_label_visible', '__return_true');| 項目 | フック | 初期値 | ||
|---|---|---|---|---|
| 全てのカテゴリーラベル | is_category_label_visible | |||
| 投稿・固定ページのアイキャッチラベル | is_eyecatch_category_label_visible | Cocoon設定 | ||
| 投稿の関連記事カード | is_related_entry_card_category_label_visible | true | ||
| インデックスページのエントリーカード | is_entry_card_category_label_visible | true | ||
| カルーセル | is_carousel_entry_card_category_label_visible | true | ||
| 全て | is_widget_entry_card_category_label_visible | |||
| 新着記事 | is_new_entry_card_category_label_visible | false | ||
| 人気記事 | is_popular_entry_card_category_label_visible | false | ||
| 関連記事 | is_widget_related_entry_card_category_label_visible | false | ||
エントリーカードのPV表示を制御
以下のフィルターを使用することで、閲覧ユーザーにもPV数を表示できます。
以下のコードを使用します。
add_filter('public_page_entry_card_pv_visible', '__return_true');テキストを変更
タブ一覧、カテゴリーごとの「新着記事」のテキストを変更
以下のコードを使用します。
add_filter('new_entries_caption', function ($text) {
return $text;
});「もっと見る」ボタンのテキストを変更
以下のコードを使用します。
add_filter('more_button_caption', function ($text) {
return $text;
});「次へ」ボタンのテキストを変更
以下のコードを使用します。
add_filter('pagination_next_link_caption', function ($text) {
return $text;
});パンくず「ホーム」のテキストを変更
以下のコードを使用します。
add_filter('breadcrumbs_page_root_text', function ($text) {
return $text;
});通知エリア
通知エリアの表示を制御
以下のコードを使用します。
add_filter('notice_area_visible', '__return_true');通知エリアメッセージを変更
以下のコードを使用します。
add_filter('get_notice_area_message', function ($msg) {
return $masg;
});通知エリアURLを変更
以下のコードを使用します。
add_filter('get_notice_area_url', function ($url) {
return $url;
});Cocoonアクションフック
カード
エントリーカードに情報追加
エントリーカードのスニペットの後ろ（日付の前）に情報を追加します。
以下のコードを使用します。
add_action('entry_card_snippet_after', function ($post_id) {
// 出力処理
});| 引数 | 説明 |
|---|---|
| post_id | 投稿ID |
投稿ページ下の関連記事に情報を追加
投稿ページ下の関連記事にのスニペットの後ろ（日付の前）に情報を追加します。
以下のコードを使用します。
add_action('related_entry_card_snippet_after', function ($post_id) {
// 出力処理
});| 引数 | 説明 |
|---|---|
| post_id | 投稿ID |
ウィジェットに情報を追加
「新着記事」「人気記事」「関連記事」ウィジェットの日付の前（タイトルの後ろ）に情報を追加します。
以下のコードを使用します。
add_action('widget_entry_card_date_before', function ($prefix, $post_id) {
// 出力処理
}, 10, 2);| 引数 | 説明 |
|---|---|
| prefix |
|
| post_id | 投稿ID |
新着情報に情報を追加
「新着情報」ウィジェットのウィジェットの日付の前（タイトルの後ろ）に情報を追加します。
以下のコードを使用します。
add_action('info_list_item_meta_before', function () {
// 出力処理
});ヘッダー
ヘッダーロゴの前に情報を追加
ヘッダーロゴの前に情報を追加します。
以下のコードを使用します。
add_action('wp_header_logo_before_open', function () {
// 出力処理
});ヘッダーロゴの後ろに情報を追加
ヘッダーロゴの後ろ情報を追加します。
以下のコードを使用します。
add_action('wp_header_logo_after_open', function () {
// 出力処理
});アピールエリア
アピールメッセージの前に情報を追加
アピールメッセージの前に情報を追加します。
以下のコードを使用します。
add_action('appeal_area_before', function () {
// 出力処理
});アピールメッセージの後に情報を追加
アピールメッセージの後に情報を追加します。
以下のコードを使用します。
add_action('appeal_area_after', function () {
// 出力処理
});参考：テンプレートフック
Cocoonには、Arkheと同様に便利なテンプレートフックが用意されています。
これにより、親テーマのテンプレートファイルを子テーマにコピーして直接編集する必要はなく、フックを活用するだけで簡単にカスタマイズできます。
さいごに
今回紹介した方法を使えば、Cocoonのフックを活用してサイトの表示や機能を柔軟にカスタマイズできます。
これらを適切に活用し、より魅力的なサイトを構築してください。
