vid.inc
Plugin to provide an argument handler for a vocabulary id.
File
-
plugins/
arguments/ vid.inc
View source
<?php
/**
* @file
* Plugin to provide an argument handler for a vocabulary id.
*/
/**
* Plugins are described by creating a $plugin array which will be used
* by the system that includes this file.
*/
$plugin = array(
'title' => t("Vocabulary: ID"),
// Keyword to use for %substitution.
'keyword' => 'vocabulary',
'description' => t('Creates a vocabulary context from a vocabulary ID argument.'),
'context' => 'ctools_vid_context',
'placeholder form' => array(
'#type' => 'textfield',
'#description' => t('Enter the vocabulary ID for this argument'),
),
'no ui' => TRUE,
);
/**
* Discover if this argument gives us the vocabulary we crave.
*/
function ctools_vid_context($arg = NULL, $conf = NULL, $empty = FALSE) {
// If unset it wants a generic, unfilled context.
if ($empty) {
return ctools_context_create_empty('entity:taxonomy_vocabulary');
}
if (!is_numeric($arg)) {
return NULL;
}
$vocabulary = taxonomy_vocabulary_load($arg);
if (!$vocabulary) {
return NULL;
}
return ctools_context_create('vocabulary', $vocabulary);
}
Functions
Title | Deprecated | Summary |
---|---|---|
ctools_vid_context | Discover if this argument gives us the vocabulary we crave. |