Joomla! Documentation™

Description

Remove a cached data entry by id and group

Syntax

remove($id, $group=null)

Parameter Name	Default Value	Description
$id		$id The cache data id
$group	null	$group The cache data group

Returns

boolean True on success, false otherwise

Defined in

libraries/joomla/cache/cache.php

Importing

jimport( 'joomla.cache.cache' );

Source Body

function remove($id, $group=null)
{
        // Get the default group
        $group = ($group) ? $group : $this->_options['defaultgroup'];

        // Get the storage handler
        $handler = &$this->_getStorage();
        if (!JError::isError($handler)) {
                return $handler->remove($id, $group);
        }
        return false;
}

Examples

<CodeExamplesForm />