(非推奨) テーマまたはプラグインからDiscourseテンプレートを上書きする

Discourse をテーマやプラグインでカスタマイズする際は、原則として CSS、JavaScript プラグイン API、またはプラグイン outlets を使用してください。これらではご自身のユースケースに対応できない場合は、Discourse コアへの PR を提出するか、Meta の Development トピックで議論を開始してください。カスタマイズを容易にするための新しい outlet や API の追加について議論できることを常に嬉しく思います。

他のすべての選択肢を試し尽くした場合、テンプレートのオーバーライドに頼る必要があるかもしれません。この手法を使えば、テーマやプラグインから任意の Ember コンポーネントやルートのテンプレート全体をオーバーライドできます。

:rotating_light: これは Discourse をカスタマイズする推奨される方法ではありません。 Discourse コアの日々の変更は、最終的にテンプレートオーバーライドと競合し、フォーラムのレンダリング時に壊滅的なエラーを引き起こす可能性があります。

このアプローチを採用する場合は、回帰を検出するための十分な自動化されたテストと QA プロセスを備えていることを確認してください。テンプレートオーバーライドを含むテーマやプラグインを配布する場合は、そのテーマやプラグインが持つ安定性のリスクについてフォーラム管理者が認識していることを必ず確認してください。

:rotating_light: :rotating_light: :rotating_light: 2023 年 10 月更新: 新機能については、Discourse は Ember の .gjs ファイル形式を使用して記述されたコンポーネントの使用へと移行しつつあります。これらのコンポーネントのテンプレートはインラインで定義されるため、テーマやプラグインによるオーバーライドはできません。

今後は、すべてのテンプレートのカスタマイズは プラグイン outlets を使用して行う必要があります。

近い将来に機能しなくなることは理解しているが、とにかくドキュメントを見せてほしい

コンポーネントテンプレートのオーバーライド

Ember コンポーネントのテンプレート(Discourse コアの components/* 以下にあるもの)をオーバーライドするには、テーマやプラグイン内に同名の .hbs ファイルを作成してください。例えば、Discourse コア内の badge-button コンポーネントのテンプレートをオーバーライドするには、テーマやプラグインの以下の場所にテンプレートファイルを作成します。

:art: {theme}/javascripts/discourse/templates/components/badge-button.hbs

:electric_plug: {plugin}/assets/javascripts/discourse/templates/components/badge-button.hbs

オーバーライドは、コアコンポーネントが「コローケート(同一場所)」されたテンプレートを持っていた場合でも、常に /templates ディレクトリ内にネストされている必要があります。

ルートテンプレートのオーバーライド

ルートテンプレート(templates/* 以下にあるコンポーネント以外のすべてのテンプレート)のオーバーライドは、コンポーネントの場合と同じ方法で行われます。テーマやプラグイン内に同名のテンプレートを作成してください。例えば、コア内の discovery.hbs をオーバーライドするには、以下のようなファイルを作成します。

:art: {theme}/javascripts/discourse/templates/discovery.hbs

:electric_plug: {plugin}/assets/javascripts/discourse/templates/discovery.hbs

複数のテーマ / プラグイン間の相互作用

複数のインストールされたテーマやプラグインが同じテンプレートをオーバーライドする場合、「勝者」となるのは、以下のリストで番号が最も低い順位を持つものです。

  1. テーマのオーバーライド(最も高いテーマ「id」が優先)
  2. プラグインのオーバーライド(アルファベット順で最も新しいプラグイン名が優先)
  3. コア

この優先順位により、テーマからプラグインのテンプレートをオーバーライドすることも可能です。技術的には、他のテーマからテーマのテンプレートを、あるいは他のプラグインからプラグインのテンプレートをオーバーライドすることも可能ですが、プラグイン名やテーマ id に依存するため、予期せぬ動作を招く可能性があります。

これはどのように機能するのか?

Discourse は、DiscourseTemplateMap クラス内でテンプレートを収集し、優先順位付けを行います。コローケートされたコンポーネントテンプレートの場合、その情報はアプリの初期化時 に使用され、コアのテンプレート関連付けを置き換えます。その他のすべてのテンプレートについては、マップがランタイムでのresolver によって使用され、正しいテンプレートを取得します。


このドキュメントはバージョン管理されています。変更は GitHub で提案してください。

「いいね!」 17

モバイルテンプレートについてはどうですか?コアのテンプレートを書き直すためのディレクトリ構造は何ですか?

それは全く同じように機能するはずです。コアテンプレートの名前を一致させます。したがって、/mobile がある場合は、オーバーライドに含めてください。

モバイルの login.hbs テンプレートを書き直そうとしていますが、うまくいきません Imgur: The magic of the Internet

スクリーンショットでは、完全なパスが表示されていないように見えます。テキストとしてここに貼り付けていただけますか。

themeroot/javascripts/mobile/modal/login.hbs

パスにdiscourse/templatesがありません

したがって、この場合は{theme}/javascripts/discourse/templates/mobile/modal/login.hbsになります。

「いいね!」 2

これはまだ当てはまりますか?

多くのコードを上書きする機能が削除されるのは少し残念です。

Widget システムをある程度置き換えるのは理にかなっていますが、これにより複数のレベルで既存のコードにフックすることができ、次のようなことを可能にする巧妙な方法で小さなブロックのみを対象とすることで、多くの破壊的変更のリスクを軽減できました。

  • 機能を追加する
  • 他のものを邪魔しない。

たとえば、Discourse Journal から 2 つの重要な機能を削除しなければなりませんでした。これはウィジェットのきめ細かなオーバーライドに基づいていたためですが、Glimmer でそれらを再作成する唯一の方法は、テンプレートのオーバーライドのペア (.gjs ファイルの変更を試みるものを含む) を介して行うことでしたが、これはサポートされなくなったようです。

たとえこれがサポートされていたとしても、ウィジェットフレームワークの下よりも大きなコードのストレッチをオーバーライドすることになり、コアの変更がオーバーライドと競合するリスクが増加します。

これはプラットフォームの拡張性にとって健全ではありません。

何かできることはありますか?

「いいね!」 7

ええ、わかります。ウィジェットの拡張性APIには良い点もありました。

しかし、その一方で、ウィジェットベースのUIのコア部分を少しでも変更するのが非常に困難でした。なぜなら、人々がどのようなランダムなメソッドやデコレーションを導入しているかわからなかったからです。そのため、ウィジェットのカスタマイズは比較的安定しているように見えました。コアの実装に触れるのが怖すぎたのです。

今後のための私たちの解決策は、Wrapper Plugin Outlets です。これらは、テーマやプラグインがテンプレートの非常に小さなチャンクを独自のインプリメンテーションでオプションでオーバーライドできるようにします。

例えば、Chatがどのように条件付きでホームロゴをオーバーライドしているか を見てください。カスタムコンポーネント で。これは、既存のウィジェットベースのヘッダーと、新しいGlimmerベースのヘッダー(近日公開予定!:tm:)の両方で機能します。

私たちは、さまざまな場所に新しいラッパーアウトレットを追加するPRを一般的に受け入れています。特定のユースケースについて不明な点がある場合は、お気軽に詳細を添えて#devトピックを開いてください!

「いいね!」 10

わかりました、それは前進するための方法のようですね。ありがとうございます。

その影響を消化し、それに沿った戦略に調整する必要があります。

ご回答に感謝します!

「いいね!」 6