Overriding user_guardian.rb in a plugin (no fork necessary!)

merefield · January 3, 2021, 12:40pm

Here’s one where we’ve defined a method in the PostGuardian:

github.com/merefield/discourse-topic-previews-sidecar

lib/guardian_edits.rb

f4332f974


      
          require_dependency 'guardian'
          require_dependency 'guardian/post_guardian'
          
          class ::Guardian
            attr_accessor :featured_images
          end
          
          module ::PostGuardian
            # Passing existing loaded topic record avoids an N+1.
            def previewed_post_can_act?(post, topic, action_key, opts = {})
              taken = opts[:taken_actions].try(:keys).to_a
              is_flag = PostActionType.is_flag?(action_key)
              already_taken_this_action = taken.any? && taken.include?(PostActionType.types[action_key])
              already_did_flagging      = taken.any? && (taken & PostActionType.flag_types.values).any?
          
              result = if authenticated? && post && !@user.anonymous?
          
                return false if action_key == :notify_moderators && !SiteSetting.enable_private_messages
          
                # we allow flagging for trust level 1 and higher

You could do something similar for the UserGuardian using the existing method name which should override it.

Simple solution (to get it working if not robustly):

Literally just write out the original method code and make your edit. Downside: if Discourse change the code your plugin could break the instance.

Advanced solution (more robust solution):

For extra points you might be able to use super to inherit the original method but that’s not guaranteed to work for reasons I shan’t elaborate here on but is best practice because then updates to that method in discourse will always be taken into account without you having to edit your plugin.

Discourse is a platform. It takes time to learn it. Just take it step by step.

Topic		Replies	Views
Developing Discourse Plugins - Part 1 - Create a basic plugin Developer Guides plugin-guides , tutorial	32	85496	July 8, 2025
How to customize / override topic guardian through a plugin Development	4	864	February 15, 2021
Rails plugin generator Announcements	49	13963	August 20, 2021
[PAID] Mentorship needed Marketplace	7	1835	December 16, 2019
Simple example for plugin to change files? Development	3	578	July 1, 2023

Overriding user_guardian.rb in a plugin (no fork necessary!)

Simple solution (to get it working if not robustly):

Advanced solution (more robust solution):

Related topics