PageRender class

Adds a render method to Page and caches page output.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the PageRender class also inherits all the methods and properties of: WireData and Wire.

Common
For hooks

Common

Name	Return	Summary
PageRender::beforeRenderPage() PageRender::beforeRenderPage(HookEvent $event) PageRender::beforeRenderPage(HookEvent $event)	(nothing)	Hook called before any other hooks to Page::render
PageRender::clearCacheFile() PageRender::clearCacheFile(HookEvent $event) PageRender::clearCacheFile(HookEvent $event)	(nothing)	Hook to clear the cache file after a Pages::save or Pages::delete call
PageRender::clearCacheFileAll() PageRender::clearCacheFileAll(Page $page) PageRender::clearCacheFileAll(Page $page)	(nothing)	Clear all cached pages
PageRender::clearCacheFilePages() PageRender::clearCacheFilePages(PageArray $items, Page $page) PageRender::clearCacheFilePages(PageArray $items, Page $page)	(nothing)	Clear cache for multiple pages by ID
PageRender::getCacheFile() PageRender::getCacheFile($page) PageRender::getCacheFile($page, array $options = [])	`CacheFile`	Get a CacheFile object corresponding to this Page
PageRender::isCacheAllowed() PageRender::isCacheAllowed(Page $page) PageRender::isCacheAllowed(Page $page)	`bool`	Is the page render cache allowed for this request?
PageRender::renderField() PageRender::renderField(Page $page, string $fieldName) PageRender::renderField(Page $page, string $fieldName, string $file = '', mixed $value = null)	`string` `mixed`	Renders a field value
PageRender::renderPage() PageRender::renderPage(HookEvent $event) PageRender::renderPage(HookEvent $event)	(nothing)	Return a string with the rendered output of this Page from its template file (other usages available as well)
PageRender::setPropertyPage() PageRender::setPropertyPage(Page $page) PageRender::setPropertyPage(Page $page)	(nothing)	Set page for get() properties / field rendering

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
PageRender::saveCacheFileReady() PageRender::saveCacheFileReady(Page $page, string $data) PageRender::saveCacheFileReady(Page $page, string $data)	`string`	Hook called when cache file is about to be saved for a Page

Additional methods and properties

In addition to the methods and properties above, PageRender also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Adds a render method to Page and caches page output.

Common

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news