注意
AForms v2.0.0から、設定ファイル(.tomlファイル)のサポートは廃止されました。
WordPressプラグインには珍しいですが、AFormsには設定ファイルがあります。
設定ファイルがある理由
AFormsでは「サイトを作る人と運営する人は別々である」と想定しています。
デザインをscssでカスタマイズできる、というのもその想定から来ています。
普通はscssなんて知らないわけですから。
このような想定ですので、「サイトを作る人がより良いサイトをより早く作れる」ようにすることは、AFormsが目指している「隠れたゴール」の1つです。
サイトを作る人がAFormsの挙動をコントロールしたいとき、それを最も簡単に実現する手段として、設定ファイルがあります。
設定ファイルはAFormsのデフォルトの挙動を変えるためにあります。設定ファイルを配置しなくても、AFormsは問題なく動きます。
設定ファイルのサンプル
AFormsには設定ファイルのサンプルが同梱されています。
下記の場所にあります。
wp-content/plugins/aforms/aforms.toml.sample
これを設定ファイルの雛形としてお使いください。
実際に使うには、ファイル名をaforms.toml
に変えてください。
設定ファイルの書式
設定ファイルはtoml形式です。
- パラメーター
設定値はname = value
の書式で書きます。name
はパラメーターの名前、value
はパラメーターの値です。AFormsの設定では、どちらも"
で囲むとよいでしょう。 - セクション
セクションは[secion]
の書式で書きます。セクションは複数のパラメーターをグループにまとめるものです。 - コメント行
コメント行は# コメント
の書式で書きます。コメント行はAFormsからは無視されますので、日本語で説明文を書いたりできます。
toml形式の詳細は下記を参照してください。
https://github.com/toml-lang/toml/blob/master/versions/ja/toml-v0.4.0.md
generalセクション
AFormsの設定ファイルには、generalセクションとwordsセクションがあります。
generalセクションはAFormsの一般設定です。
generalセクションで設定できるパラメーターは次の1つだけです。
stylesheet
:
フォーム用のcssスタイルシートを設定します。
アクティブなテーマのテーマフォルダからのパス(先頭にスラッシュを書かない)を指定してください。
指定された場合、フォームを表示する際に、AForms同梱のスタイルシートではなく指定されたスタイルシートが使われます。
wordsセクション
wordsセクションでは、AFormsで使われる文言を設定できます。
フォームで使われる文言すべてが設定できますので、パラメーターは大量にあります。
パラメーターの名前は「文言そのもの」を"
で囲んだものです。ただし、AFormsの文言はもともと英語で書かれていますので、パラメーター名は英語になります。
パラメーターの値には、表示したい文言を書いてください。
- パラメーターの値を複数行にしたい場合
パラメーター値を「”””」で囲んでください。間に改行が入っていても大丈夫です。 - パラメーターの値に「”」を含めたい場合
「”」の代わりに「\”」と書いてください。
なお、設定できる文言のリストは設定できる文言一覧に載っています。
設定ファイルの設置先
設定ファイルは、アクティブなテーマのテーマフォルダーか、AFormsのプラグインフォルダーに設置してください。
ファイル名はaforms.toml
です。
設定の具体例
1. ボタンの表記を変える
フォームの申込ボタンの表記は既定では「送信」ですが、これがいつでも適切なわけではありません。この例では、申込ボタンの表記を「この見積で申し込む」に変えてみましょう。
"Submit" = "この見積で申し込む"
設定ファイルの[words]
セクションに上記の設定を書き加えてください。
2. 通貨をユーロに変更する
通貨の表記を変更するには、料金の前後に表示される単位を変更します。円はふつう金額の後ろに書きますが、ユーロは金額の前ですね。
"$pricePrefix" = "€"
"$priceSuffix" = ""
さらに、サンキューメールの明細行の表記にも変更が必要です。
下記は特殊で、文字を組み合わせる指示になっているワードです。%s
の箇所に商品名、数量、金額が入りますのでそのように想像しながら見てみてください。
"%s (x %s) $%s" = "%s (x %s) €%s"
上記の3つの設定を、設定ファイルの[words]
セクションに記入してください。