PEAR Manual
Prev |  | Next

# Auth_PrefManager::getPref()

Auth_PrefManager::getPref() -- Get a preference.

## Synopsis

    require_once '/PrefManager.php';

``mixed Auth_PrefManager::getPref` (string $user_id, string $pref_id, bool [$showDefaults = `TRUE`])`

## Description

Retrieves the preference specified for a user, or, if returning default values is enabled, the default.

## Parameter

string `$user_id`

  The user to get the preference for.

string `$pref_id`

  The preference to get.

boolean `$showDefaults`

  Should default values be searched (overrides the global setting).

## Return value

returns The value if it's found, or NULL if it isn't.

## Throws

No exceptions thrown.

## Note

This function can not be called statically.

Prev | Home | Next
Auth_PrefManager::getDefaultPref() | Up | Auth_PrefManager::setDefaultPref()