Skip to content

Document 5.x redirecting #8046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions en/controllers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,28 @@ for best results::

.. _controller-middleware:

Using Redirects in Controller Events
====================================

To redirect from within a controller callback method you can use the following::

public function beforeFilter(EventInterface $event): void
{
if (...) {
$event->setResult($this->redirect('/'));

return;
}

...
}

By setting a redirect as event result you let CakePHP know that you don't want any other
component callbacks to run, and that the controller should not handle the action
any further.

As of 4.1.0 you can also raise a ``RedirectException`` to signal a redirect.

Controller Middleware
=====================

Expand Down
2 changes: 1 addition & 1 deletion en/controllers/components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ To redirect from within a component callback method you can use the following::
...
}

By stopping the event you let CakePHP know that you don't want any other
By setting a redirect as event result you let CakePHP know that you don't want any other
component callbacks to run, and that the controller should not handle the action
any further. As of 4.1.0 you can raise a ``RedirectException`` to signal
a redirect::
Expand Down