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

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

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

今回はyoutube埋込高速化処理実施有無の制御ができる
cocoon_youtube_speed_up_enable
です。

フックの概要

フックの発火条件

このフックは、ライフサイクルの初期段階で１回必ず発火します。

内部的には、YouTube関連の処理（youtube.php）を読み込むかどうかを判定するために利用されています。

使いどころ

こちらの公式サイトに記載されている通り、デフォルトでは無効化されているyoutube高速化機能を有効化できます。

あえて本機能を有効化する理由がよく分かりません。

他のプラグインとの競合なども考えられるため、内容を十分に理解して影響度を把握してから有効化するようにした方が良いでしょう。

私にはこの機能を有効化することによる影響度は把握できていません。

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

if (apply_filters('cocoon_youtube_speed_up_enable', false)) {
  require_once abspath(__FILE__).'youtube.php'; //YouTube関係の処理
}

引数

$ccocoon_youtube_speed_up_enable：(boolean)
talse：無効化する（デフォルト）
true：有効化する

カスタマイズコード例

function customize_cocoon_youtube_speed_up_enable( $cocoon_youtube_speed_up_enable ) {

	return true;

}
add_filter( 'cocoon_youtube_speed_up_enable', 'customize_cocoon_youtube_speed_up_enable' );

注意点

・高速化機能は環境によって効果が異なります。

・他のYouTube関連、高速化関連プラグインと併用する場合は、競合や表示崩れに注意してください。

・実運用前にテスト環境での検証がおすすめです。

まとめ

・cocoon_youtube_speed_up_enable は、YouTube埋め込みの高速化処理を制御するフィルターフック。

・デフォルトは無効化されており、true を返すことで有効化できる。

・競合や効果を確認しながら慎重に導入することをお勧めします。