aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md
blob: 3e17d80c8bf04104f3e5782c4779b13206e8724b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
clearCache()

clears the cache for a specific template

Description
===========

void

clearCache

string

template

string

cache\_id

string

compile\_id

int

expire\_time

-   If you have [multiple caches](#caching.multiple.caches) for a
    template, you can clear a specific cache by supplying the `cache_id`
    as the second parameter.

-   You can also pass a [`$compile_id`](#variable.compile.id) as a third
    parameter. You can [group templates together](#caching.groups) so
    they can be removed as a group, see the [caching section](#caching)
    for more information.

-   As an optional fourth parameter, you can supply a minimum age in
    seconds the cache file must be before it will get cleared.

    > **Note**
    >
    > Since Smarty version 3.1.14 it is possible to delete cache files
    > by their individual expiration time at creation by passing
    > constant SMARTY::CLEAR\_EXPIRED as fourth parameter.

<!-- -->


    <?php
    // clear the cache for a template
    $smarty->clearCache('index.tpl');

    // clear the cache for a particular cache id in an multiple-cache template
    $smarty->clearCache('index.tpl', 'MY_CACHE_ID');
    ?>

       

See also [`clearAllCache()`](#api.clear.all.cache) and
[`caching`](#caching) section.