プラグインWPFormsのwpforms_display_submit_spinner_srcフィルタの使用方法・解説

概要

wpforms_display_submit_spinner_src フィルタは、WPForms で送信ボタンのスピナー（ローディングアイコン）の画像ソースをカスタマイズするために使用されます。このフィルタを使用することで、デフォルトのスピナーを独自のデザインに変更したり、特定の条件に応じて画像の表示を制御したりすることが可能です。この機能は特に以下のようなケースでよく利用されます。

独自のロゴやブランドイメージに合ったスピナーを設定したい。
特定のフォームに応じた異なるスピナーを使用したい。
スピナーのサイズやスタイルを変更したい。
スピナーの表示を条件に応じて切り替えたい。
スピナーの非表示や隠す条件を設定したい。
他のプラグインやテーマとの兼ね合いで特殊なスピナーを実装したい。

構文

apply_filters( 'wpforms_display_submit_spinner_src', $src, $form_data );

パラメータ

$src (string) – デフォルトのスピナー画像ソースの URL。
$form_data (array) – 現在のフォームに関するデータ。

戻り値

(string) – フィルタされたスピナー画像ソースの URL。

使用可能バージョン

WPForms バージョン: 1.4.0 以降
WordPress バージョン: 4.0 以降

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

1. 基本的なスピナーのカスタマイズ

add_filter( 'wpforms_display_submit_spinner_src', function( $src ) {
    return 'https://example.com/custom-spinner.gif';
});

このコードは、デフォルトのスピナーをカスタムのスピナー画像に変更します。簡単なカスタマイズを行う際に便利です。

2. フォームごとにスピナーを変更

add_filter( 'wpforms_display_submit_spinner_src', function( $src, $form_data ) {
    if ( $form_data['id'] == 123 ) {
        return 'https://example.com/another-spinner.gif';
    }
    return $src;
}, 10, 2 );

このコードは、フォーム ID が 123 の場合に異なるスピナー画像を表示します。

3. スピナーの条件付き表示

add_filter( 'wpforms_display_submit_spinner_src', function( $src ) {
    if ( is_user_logged_in() ) {
        return 'https://example.com/member-spinner.gif';
    }
    return $src;
});

このコードは、ユーザーがログインしている場合には特定のスピナーを表示します。

4. スピナーの URL を設定する関数

function custom_spinner_url() {
    return 'https://example.com/unique-spinner.gif';
}

add_filter( 'wpforms_display_submit_spinner_src', 'custom_spinner_url' );

このサンプルでは、別の関数を用いてスピナーの URL を取得し、設定しています。

5. スピナーサイズの指定

add_filter( 'wpforms_display_submit_spinner_src', function( $src ) {
    return '<img src="' . esc_url( $src ) . '" width="50" height="50" />';
});

このコードは、スピナーのサイズを指定して表示します。画像の幅と高さを設定している例です。

以上のサンプルコードは、すべて著作権フリーであり、WPForms プラグインのカスタマイズに役立つ実用的な例となっております。

概要

構文