You are here

function hook_esi_mode in ESI: Edge Side Includes 7.3

Provide a method of rendering an ESI URL: for example, as an ESI tag, or an SSI tag, or a div to render via AJAX.

Return value

array( 'mode_identifier' => array( // This title will be translated where used in the UI. 'title' => 'Human-readable name of this ESI mode.', // The render handler receives a single parameter: $url. 'render' => 'render_function_to_call', ) )

1 function implements hook_esi_mode()

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

esi_esi_mode in ./esi.module
Implements hook_esi_mode().
1 invocation of hook_esi_mode()
esi_get_modes in ./esi.module
Get the possible modes of rendering an ESI tag.

File

./esi.api.inc, line 106
API documentation for hooks defined by the ESI module.

Code

function hook_esi_mode() {
  return array(
    'ssi' => array(
      'title' => 'SSI tag',
      'render' => 'mymodule_ssi_tag',
    ),
  );
}