Idéalement, lors de la personnalisation de Discourse via des thèmes/plugins, vous devriez utiliser du CSS, l’API de Plugin JavaScript ou des plugin outlets. Si aucune de ces méthodes ne convient à votre cas d’utilisation, n’hésitez pas à ouvrir une PR dans le cœur de Discourse ou à démarrer un sujet Dev ici sur Meta. Nous sommes toujours heureux de discuter de l’ajout de nouveaux outlets/APIs pour faciliter la personnalisation.
Si vous avez épuisé toutes les autres options, vous devrez peut-être recourir aux remplacements de modèles (template overrides). Cette technique vous permet de remplacer le modèle entier de n’importe quel composant Ember ou Route depuis votre thème/plugin.
Ce n’est pas une méthode recommandée pour personnaliser Discourse. Les changements quotidiens dans le cœur de Discourse entreront en conflit avec votre remplacement de modèle à terme, provoquant potentiellement des erreurs catastrophiques lors du rendu du forum.
Si vous décidez d’adopter cette approche, assurez-vous de disposer de suffisamment de tests automatisés et de processus d’assurance qualité (AQ) pour détecter les régressions. Si vous distribuez un thème/plugin avec des remplacements de modèles, veuillez vous assurer que les administrateurs du forum sont conscients des risques de stabilité que comporte votre thème/plugin.
![]()
![]()
Mise à jour d’octobre 2023 : Pour les nouvelles fonctionnalités, Discourse s’oriente de plus en plus vers l’utilisation de composants rédigés à l’aide du format de fichier
.gjsd’Ember. Les modèles pour ces composants sont définis en ligne et ne peuvent pas être remplacés par des thèmes/plugins.À l’avenir, toutes les personnalisations de modèles doivent être effectuées à l’aide des Plugin Outlets
Je comprends que cela va bientôt casser, montrez-moi la documentation quand même
Remplacement des modèles de composants
Pour remplacer un modèle de composant Ember (c’est-à-dire tout ce qui se trouve sous components/* dans le cœur de Discourse), vous devez créer un fichier .hbs de nom identique dans votre thème/plugin. Par exemple, pour remplacer le modèle du composant badge-button dans le cœur de Discourse, vous créeriez un fichier de modèle dans votre thème/plugin à cet emplacement :
{theme}/javascripts/discourse/templates/components/badge-button.hbs
{plugin}/assets/javascripts/discourse/templates/components/badge-button.hbs
Le remplacement doit toujours être imbriqué dans le répertoire /templates, même si le composant principal a un modèle « colocalisé ».
Remplacement des modèles de routes
Le remplacement des modèles de routes (c’est-à-dire tous les modèles non-composants sous templates/*) fonctionne de la même manière que pour les composants. Créez un modèle portant le même nom dans votre thème/plugin. Par exemple, pour remplacer discovery.hbs dans le cœur, vous pourriez créer un fichier comme
{theme}/javascripts/discourse/templates/discovery.hbs
{plugin}/assets/javascripts/discourse/templates/discovery.hbs
Remplacement des modèles « bruts » (.hbr)
Le système de modèle « brut » de Discourse sera bientôt remplacé par des composants Ember réguliers. Mais en attendant, le remplacement des modèles bruts fonctionne de la même manière que pour les modèles Ember. Par exemple, pour remplacer topic-list-item.hbr dans le cœur, vous pourriez créer un fichier comme :
{theme}/javascripts/discourse/templates/list/topic-list-item.hbr
{plugin}/assets/javascripts/discourse/templates/list/topic-list-item.hbr
Interaction entre plusieurs thèmes / plugins
Si plusieurs thèmes/plugins installés remplacent le même modèle, le « gagnant » est celui qui a le rang numérique le plus bas dans cette liste :
- Remplacements de thèmes (l’« id » de thème le plus élevé l’emporte)
- Remplacements de plugins (le nom de plugin alphabétique le plus récent l’emporte)
- Cœur
Cette précédence signifie également que vous pouvez remplacer les modèles de plugins à partir de thèmes. Techniquement, vous pouvez également remplacer des modèles de thèmes par d’autres thèmes, et des modèles de plugins par d’autres plugins, mais le comportement peut être surprenant en raison de la dépendance au nom du plugin et à l’ID du thème.
Comment cela fonctionne-t-il ?
Discourse assemble et priorise les modèles dans la classe DiscourseTemplateMap. Pour les modèles de composants colocalisés, cette information est utilisée pendant l’initialisation de l’application pour remplacer les associations de modèles de base. Pour tous les autres modèles, la carte est utilisée par le résolveur au moment de l’exécution pour récupérer le modèle correct.
Ce document est contrôlé par version - suggérez des modifications sur github.