How do you redirect users after a successful login?

From Joomla! Documentation

Revision as of 20:01, 22 October 2022 by Cmb (talk | contribs) (Several markup changes. URL corrections.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Screencapture-Login-module-redirect-dropdown.png

To redirect users after a successful login with the login module, choose a menu item under the Options tab, Basic Options section. Make sure that the menu item selected is a published menu item.

To edit a login module you must go to the specific login module:

Select Extensions  Module Manager and select a Login module type.

The login redirection page is selected from the drop down choices next to the Login Redirection Page item.

From the screenshots you can see the choices of redirection pages are paired to the established menu items. For example, the top menu has the menu items, Home, Sample Sites and Joomla.org as choices. The menu items are grouped by the menu type(alias). Top is called top, User Menu is usermenu and so on.

Screencapture-control-panel-menus-dropdown-en.png

Note The same procedure is used for redirecting users on successful logout except you enter the page where you want to redirect successful logouts to where it says Logout Redirection URL. Choose the Logout Redirection Page in the same way you would choose the Login Redirection Page using the drop down choice of menu item.

Overriding[edit]

If you would like to override the default login specified in your Administrator Backend from your custom code, do so with the following:

  • Take the URL that you would like to redirect the user to after they have successfully logged in and apply the base64_encode function to it. For example:
$redirectUrl = urlencode(base64_encode($redirectUrl));
// a base64_encode of index.php?option=com_pizzapie' yields: 'aW5kZXgucGhwP29wdGlvbj1jb21fcGl6emFwaWU='
  • Prepend the '&return=' query string to your newly-encoded $redirectUrl. For example:
 $redirectUrl = '&return='.$redirectUrl;
  • Append that $redirectUrl to the Joomla Login URL. For example,
    $joomlaLoginUrl = 'index.php?option=com_users&view=login';
    $finalUrl = $joomlaLoginUrl . $redirectUrl;

When you display that $finalUrl, it should look like this: index.php?option=com_users&view=login&return=aW5kZXgucGhwP29wdGlvbj1jb21fcGl6emFwaWU=

The controller.php file in com_users checks the contents of the return in the JRequest object. (The Joomla query access object.) If it is set and in the base64 format, base64_decodes it and applies that redirection.