API15

API15:JCache/remove

From Joomla! Documentation

Revision as of 00:21, 25 March 2017 by JoomlaWikiBot (talk | contribs) (preparing for archive only)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Remove a cached data entry by id and group

[<! removed edit link to red link >]

<! 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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

Code Examples