Joomla! Documentation™

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

Clean cache for a group given a mode.

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

Syntax

clean($group=null, $mode='group')

Parameter Name	Default Value	Description
$group	null	$group The cache data group
$mode	'group'	notgroup]

Returns

boolean True on success, false otherwise

Defined in

libraries/joomla/cache/cache.php

Importing

jimport( 'joomla.cache.cache' );

Source Body

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

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

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

Examples

<CodeExamplesForm />