view_mode_page.api.php in View Mode Page 8

File

view_mode_page.api.php

<?php

/**
 * Hook called when the results of the get_patterns call is made.
 *
 * This could be used to inject/change results before they are returned.
 *
 * @param  array $results       DB results of the view_mode_page_get_patterns()
 * @param  string $content_type Content type passed to view_mode_page_get_patterns()
 * @param  string $view_mode    View mode passed to view_mode_page_get_patterns()
 * @return array                Results array
 * @see view_mode_page_get_patterns
 */
function hook_view_mode_page_get_patterns($results, $content_type, $view_mode) {
  return $results;
}

/**
 * Hook called just before a node is used to render a view mode
 * @param  object $node         The node that will be used for the view
 * @param  string $content_type The content type used by view_mode_page
 * @param  string $view_mode    The view mode triggered for view_mode_page
 * @param  string $pattern      The URL pattern that was triggered
 * @return object               The node
 */
function hook_view_mode_page_pre_view($node, $content_type, $view_mode, $pattern) {
  return $node;
}

/**
 * Hook called with the resulting view from node_view
 *
 * @param  object $node         The node that was used for node_view
 * @param  array  $view         The view that was returned from node_view
 * @param  string $content_type The content type used by view_mode_page
 * @param  string $view_mode    The view mode triggered by view_mode_page
 * @param  string $pattern      The URL pattern that was triggered
 * @return array                The view
 */
function hook_view_mode_page_post_view($node, $view, $content_type, $view_mode, $pattern) {
  return $view;
}

/**
 * Hook called with a pattern is added via view_mode_page
 *
 * @param  string $content_type The content type for the pattern
 * @param  string $view_mode    The view mode for the pattern
 * @param  string $pattern      The URL pattern
 * @param  string $result       The DB result for the pattern addition
 * @see view_mode_page_add_pattern
 */
function hook_view_mode_page_pattern_added($content_type, $view_mode, $pattern, $result) {
}

/**
 * Hook called when patterns are deleted
 *
 * @param  string $content_type The content type passed to the delete pattern function
 * @param  string $view_mode    The view mode passed to the delete pattern function
 * @param  string $pattern      The URL pattern passed to the delete pattern function
 * @see view_mode_page_delete_patterns
 */
function hook_view_mode_page_patterns_deleted($content_type = NULL, $view_mode = NULL, $pattern = NULL) {
}

Functions

Name	Description
hook_view_mode_page_get_patterns	Hook called when the results of the get_patterns call is made.
hook_view_mode_page_patterns_deleted	Hook called when patterns are deleted
hook_view_mode_page_pattern_added	Hook called with a pattern is added via view_mode_page
hook_view_mode_page_post_view	Hook called with the resulting view from node_view
hook_view_mode_page_pre_view	Hook called just before a node is used to render a view mode