テーマ設定可能なサイト設定を発表

[martin (Martin Brennan)]

これは、開発者が認識できるように、Themeable site settings are now available の発表に関連するトピックです。

@martin

定義場所はどこですか？

テーマ可能なサイト設定は、コアの config/site_settings.yml ファイルで定義されます。各テーマ可能なサイト設定には、themeable: true オプションが定義されています。

現時点では、テーマ可能なサイト設定は enable_welcome_banner と search_experience の 2 つだけですが、将来的にはさらに多くのサイト設定をテーマ可能にする可能性があります。

テーマ作成者はデフォルト値をどのように制御できますか？

テーマ作成者は、about.json ファイルの theme_site_settings キーの下に、以下のようにテーマサイト設定のオーバーライドを定義できます。

"theme_site_settings": {
  "enable_welcome_banner": false
}

ここにある値はデータベースに保存され、テーマに関連付けられます。値が保存されると、テーマが更新されたときに about.json ファイルの theme_site_settings に対する変更は、管理者が一時的に設定を変更した可能性があるため、現在保存されているデータベース値に影響しません。

テーマ可能なサイト設定の制限は何ですか？

テーマ可能なサイト設定は、UI の要素を制御するためにのみ意図されており、その値を取得する際にはテーマ ID が必要となるため、以下の制限が適用されます。

• テーマ可能なサイト設定は Sidekiq ジョブでは使用できません。
• テーマ可能なサイト設定は Markdown ルールでは使用できません。
• テーマ可能なサイト設定は、テーマ ID をキーとしてクライアントサイト設定とは別にキャッシュされます。
• テーマ可能なサイト設定は、アプリケーションプリローダーを使用してクライアントの siteSettings サービス上のキーをオーバーライドします。
• SiteSetting.client_settings_json にはテーマ可能なサイト設定は含まれません。代わりに、テーマ ID を指定して SiteSetting.theme_site_settings_json を呼び出すことができます。

一般的に、テーマサイト設定は UI の部分を制御する単純な設定のみを対象とし、サーバーサイドの設定は対象外となります。

最初の PR は https://github.com/discourse/discourse/pull/32233 です。

開発者向けドキュメントは Controlling site settings with themes にあります。