Auth_PrefManager::setDefaultPref

Auth_PrefManager::setDefaultPref() – Set the default value for a preference.

Synopsis

require_once '/PrefManager.php';

bool Auth_PrefManager::setDefaultPref ( string $pref_id , mixed $value )

Description

Sets the default value for $pref_id, which will be retrieved if a user doesn't have the preference set.

Parameter

string $pref_id

The name of the preference to set.

mixed $value

The value to set it to.

Return value

returns Success or failure.

Throws

No exceptions thrown.

Note

This function can not be called statically.

Get a preference. (Previous) Set a preference. (Next)
Last updated: Sat, 16 Feb 2019 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report.
View this page in:
  • English

User Notes:

There are no user contributed notes for this page.