instance method `run_callbacks`

Ruby on Rails 2.3.18

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

run_callbacks(kind, options = {}, &block)

Runs all the callbacks defined for the given options.

If a block is given it will be called after each callback receiving as arguments:

* the result from the callback
* the object which has the callback

If the result from the block evaluates to false, the callback chain is stopped.

Example:

class Storage
  include ActiveSupport::Callbacks

  define_callbacks :before_save, :after_save
end

class ConfigStorage < Storage
  before_save :pass
  before_save :pass
  before_save :stop
  before_save :pass

  def pass
    puts "pass"
  end

  def stop
    puts "stop"
    return false
  end

  def save
    result = run_callbacks(:before_save) { |result, object| result == false }
    puts "- save" if result
  end
end

config = ConfigStorage.new
config.save

Output:

pass
pass
stop

Parameters

kind req
options opt = {}
block block

Source

# File activesupport/lib/active_support/callbacks.rb, line 275
    def run_callbacks(kind, options = {}, &block)
      self.class.send("#{kind}_callback_chain").run(self, options, &block)
    end

Defined in activesupport/lib/active_support/callbacks.rb line 275 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::Callbacks

Signature

Parameters