PHPXRef 0.7 : Drupal 6 (gatewave) : Detail view of docs.php

Functions that are not part of a class:

Describe table structure to Views.

This hook should be placed in MODULENAME.views.inc and it will be auto-loaded.
This must either be in the same directory as the .module file or in a subdirectory
named 'includes'.

The full documentation for this hook is in the advanced help.

hook_views_plugins() X-Ref

The full documentation for this hook is now in the advanced help.

This hook should be placed in MODULENAME.views.inc and it will be auto-loaded.
This must either be in the same directory as the .module file or in a subdirectory
named 'includes'.

This is a stub list as a reminder that this needs to be doc'd and is not used
in views anywhere so might not be remembered when this is formally documented:
- style: 'even empty'

hook_views_plugins_alter(&$plugins) X-Ref

Alter existing plugins data, defined by modules.

hook_views_handlers() X-Ref

Register handler, file and parent information so that handlers can be
loaded only on request.

The full documentation for this hook is in the advanced help.

hook_views_api() X-Ref

Register View API information. This is required for your module to have
its include files loaded; for example, when implementing
hook_views_default_views().

return:

hook_views_default_views() X-Ref

This hook allows modules to provide their own views which can either be used
as-is or as a "starter" for users to build from.

This hook should be placed in MODULENAME.views_default.inc and it will be
auto-loaded. This must either be in the same directory as the .module file
or in a subdirectory named 'includes'.

The $view->disabled boolean flag indicates whether the View should be
enabled or disabled by default.

return:

hook_views_default_views_alter(&$views) X-Ref

This hook is called right before all default views are cached to the
database. It takes a keyed array of views by reference.

hook_views_convert() X-Ref

Stub hook documentation

This hook should be placed in MODULENAME.views_convert.inc and it will be auto-loaded.
This must either be in the same directory as the .module file or in a subdirectory
named 'includes'.

hook_views_query_substitutions() X-Ref

Stub hook documentation

hook_views_pre_view(&$view, &$display_id, &$args) X-Ref

This hook is called at the very beginning of views processing,
before anything is done.

Adding output to the view can be accomplished by placing text on
$view->attachment_before and $view->attachment_after.

hook_views_pre_build(&$view) X-Ref

This hook is called right before the build process, but after displays
are attached and the display performs its pre_execute phase.

Adding output to the view can be accomplished by placing text on
$view->attachment_before and $view->attachment_after.

hook_views_pre_execute(&$view) X-Ref

This hook is called right before the execute process. The query is
now fully built, but it has not yet been run through db_rewrite_sql.

Adding output to the view can be accomplished by placing text on
$view->attachment_before and $view->attachment_after.

hook_views_pre_render(&$view) X-Ref

This hook is called right before the render process. The query has
been executed, and the pre_render() phase has already happened for
handlers, so all data should be available.

Adding output to the view can be accomplished by placing text on
$view->attachment_before and $view->attachment_after. Altering the
content can be achieved by editing the items of $view->result.

This hook can be utilized by themes.

hook_views_post_render(&$view, &$output, &$cache) X-Ref

Post process any rendered data.

This can be valuable to be able to cache a view and still have some level of
dynamic output. In an ideal world, the actual output will include HTML
comment based tokens, and then the post process can replace those tokens.

Example usage. If it is known that the view is a node view and that the
primary field will be a nid, you can do something like this:



And then in the post render, create an array with the text that should
go there:

strtr($output, array('', 'output for FIELD of nid 1');

All of the cached result data will be available in $view->result, as well,
so all ids used in the query should be discoverable.

This hook can be utilized by themes.

hook_views_query_alter(&$view, &$query) X-Ref

Stub hook documentation

This hook should be placed in MODULENAME.views.inc and it will be auto-loaded.
This must either be in the same directory as the .module file or in a subdirectory
named 'includes'.

hook_views_admin_links_alter(&$links, $view) X-Ref

This hook should be placed in MODULENAME.views.inc and it will be auto-loaded.
This must either be in the same directory as the .module file or in a subdirectory
named 'includes'.

Alter the links that appear over a view. They are in a format suitable for
theme('links').

Warning: $view is not a reference in PHP4 and cannot be modified here. But it IS
a reference in PHP5, and can be modified. Please be careful with it.

hook_views_preview_info_alter(&$rows, $view) X-Ref

This hook should be placed in MODULENAME.views.inc and it will be auto-loaded.
This must either be in the same directory as the .module file or in a subdirectory
named 'includes'.

Alter the rows that appear with a view, which includes path and query information.
The rows are suitable for theme('table').

Warning: $view is not a reference in PHP4 and cannot be modified here. But it IS
a reference in PHP5, and can be modified. Please be careful with it.

File Size:	667 lines (19 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Drupal 6 (gatewave)

/sites/all/modules/views/docs/ -> docs.php (summary)

Defines 17 functions