Panels 2 API Documentation

This WIKI is currently a placeholder for Panels 2 API documentation.

proviso: schuyler1d is just putting some documentation here while I peruse the code. It could be all wrong.

Terminology

$display

The panel rendered.

$display->layout
$display->args
$display->incoming_content
$display->context
$display->css_id
$display->did #display id, starts out as 'new'

$layout

$pane

$context

Public Hooks

hook_panels_pre_render($display) [panels.module]

prepend header-like content to the displayed panel

hook_panels_post_render($display)

footer to the displayed panel

hook_panels_pane_content_alter($content, $pane, $args, $context) [includes/plugins.inc]

hook_panels_include_directory($plugintype)

 * Hook allowing other modules to create their own panels .inc files,
 * and have them available in panels without needing to add files to the
 * Panels include directories. See API.txt for details.
 * 
 * PLEASE NOTE: There are strict naming conventions on implementing this hook; failure to 
 * follow the conventions will likely cause your plugins not to work. Possibly even worse,
 * failure to follow the conventions can result in namespace collisions between your
 * module and other modules invoking the panels API. 
 *
 * @param string $plugintype
 *   The type of Panels plugin being requested. Can be any of the following seven:
 *  'content_types', 'contexts', 'arguments', 'layouts', 'styles', 'relationships'
 * 
 * @return array $directories
 *   Returns an array of include subdirectories to call for the requested plugin type. 
 *   Subdirectories should be ONLY the subdirectory of your module where the appropriate
 *   types of .inc files reside.

hook_panels_exportables($op, $panels, $name) [panels_export/panels_export.module]

@param string $op
either 'list' or 'export'
@param array $panels ?which panels to export
@param string $name ?the name of the pane?

hook_default_panel_minis() [panels_mini/panels_mini.module]

hook_default_panel_pages() [panels_page/panels_page.module]

hook_default_panel_views() [panels_views/panels_views.module]

hook_panels_style_info()

Defines custom panel styles, thus:

function panels_default_panels_styles() {
  return array(
    <style machine name> => array(
      'title' => t('Style name'),
      'description' => t('Style description.'),
      'render panel' => '<style machine name>_render_panel',
    ),
  );

Your module should then define theme__render_panel() to theme the panel.