aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack
diff options
context:
space:
mode:
authorZachary Wasserman <zachwass2000@gmail.com>2018-03-14 12:18:10 -0700
committerZachary Wasserman <zachwass2000@gmail.com>2018-03-14 12:18:10 -0700
commit9c6b3204d445a67c54cf8243a7e38bb6cbf6e267 (patch)
tree25895c1feac51f2755b67e9f9ada9796836245d3 /actionpack
parentb3b193f7d65357970e72711d42db8070dcf92ce4 (diff)
downloadrails-9c6b3204d445a67c54cf8243a7e38bb6cbf6e267.tar.gz
rails-9c6b3204d445a67c54cf8243a7e38bb6cbf6e267.tar.bz2
rails-9c6b3204d445a67c54cf8243a7e38bb6cbf6e267.zip
Add cancellation info to before filter docs
It is important for users to know that a render or redirect in a "before" filter causes the action to be cancelled. This was addressed in the guide, but not the API docs (http://guides.rubyonrails.org/action_controller_overview.html#filters). [ci skip]
Diffstat (limited to 'actionpack')
-rw-r--r--actionpack/lib/abstract_controller/callbacks.rb12
1 files changed, 12 insertions, 0 deletions
diff --git a/actionpack/lib/abstract_controller/callbacks.rb b/actionpack/lib/abstract_controller/callbacks.rb
index 146d17cf40..42bab411d2 100644
--- a/actionpack/lib/abstract_controller/callbacks.rb
+++ b/actionpack/lib/abstract_controller/callbacks.rb
@@ -103,6 +103,10 @@ module AbstractController
# :call-seq: before_action(names, block)
#
# Append a callback before actions. See _insert_callbacks for parameter details.
+ #
+ # If the callback renders or redirects, the action will not run. If there
+ # are additional callbacks scheduled to run after that callback, they are
+ # also cancelled.
##
# :method: prepend_before_action
@@ -110,6 +114,10 @@ module AbstractController
# :call-seq: prepend_before_action(names, block)
#
# Prepend a callback before actions. See _insert_callbacks for parameter details.
+ #
+ # If the callback renders or redirects, the action will not run. If there
+ # are additional callbacks scheduled to run after that callback, they are
+ # also cancelled.
##
# :method: skip_before_action
@@ -124,6 +132,10 @@ module AbstractController
# :call-seq: append_before_action(names, block)
#
# Append a callback before actions. See _insert_callbacks for parameter details.
+ #
+ # If the callback renders or redirects, the action will not run. If there
+ # are additional callbacks scheduled to run after that callback, they are
+ # also cancelled.
##
# :method: after_action