Auth_PrefManager::deletePref

Auth_PrefManager::deletePref() – Deletes a preference for the specified user.

Synopsis

require_once '/PrefManager.php';

bool Auth_PrefManager::deletePref ( string $user_id , string $pref_id )

Description

Deletes the preference $pref_id for $user_id if one is set.

Parameter

string $user_id

The userid of the user to delete from.

string $pref_id

The preference to delete.

Return value

returns Success/Failure

Throws

No exceptions thrown.

Note

This function can not be called statically.

Deletes a preference for the default user. (Previous) Retrieves a default value. (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.