Same name and namespace in other branches
  1. 6.x-3.x docs/docs.php \hook_views_query_substitutions()

Performs replacements in the query before being performed.

Parameters

object $view: The View being executed.

Return value

array An array with keys being the strings to replace, and the values the strings to replace them with. The strings to replace are often surrounded with '***', as illustrated in the example implementation.

Related topics

Views hooks
Hooks that can be implemented by other modules in order to implement the Views API.
3 functions implement hook_views_query_substitutions()

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

node_views_query_substitutions in modules/node.views.inc
Implements hook_views_query_substitutions().
user_views_query_substitutions in modules/user.views.inc
Allow replacement of current userid so we can cache these queries.
views_views_query_substitutions in ./views.module
Substitute current time; this works with cached queries.
2 invocations of hook_views_query_substitutions()
views_plugin_query_default::execute in plugins/views_plugin_query_default.inc
Executes the query and fills the associated view object with according values.
views_plugin_query_default::query in plugins/views_plugin_query_default.inc
Generate a query and a countquery from all of the information supplied to the object.

File

./views.api.php, line 934
Describe hooks provided by the Views module.

Code

function hook_views_query_substitutions($view) {

  // Example from views_views_query_substitutions().
  global $language_content;
  return array(
    '***CURRENT_VERSION***' => VERSION,
    '***CURRENT_TIME***' => REQUEST_TIME,
    '***CURRENT_LANGUAGE***' => $language_content->language,
    '***DEFAULT_LANGUAGE***' => language_default('language'),
  );
}