function hook_flush_caches

Add a list of cache tables to be cleared.

This hook allows your module to add cache table names to the list of cache tables that will be cleared by the Clear button on the Performance page or whenever drupal_flush_all_caches is invoked.

Return value

An array of cache table names.

See also

drupal_flush_all_caches()

Related topics

Hooks
Allow modules to interact with the Drupal core.
7 functions implement hook_flush_caches()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

block_flush_caches in modules/block/block.module
Implements hook_flush_caches().
field_flush_caches in modules/field/field.module
Implements hook_flush_caches().
image_flush_caches in modules/image/image.module
Implements hook_flush_caches().
system_cron_test_flush_caches in modules/system/tests/system_cron_test.module
Implements hook_flush_caches().
system_flush_caches in modules/system/system.module
Implements hook_flush_caches().

... See full list

4 invocations of hook_flush_caches()
CacheClearCase::testFlushAllCaches in modules/simpletest/tests/cache.test
Test drupal_flush_all_caches().
CacheClearCase::testIsValidBin in modules/simpletest/tests/cache.test
Test DrupalDatabaseCache::isValidBin().
drupal_flush_all_caches in includes/common.inc
Flushes all cached data on the site.
system_cron in modules/system/system.module
Implements hook_cron().

File

modules/system/system.api.php, line 2652

Code

function hook_flush_caches() {
    return array(
        'cache_example',
    );
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.