cocoonフック調査～cocoon_custom_text_countの使い方と活用例

タナビーの高梨です。

WordPressのテーマ「Cocoon」には、テーマ改変なしでデザインや動作を拡張できる豊富なアクション・フィルターフックが用意されています。

分かる範囲で内容を調査したのでブログにまとめていこうと思います。

今回はカスタムテキストの数を変更できる
cocoon_custom_text_count
です。

フックの概要

フックの発火条件

このフックは、ブロックエディタを起動したタイミングで無条件に1回発火します。

使いどころ

Cocoonには、「カスタムテキストスタイル」という便利な機能があります。

段落ブロックや見出しブロックなどで、よく使う文字装飾（色・サイズ・太さなど）をプリセット化して、クリック1つで再利用できるようにする仕組みです。

例：

・「注目」スタイル：紫色 + 大きめフォントサイズ
・「注意」スタイル：赤色 + ボールド + 下線

例えば、文字の色を紫色にして文字サイズを大きくする、といったことがクリック１つでできるようになります。

詳しくはいろんな情報がネットに載っていますので、それらの記事を参照してください。

ただし、このカスタムスタイルの同時登録数はデフォルトで2つまでに制限されています。

本フックを使えば、この上限を変更することができます。

例えば設定を５つに変えることによって、下図のように選択できるスタイルを５つに増やすことができます。

apply_filters呼び出し元のソースコード

'customTextCount' => apply_filters( 'cocoon_custom_text_count', 2)

ここで初期値（2）がフィルターに渡され、必要に応じて変更可能となっています。

引数

$count：（number）カスタムテキストの数（デフォルト２）

カスタマイズコード例

以下のコードを functions.php などに追加することで、最大10個まで登録できるようになります。

add_filter('cocoon_custom_text_count', function ($count){
  $count = 10;
  return $count;
});
// 公式HPより引用（https://wp-cocoon.com/custom-css-text-styling/)

注意点

数を増やすだけでは機能しません。各スタイルに対応するCSSクラスの定義が別途必要です。

スタイルの定義については、Cocoon公式の以下のページが詳しいです：
https://wp-cocoon.com/custom-css-text-styling/

まとめ

cocoon_custom_text_count は、Cocoonのカスタムテキストスタイルの登録数を制御できるフィルターです。

Cocoonの柔軟なスタイル機能を活用して、記事作成の効率化やデザインの一貫性確保に役立てましょう。