redirectToIndex() public method

This function will exit immediately after executing.
public redirectToIndex ( string $moduleToRedirect, string $actionToRedirect, integer | null $websiteId = null, string | null $defaultPeriod = null, string | null $defaultDate = null, array $parameters = [] )
$moduleToRedirect string The plugin to redirect to, eg. `"MultiSites"`.
$actionToRedirect string Action, eg. `"index"`.
$websiteId integer | null The new idSite query parameter, eg, `1`.
$defaultPeriod string | null The new period query parameter, eg, `'day'`.
$defaultDate string | null The new date query parameter, eg, `'today'`.
$parameters array Other query parameters to append to the URL.
Controller Class Documentation
Example #1
0
 function redirectToCoreHomeIndex()
 {
     $defaultReport = API::getInstance()->getUserPreference(Piwik::getCurrentUserLogin(), API::PREFERENCE_DEFAULT_REPORT);
     $module = 'CoreHome';
     $action = 'index';
     // User preference: default report to load is the All Websites dashboard
     if ($defaultReport == 'MultiSites' && \Piwik\Plugin\Manager::getInstance()->isPluginActivated('MultiSites')) {
         $module = 'MultiSites';
     }
     if ($defaultReport == Piwik::getLoginPluginName()) {
         $module = Piwik::getLoginPluginName();
     }
     $idSite = Common::getRequestVar('idSite', false, 'int');
     parent::redirectToIndex($module, $action, $idSite);
 }