Piwik\Plugins\UsersManager\

UserPreferences

Methods

The class defines the following methods:

getDefaultWebsiteId()

Returns default site ID that Matomo should load.

Note: This value is a Matomo setting set by each user.

Signature

  • Returns: bool|int

getDefaultReport()

Returns default site ID that Matomo should load.

Note: This value is a Matomo setting set by each user.

Signature

  • Returns: bool|int

getDefaultDate()

Returns default date for Matomo reports.

Note: This value is a Matomo setting set by each user.

Signature

  • Returns: string'today', '2010-01-01', etc.

getDefaultPeriod()

Returns default period type for Matomo reports.

Signature

  • It accepts the following parameter(s):

    • $defaultDate (string) — the default date string from which the default period will be guessed
  • Returns: string'day', 'week', 'month', 'year' or 'range'