esi_panels.api.inc in ESI: Edge Side Includes 7.3

API documentation for hooks defined by ESI Panels.

File

modules/esi_panels/esi_panels.api.inc

<?php

/**
 * @file
 * API documentation for hooks defined by ESI Panels.
 */

/**
 * Alter the URL used in an ESI include tag.
 *
 * @param string $url
 *   The URL used in the ESI include tag.
 * @param array $context
 *   Associative array containing the pane to be rendered ($pane) and
 *   its display ($display). Not editable, for reference purposes only.
 */
function hook_esi_panels_url_alter(&$url, $context) {

  // Add the timestamp to the URL.
  $url .= '/' . time();
}

/**
 * Translate task plugin arguments into arguments to pass to a ctools context
 * handler. For example, turn '1' into the fully-loaded node object for node 1.
 *
 * Every 'task' plugin should implement this hook. An implementation for the
 * default page manager tasks is already provided.
 */
function hook_esi_panels_context_arguments($task, $subtask = '', $args = array()) {
  if ($task == 'node_view' && $subtask == '') {
    $nid = array_shift($args);
    return node_load($nid);
  }
}

Functions

Name	Description
hook_esi_panels_context_arguments	Translate task plugin arguments into arguments to pass to a ctools context handler. For example, turn '1' into the fully-loaded node object for node 1.
hook_esi_panels_url_alter	Alter the URL used in an ESI include tag.