Manual:Hooks/IsFileCacheable

From MediaWiki.org

Jump to: navigation, search
IsFileCacheable
Available from version 1.10.0
Allow an extension to disable file caching on pages.

*Define function:
function fnMyHook( $article ) { ... }

*Attach hook:
$wgHooks['IsFileCacheable'][] = 'fnMyHook';
Called from: Article.php

*For more information about attaching hooks, see Manual:Hooks.
*For examples of extensions using this hook, see Category:IsFileCacheable extensions.


[edit] Details

  • $article - The article object.

Return value

  • true if cacheable
  • false if not cacheable

The hook isFileCacheable is not the sole determinant of whether a particular wiki page is cacheable or not. Whatever hook function you write is AND'ed with other boolean tests to determine cacheable status.

See also Manual:File cache.