Actions

API16

JCache/remove

< API16:JCache

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.

Description

Remove a cached data entry by id and group


<! removed transcluded page call, red link never existed >

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;
}


<! removed transcluded page call, red link never existed >

Examples

Code Examples


Advertisement