SWELL│設定されているフックまとめ

2022 4/11

2022-04-11

すいみん

SWELLでカスタマイズをするときに欠かせないのがアクションフック・フィルターフックです。

開発者が事前に、指定箇所が変更ができるようにフックをたくさん仕込んでおり、それを利用して上書きしてSWELLをカスタマイズできます。

WordPressのカスタマイズでよく使うので、一度SWELLのフックを全て洗い出してみました。

基本的なアクションフック・フィルターフックの書き方

先に簡潔にアクションフック・フィルターフックについて説明します。

詳細は検索してみてください。

まず下記の場所にアクションフックまたはフィルターフックを記載したPHPのコードを記載します。

WordPressの管理画面＞外観＞テーマファイルエディター＞ functions.php

アクションフック例

function motoki_example1(){
    echo '<!-- テスト！ -->';
}
add_action( 'wp_head', 'motoki_example1',999 );

フィルターフック例

function motoki_example2($tmp){
    $tmp = echo '<!-- テスト！ -->';
    return $tmp;
}
add_filter( 'wp_head', 'motoki_example2',999 );

アクションフックとフィルターフック違いとして実行するタイミングが違うという点があります。

そしてフィルターフックには値を受け渡しできるという利点もあります。

⇧ 目次へ戻る

SWELLのフックの調べ方

SWELLのフックを調べるのは簡単です。

String Locatorというプラグインを使って、テーマ内のコードを検索します。

正規表現も使うことができるので非常に便利なのでおすすめです。

今回は、正規表現/apply_filters…swell_/で検索をかけてSWELL用に仕込まれているフックをすべて洗い出してみました。

以下、検索で洗い出したSWELLのフックをまとめています。

⇧ 目次へ戻る

Utility周りのフックまとめ

Utilityフォルダ以下にあるフックをまとめました。

swell_frame_class

swell/classes/Utility/Get.php

ベースのフレーム周りのフック

swell_json_ld_data

swell/classes/Utility/Get.php

JSON-LD 生成周りのフック

swell_get_the_terms_data

swell/classes/Utility/Get.php

投稿のタームデータ周りのフック

swell_get_sns_cta_data

swell/classes/Utility/Get.php

SNS CTAのデータ周りのフック

swell_get_sns_cta_data

swell/classes/Utility/Get.php

検索結果ページのタイトル周りのフック

swell_get_search_terms_status

swell/classes/Utility/Get.php

絞り込み検索の結果タイトル周りのフック（予定）

swell_update_json_name

swell/classes/Utility/Others.php

アップデートjsonパス取得周りのフック

swell_do_blog_parts

swell/classes/Utility/Parts.php

ブログパーツの出力処理周りのフック

swell_is_show_ttltop

swell/classes/Utility/Status.php

ページタイトルをコンテンツ上部に表示するかのフック

swell_do_blog_parts

swell/classes/Utility/Status.php

目次機能を使うかどうかのフック

swell_is_show_toc_ad

swell/classes/Utility/Status.php

目次広告を表示するかどうかのフック

swell_is_show_sidebar

swell/classes/Utility/Status.php

各ページでサイドバーを使用するかどうかのフック

あわせて読みたい

SWELL│特定の条件でサイドバーを非表示にするカスタマイズ SWELLでモバイルファーストを意識してサイドバーを非表示にしたいことがあります。できればすでに表示されてから非表示にするCSSからではなく、元のテンプレートの設定…

swell_meta_show_comments

swell/classes/Utility/Status.php

コメントを使用するかどうかのフック

swell_is_show_pickup_banner

swell/classes/Utility/Status.php

ピックアップバナーを使用するかどうかのフック

swell_is_show_page_links

swell/classes/Utility/Status.php

投稿ページの前の記事・次の記事リンクを使用するかどうかのフック

swell_is_separate_css

swell/classes/Utility/Status.php

必要なCSSだけを読み込むかどうかのフック

swell_root_attrs

swell/classes/Utility/Attrs.php

HTMLタグに付与する属性値周りのフック

swell_body_attrs

swell/classes/Utility/Attrs.php

body_wrap に付与する属性値周りのフック

swell_content_attrs

swell/classes/Utility/Attrs.php

content に付与する属性値周りのフック

swell_lp_content_attrs

swell/classes/Utility/Attrs.php

#lp-content に付与する属性値周りのフック

swell_top_area_lazy_off

swell/parts/top_title_area.php

タイトル位置がコンテンツ上設定時のフック。

背景画像のLazyloadのON/OFFができる

⇧ 目次へ戻る