simpay_recurring_description_format

タイプ: フィルター | 以降: 4.17.1

説明

simpay_recurring_description_format フィルターを使用すると、特定の支払いフォームで使用される分割払い説明のフォーマットキーをプログラムで上書きできます。このフィルターは、グローバル設定とフォームごとの設定が解決された後に実行されるため、適用されるフォーマットを最終的に制御できます。

引数

1. $format_key (string) — 解決されたフォーマットキー。以下のいずれか:
   • count_adj_amount — 「月々12回の支払い $24」 (デフォルト)
   • amount_per — 「月あたり $24、12回の支払い」
   • amount_every — 「毎月 $24、合計12回の支払い」
2. $form_id (int) — 支払いフォームの投稿ID。フォームのコンテキストが利用できない場合は 0。

例

次の例では、特定のフォーム（ID 150）が、グローバル設定またはフォームごとの設定に関係なく、常に「月あたりの金額」フォーマットを使用するように強制します。

add_filter( 'simpay_recurring_description_format', function ( $format_key, $form_id ) {
    if ( 150 === $form_id ) {
        return 'amount_per';
    }

    return $format_key;
}, 10, 2 );

このコードは WPCode プラグインを使用して安全に追加できます。本番環境にデプロイする前に、必ずステージングサイトでカスタムコードをテストしてください。

変更履歴

関連

• 分割払い説明フォーマットのカスタマイズ方法 – 管理画面UIでフォーマットを設定する
• 分割払いプラン – 分割払いプランを設定する
• カスタムコードの追加 – サイトにカスタムPHPコードを追加する方法