Example: Cache API

  1. examples
    1. 7 cache_example/cache_example.module
    2. 8 cache_example/cache_example.module

Outlines how a module can use the Cache API.

Cache API allows us to cache data that is heavy to calculate. As this can significantly speed up the Drupal site, it is recommended to use cache mechanism when it is appropriate.

Cache in Drupal is very easy to use. This example will search entire Drupal folder and display all files. Since this operation includes filesystem it can take a while. This list will not change much on production websites, so we decide to cache it.

See also

cache_get()

cache_set()

cache_clear_all()

Functions & methods

NameDescription
cache_example_form_cache_clearingSubmit handler to demonstrate the various uses of cache_clear_all().
cache_example_form_create_expiring_itemSubmit handler to create a new cache item with specified expiration.
cache_example_form_expire_filesSubmit handler that explicitly clears cache_example_files_count from cache.
cache_example_menuImplements hook_menu().
cache_example_page_formcache_example page/form callback.

File

cache_example/cache_example.module, line 10
Outlines how a module can use the Cache API.

Login or register to post comments