PEAR_PackageUpdate::loadPreferences – Loads the user's preferences from the preference file.


require_once 'PEAR/PackageUpdate.php';

boolean PEAR_PackageUpdate::loadPreferences ( string $pref_file = '' )


Loads the user's preferences from the preference file.

If the user is on a Windows machine, the file will be in the PEAR_CONFIG_SYSCONFIG directory and named ppurc.ini. If the user is on any other operating system, the preferences file will be stored in the user's home directory as the file .ppurc. The file contains a serialized array of preferences for each package that has been checked for updates so far.

Since version 0.7.0, you could also choose another directory and name for your preference file. Use then the optional parameter $pref_file.


string $pref_file

The path to the file to read user's preferences from.


throws PEAR_PACKAGEUPDATE_ERROR_PREFFILE_READACCESS, when user's preference file has no READ access right.

throws PEAR_PACKAGEUPDATE_ERROR_PREFFILE_CORRUPTED, when user's preference file has invalid contents.

throws PEAR_PACKAGEUPDATE_ERROR_INVALIDINIFILE, when user's preference file given by parameter $pref_file does not exist.


since 0.4.0a1

This function can not be called statically.

Return value

boolean - TRUE if the preferences were loaded successfully, FALSE otherwise.

Determines whether or not a file is includable. (Previous) Returns the path to the preferences file. (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.