Cache tags, cache blocks and clearing caches #

Part 8, reference 22. Exponential caches settings, compiled templates, rendered pages and more. When a change "does not work", a cache is the usual reason. This page lists the caches by what you changed, and shows how your own code clears caches correctly.

The commands #

php bin/php/ezcache.php --clear-tag=ini            # by tag: every cache with that tag
php bin/php/ezcache.php --clear-id=template,template-override
php bin/php/ezcache.php --clear-all
php bin/php/ezcache.php --list-tags
./console exp:cache status                          # every group, and the newer caches
./console exp:cache clear --tag=ini --dry-run       # what it would do

exp:cache does what the administration's cache page does, and also covers the static cache, the HTTP cache, the SQL query cache and Velocity (Cache control from the console). Add --allow-root-user when running as root, but prefer running as the web server's user.

The cache ids and their tags #

From kernel/classes/ezcache.php:

What to clear after what #

cache-block in templates #

{cache-block keys=array( $node.node_id, $current_user.contentobject_id ) expiry=600}
    {* expensive fetches and markup *}
{/cache-block}

Never cache per-user content without the user in keys. The designer help explains the template side in detail (cache-block).

From your PHP code #

When your code changes content through the kernel's functions, the kernel clears the view caches itself. When your extension changes something that affects how an object is displayed (its own table that a template reads), clear that object's caches:

<?php
eZContentCacheManager::clearContentCacheIfNeeded( $objectID );

clearContentCacheIfNeeded( $objectID, $versionNum = true, $additionalNodeList = false ) follows the site's view cache settings (which related nodes to clear). For your own file caches under var/, delete or regenerate them through the cluster file handler (eZFile, eZDir and cluster file handlers).

Related pages #

• Previous: Sending mail with eZMail
• Next: Built-in template operators
• Caching and templates
• Performance in extensions
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.