SWELLのフック一覧と使い方｜アクション・フィルターの基本

add_action( 'swell_after_copyright', function() {
    echo '<div>© 2024 MOTOKI LLC. All Rights Reserved. | <a href="https://example.com/privacy-policy">Privacy Policy</a></div>';
});

add_action( 'swell_inner_main_visual', function() {
    echo '<div class="custom-text">WordPress専門のWeb制作会社です！</div>';
});

add_action( 'swell_before_post_head', function( $post_id ) {
    echo '<div class="custom-text">これは投稿ヘッダーの前のカスタム テキストです。投稿ID: ' . esc_html( $post_id ) . '</div>';
});

add_action( 'swell_before_post_thumb', function( $post_id ) {
    echo '<div class="custom-text">これは投稿のサムネイルの前にあるカスタム テキストです。投稿ID: ' . esc_html( $post_id ) . '</div>';
});

add_filter( 'swell_json_ld', function( $json_lds ) {
    if ( ! is_array( $json_lds ) ||
        ! isset( $json_lds['WebSite'] ) ||
        ! is_array( $json_lds['WebSite'] ) ||
        empty( $json_lds['WebSite'] ) ) {
        return $json_lds;
    }
    $description = get_option( 'blogdescription', '' );
    if ( ! is_string( $description ) ) {
        return $json_lds;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $json_lds['WebSite']['description'] = $description;
    }
    return $json_lds;
} );

add_filter( 'swell_json_ld__article', function( $data, $post_id ) {
    if ( ! is_array( $data ) || empty( $data ) ) {
        return $data;
    }
    $description = get_post_field( 'post_excerpt', $post_id );
    if ( ! is_string( $description ) ) {
        return $data;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $data['description'] = $description;
    }
    return $data;
}, 10, 2 );

add_filter( 'swell_json_ld__author', function( $data, $author_id ) {
    if ( ! is_array( $data ) || empty( $data ) ) {
        return $data;
    }
    $description = get_user_meta( $author_id, 'description', true );
    if ( ! is_string( $description ) ) {
        return $data;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $data['description'] = $description;
    }
    return $data;
}, 10, 2 );

add_filter( 'swell_json_ld__collectionpage', function( $data ) {
    if ( ! is_array( $data ) || empty( $data ) ) {
        return $data;
    }
    $description = ( is_category() || is_tag() || is_tax() ) ? term_description() : '';
    if ( ! is_string( $description ) ) {
        return $data;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $data['description'] = $description;
    }
    return $data;
} );

add_filter( 'swell_json_ld__organization', function( $data ) {
    if ( ! is_array( $data ) || empty( $data ) ) {
        return $data;
    }
    $description = '';
    if ( ! is_string( $description ) ) {
        return $data;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $data['description'] = $description;
    }
    return $data;
} );

add_filter( 'swell_json_ld__webpage', function( $data ) {
    if ( ! is_array( $data ) || empty( $data ) ) {
        return $data;
    }
    $description = is_singular() ? get_post_field( 'post_excerpt', get_queried_object_id() ) : '';
    if ( ! is_string( $description ) ) {
        return $data;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $data['description'] = $description;
    }
    return $data;
} );

add_filter( 'swell_json_ld__website', function( $data ) {
    if ( ! is_array( $data ) || empty( $data ) ) {
        return $data;
    }
    $description = get_option( 'blogdescription', '' );
    if ( ! is_string( $description ) ) {
        return $data;
    }
    $description = trim( wp_strip_all_tags( $description ) );
    if ( $description !== '' ) {
        $data['description'] = $description;
    }
    return $data;
} );

add_filter( 'swell_mv_single_lazy_off', function( $is_lazy_off ) {
    // メインビジュアルの画像の遅延読み込みをオフにする
    $is_lazy_off = true;
    
    return $is_lazy_off;
});

add_filter( 'swell_post_slider_lazy_off', function( $is_lazy_off ) {
    // ポストスライダーの背景画像の遅延読み込みをオフにする
    $is_lazy_off = true;
    
    return $is_lazy_off;
});

add_filter( 'swell_post_thumbnail_lazy_off', '__return_true' );

add_filter( 'swell_term_thumbnail_lazy_off', function( $is_lazy_off ) {
    // 指定したカスタムタクソノミーのタームの場合
    if ( is_tax( 'カスタムタクソノミー', '特定のタームスラッグ' ) ) {
        // 遅延読み込みをオフにする
        $is_lazy_off = true;
    }
    
    return $is_lazy_off;
});

add_filter( 'swell_top_area_lazy_off', function( $value ) {
    // トップエリアの背景画像の遅延読み込みを無効化
    return true;
});

add_filter( 'swell_parts_post_thumbnail', function( $html, $post_id, $is_youtube ) {
    // カスタム投稿タイプ「news」の場合、アイキャッチ画像を非表示にする
    if ( get_post_type( $post_id ) === 'news' ) {
        return '';
    }

    // それ以外の場合は通常通りアイキャッチ画像を表示
    return $html;
}, 10, 3 );

add_filter( 'swell_searchform_placeholder', function( $placeholder ) {
    // プレースホルダーテキストをカスタマイズ
    $placeholder = __( '記事を検索する', 'swell' );

    return $placeholder;
});

add_filter( 'swell_breadcrumb_list_data', function( $list_data ) {
    // 自分のカテゴリーのスラッグへ置き換える。
    if ( ! is_category( '特定のカテゴリースラッグ' ) || ! $list_data ) {
        return $list_data;
    }
    $term = get_queried_object();
    if ( ! $term instanceof WP_Term ) {
        return $list_data;
    }
    // 現在のカテゴリーの表記だけ変更し、階層とURLを維持する。
    $last = array_key_last( $list_data );
    $list_data[ $last ]['name'] = $term->name . 'の案内';
    return $list_data;
} );

add_filter( 'swell_post_list_404_text', function( $text ) {
    // カスタマイズした404メッセージ
    $custom_message = '申し訳ございません。お探しの記事は見つかりませんでした。';

    // フィルターを通してカスタマイズしたメッセージを返す
    return '<p>' . esc_html( $custom_message ) . '</p>';
});

add_filter( 'swell_posts_404_text', function( $text ) {
    return '<p>ご指定の条件に一致する記事はありませんでした。</p>';
});

add_filter( 'swell_related_post_404_text', function( $text ) {
    return '<p>関連記事はありません。</p>';
});

add_filter( 'swell_sns_cta_message', function( $cta_message ) {
    // カスタマイズしたメッセージを返す
    return '<br><i class="icon-thumb_up"></i> 記事を楽しんでいただけたら、シェアしてください！';
});

add_filter( 'swell_parts_catchphrase', function( $catchphrase ) {
    // 追加したいテキスト
    $additional_text = ' - Welcome to Our Site!';

    // キャッチフレーズにテキストを追加
    $catchphrase .= $additional_text;

    return $catchphrase;
} );

add_filter( 'swell_parts_page_title', function( $title_html, $page_id ) {
    // 追加したいテキスト
    $additional_text = ' - Custom Text';

    // タイトルにテキストを追加
    $title_html .= $additional_text;

    return $title_html;
}, 10, 2 );

add_filter( 'swell_parts_term_title', function( $title_html, $term_id ) {
    // 追加したいテキスト
    $additional_text = ' - Custom Text';

    // タイトルにテキストを追加
    $title_html .= $additional_text;

    return $title_html;
}, 10, 2 );

add_filter( 'swell_body_attrs', function( $attrs ) {
    return $attrs . ' data-custom-attr="value"'; // カスタム属性を追加
} );

add_filter( 'swell_content_attrs', function( $attrs ) {
    return $attrs . ' data-custom-attr="value"'; // カスタム属性を追加
} );

add_filter( 'swell_frame_class', function( $frame_class ) {
    // 追加したいクラス名を設定
    $additional_class = 'my-custom-frame-class';

    // クラス名を追加
    $frame_class .= ' ' . $additional_class;

    return $frame_class;
} );

add_filter( 'swell_head_logo', function( $logo_url ) {
    // カスタムロゴURLを指定する
    return 'https://example.com/path/to/custom-logo.png';
} );

add_filter( 'swell_head_logo_sizes', function( $sizes ) {
    // カスタム画像サイズを指定する
    return '(max-width: 600px) 50vw, 300px';
} );

add_filter( 'swell_head_logo_top', function( $logo_top_url ) {
    // カスタムロゴURLを指定する
    return 'https://example.com/path/to/custom-logo-top.png';
} );

add_filter( 'swell_get_sns_cta_data', function( $data ) {
    // Twitterのフォローボタンを非表示にする
    $data['tw_id'] = '';

    // FacebookのいいねボックスのURLを変更する
    $data['fb_url'] = 'https://www.facebook.com/yourpage';

    // InstagramのフォローボタンのIDを変更する
    $data['insta_id'] = 'yourinstagramid';

    return $data;
});

add_filter( 'swell_is_show_comments', '__return_false' );

add_filter( 'swell_is_show_index', function( $is_show ) {
    if ( is_single() && has_category( '特定のカテゴリー', get_the_ID() ) ) {
        return true; // 特定のカテゴリーの投稿ページで目次を表示
    }
    return $is_show; // それ以外のページはデフォルトの設定に従う
} );

add_filter( 'swell_is_show_page_links', '__return_true' );

add_filter( 'swell_is_show_pickup_banner', '__return_true' );

add_filter( 'swell_is_show_sidebar', function( $is_show ) {
    if ( is_archive() ) {
        return true; // アーカイブページでサイドバーを表示
    }
    return $is_show; // それ以外のページはデフォルトの設定に従う
} );

add_filter( 'swell_is_show_toc_ad', function( $is_show ) {
    if ( is_single() ) {
        return true; // 投稿ページで目次広告を表示
    }
    return $is_show; // それ以外のページはデフォルトの設定に従う
} );

add_filter( 'swell_is_show_ttltop', function( $is_show ) {
    if ( is_single() && has_category( '特定のカテゴリー', get_the_ID() ) ) {
        return true; // 特定のカテゴリーの投稿ページでページタイトルを上部に表示
    }
    return $is_show; // それ以外のページはデフォルトの設定に従う
} );

add_filter( 'swell_lp_content_attrs', function( $attrs ) {
    return $attrs . ' data-custom-attr="value"'; // カスタム属性を追加
} );

add_filter( 'swell_parts_head_logo', function( $logo_html, $is_fixbar ) {
    // WordPress 6.2以降。外側のロゴ要素だけにクラスを追加する。
    $processor = new WP_HTML_Tag_Processor( $logo_html );
    if ( $processor->next_tag( array( 'class_name' => 'c-headLogo' ) ) ) {
        $processor->add_class( 'custom-logo-class' );
    }
    return $processor->get_updated_html();
}, 10, 2 );

add_filter( 'swell_parts_scroll_arrow', function( $arrow_html ) {
    // 旧 SWELL_PARTS::get_scroll_arrow() を直接使うテンプレート向け。
    if ( ! class_exists( 'WP_HTML_Tag_Processor' ) ) {
        return $arrow_html;
    }
    $html = new WP_HTML_Tag_Processor( $arrow_html );
    if ( $html->next_tag( [ 'tag_name' => 'BUTTON', 'class_name' => 'p-mainVisual__scroll' ] ) ) {
        $style = rtrim( (string) $html->get_attribute( 'style' ), "; \t\n\r" );
        $html->set_attribute( 'style', $style . ';color:#ff0000;' );
    }
    return $html->get_updated_html();
} );

add_filter( 'swell_post_content_class', function( $class ) {
    // 追加したいクラスを指定
    $additional_class = 'custom-content-class';
    
    // 既存のクラスに追加クラスを追加
    $class .= ' ' . $additional_class;
    
    return $class;
});

add_filter( 'swell_root_attrs', function( $attrs ) {
    return $attrs . ' data-custom-attr="value"'; // カスタム属性を追加
} );

add_filter( 'swell_table_scroll_hint', function( $hint_src ) {
    return '<div class="c-scrollHint"><span>' . esc_html__( '右にスクロール', 'swell' ) . ' <i class="icon-arrow_right"></i></span></div>';
} );

add_filter( 'swell_do_blog_parts', function( $content ) {
    if ( ! is_string( $content ) || $content === '' ) {
        return $content;
    }
    return '<div class="waza-blog-parts">' . $content . '</div>';
} );

add_filter( 'swell_show_term_navigation', function( $show_term_navigation, $taxonomy, $term_id ) {
    // 特定のカテゴリーIDを指定
    $specific_category_id = 123;

    if ( 'category' === $taxonomy && $specific_category_id === $term_id ) {
        return true; // 階層リストを表示
    }

    return false; // それ以外の場合は階層リストを非表示
}, 10, 3 );

add_filter( 'swell_blocks_rss_cache_time', function( $cache_time, $rss_url ) {
    return HOUR_IN_SECONDS; // キャッシュ時間を1時間に設定
}, 10, 2 );

add_filter( 'swell_delay_js_list', function( $delay_js_list ) {
    // 「example.js」というキーワードを追加
    $delay_js_list[] = 'example.js';
    // 「my-script」というキーワードを追加
    $delay_js_list[] = 'my-script';
    return $delay_js_list;
} );

add_filter( 'swell_delay_js_prevent_pages', function( $prevent_pages ) {
    // 「example-page」というURLの一部を持つページを追加
    $prevent_pages[] = 'example-page';
    // 「contact」というURLの一部を持つページを追加
    $prevent_pages[] = 'contact';
    return $prevent_pages;
} );

add_filter( 'swell_hide_fse_blocks', '__return_true' );

add_filter( 'swell_infobar_data', function( $info_data ) {
    // インフォメーションバーのテキストをカスタマイズ
    $info_data['text'] = '新しいお知らせがあります！';

    // インフォメーションバーのURLをカスタマイズ
    $info_data['url'] = 'https://example.com/news';

    return $info_data;
});

add_filter( 'swell_is_separate_css', '__return_false' );

add_filter( 'swell_remove_url_to_card', function( $remove_url_to_card ) {
    if ( is_single() && has_category( '特定のカテゴリー', get_the_ID() ) ) {
        return true; // 特定のカテゴリーの投稿ページでは URL をブログカードに変換しない
    }
    return $remove_url_to_card;
} );

add_filter( 'swell_update_json_name', function( $json_name ) {
    return 'my_update.json'; // JSON ファイルの名前を変更
} );

add_filter( 'swell_get_archive_data', function( $data ) {
    // カスタムタクソノミーアーカイブの場合、タイトルを変更する
    if ( 'tax' === $data['type'] ) {
        $data['title'] = 'カスタムタクソノミー: ' . $data['title'];
    }
    return $data;
} );

add_filter( 'swell_get_search_title', function( $s_title ) {
    // 検索結果ページのタイトルを変更する
    $s_title = 'カスタマイズされた検索結果: ' . $s_title;

    return $s_title;
});

add_filter( 'swell_get_tax_of_post_type', function( $the_tax, $the_post_type ) {
    // カスタム投稿タイプ 'my_custom_post_type' に紐付いたタクソノミー 'my_custom_taxonomy' を取得
    if ( 'my_custom_post_type' === $the_post_type ) {
        return 'my_custom_taxonomy';
    }
    return $the_tax; // それ以外の投稿タイプはデフォルトのタクソノミーを返す
}, 10, 2 );

add_filter( 'swell_get_the_term_links', function( $thelist, $post_id, $tax ) {
    // 追加したいクラス名
    $additional_class = 'custom-class';

    // リンクにクラスを追加
    $thelist = str_replace( 'c-categoryList__link', 'c-categoryList__link ' . $additional_class, $thelist );

    return $thelist;
}, 10, 3 );

add_filter( 'swell_get_the_terms_data', function( $terms_data ) {
    foreach ( $terms_data as &$term_data ) {
        // 例えば、特定のカテゴリー名を変更したい場合
        if ( '旧カテゴリー名' === $term_data['name'] ) {
            $term_data['name'] = '新カテゴリー名';
        }
    }
    return $terms_data;
});

add_filter( 'swell_pager_range', function( $range ) {
    // 左右に表示するページ数の範囲を3に設定
    return 3;
});

add_filter( 'swell_pickup_post_args', function( $query_args ) {
    // カスタム投稿タイプ「my_post_type」の投稿を表示
    $query_args['post_type'] = 'my_post_type';

    // タグID「123」を持つ投稿を除外
    $query_args['tag__not_in'] = [123];

    // 投稿日が過去7日以内の投稿のみ表示
    $query_args['date_query'] = [
        [
            'after' => '7 days ago',
        ],
    ];

    return $query_args;
});

add_filter( 'swell_post_list_cat_data', function( $cat_data, $post_id ) {
    // 自分の対象投稿IDと、表示するカテゴリーIDへ変更します。
    $target_post_id = 123;
    $display_category_id = 456;
    if ( (int) $post_id !== $target_post_id || ! is_array( $cat_data ) ) {
        return $cat_data;
    }
    $category = get_term( $display_category_id, 'category' );
    if ( ! $category || is_wp_error( $category ) ) {
        return $cat_data;
    }
    $cat_data['id'] = $category->term_id;
    $cat_data['name'] = $category->name;
    return $cat_data;
}, 10, 2 );

add_filter( 'swell_post_list_type_on_archive', function( $list_type ) {
    // 著者アーカイブだけカード型にします。
    if ( is_author() ) {
        return 'card';
    }
    return $list_type;
} );

add_filter( 'swell_post_list_type_on_search', function( $list_type ) {
    return 'card';
});

add_filter( 'swell_post_list_type_on_term', function( $list_type, $term_id ) {
    $term = get_term( $term_id );
    if ( ! $term || is_wp_error( $term ) ) {
        return $list_type;
    }
    // 自分のカテゴリーのスラッグへ置き換えます。
    if ( $term->taxonomy === 'category' && $term->slug === 'target-category' ) {
        return 'card';
    }
    return $list_type;
}, 10, 2 );

add_filter( 'swell_related_post_args', function( $args ) {
    // 導入先のフィールド名と値へ変更します。
    $condition = [
        'key'     => 'custom_field_key',
        'value'   => 'custom_value',
        'compare' => '=',
    ];
    // 既存の条件を一つのグループとして残し、追加条件とANDで結びます。
    $existing = $args['meta_query'] ?? [];
    $args['meta_query'] = is_array( $existing ) && $existing
        ? [ 'relation' => 'AND', $existing, $condition ]
        : [ $condition ];
    return $args;
});

add_filter( 'swell_related_post_maxnum', function( $maxnum ) {
    return 5;
});

elseif ( $q->have_posts() ) :

else :

add_filter( 'swell_toc_target', function( $meta ) {
    return 'h3';
} );

add_filter( 'swell_twitter_to_x', function( $value ) {
    // Twitter アイコンを Twitter X アイコンに置き換える
    return true;
});

add_filter( 'swell_code_meta_screens', function( $screens ) {
    return ['post', 'custom_post_type']; // 'post' と 'custom_post_type' にのみメタボックスを表示
} );

add_filter( 'swell_custom_format_sets', function( $custom_format_sets ) {
    $custom_format_sets[] = [
        [
            'type'       => 'loos/bg-color',
            'attributes' => [ 'class' => 'swl-bg-color has-custom-background-color' ],
        ],
        [
            'type'       => 'loos/marker',
            'attributes' => [ 'class' => 'mark_custom' ],
        ],
        [
            'type'       => 'loos/text-color',
            'attributes' => [ 'class' => 'has-custom-color' ],
        ],
        [
            'type'       => 'loos/font-size',
            'attributes' => [ 'class' => 'u-fz-custom' ],
        ],
        [
            'type'      => 'core/bold',
        ],
        [
            'type'      => 'core/italic',
        ],
    ];

    return $custom_format_sets;
} );

add_filter( 'swell_custom_formats', function( $custom_formats ) {
    $custom_formats[] = [
        'name'      => 'loos/custom-format-example',
        'title'     => 'カスタム書式例',
        'tagName'   => 'span',
        'className' => 'custom-format-example',
    ];

    return $custom_formats;
} );

add_filter( 'swell_side_meta_screens', function( $screens ) {
    return ['post', 'custom_post_type']; // 'post' と 'custom_post_type' にのみメタボックスを表示
} );

add_filter( 'swell_term_meta_screens', function( $screens ) {
    $screens[] = 'custom_taxonomy';
    return $screens;
} );