From Joomla! Documentation

< API16:JRegistry

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.


Load the contents of a file into the registry


loadFile($file, $format= 'JSON', $namespace=null)
Parameter Name Default Value Description
$file Path to file to load
$format 'JSON' Format of the file [optional: defaults to JSON]
$namespace null Namespace to load the JSON string into [optional]


boolean True on success

Defined in



jimport( 'joomla.registry.registry' );

Source Body

public function loadFile($file, $format = 'JSON', $namespace = null)
        // Load a file into the given namespace [or default namespace if not given]
        $handler = &JRegistryFormat::getInstance($format);

        // If namespace is not set, get the default namespace
        if ($namespace == null) {
                $namespace = $this->_defaultNameSpace;

        // Get the contents of the file
        $data = JFile::read($file);

        if (!isset($this->_registry[$namespace])) {
                // If namespace does not exist, make it and load the data
                $this->_registry[$namespace]['data'] = $handler->stringToObject($data);
        } else {
                // Get the data in object format
                $ns = $handler->stringToObject($data);

                 * We want to leave groups that are already in the namespace and add the
                 * groups loaded into the namespace.  This overwrites any existing group
                 * with the same name
                foreach (get_object_vars($ns) as $k => $v) {
                        $this->_registry[$namespace]['data']->$k = $v;

        return true;


Code Examples