Same name and namespace in other branches
  1. 6.x-1.x token_example/token_example.module \token_example

Examples using the Token API.

The Token module provides an API for providing tokens to other modules. Tokens are small bits of text that can be placed into larger documents via simple placeholders, like %site-name or [user].

Drupal 7 documentation on Token can be found here: http://drupal.org/documentation/modules/token

A list of existing tokens can be found here: http://drupal.org/node/390482#drupal7tokenslist

This example is part of the Examples for Developers Project which you can download and experiment with here: http://drupal.org/project/examples

Parent topics

File

token_example/token_example.module, line 12
An example module showing how to define and use tokens.

Functions

Namesort ascending Location Description
_token_example_get_user token_example/token_example.module Builds a list of available user accounts.
_token_example_get_taxonomy_term token_example/token_example.module Builds a list of available taxonomy terms.
_token_example_get_node token_example/token_example.module Builds a list of available content.
_token_example_get_file token_example/token_example.module Builds a list of available files.
_token_example_get_comment token_example/token_example.module Builds a list of available comments.
token_example_token_info token_example/token_example.tokens.inc Implements hook_token_info().
token_example_tokens token_example/token_example.tokens.inc Implements hook_tokens().
token_example_menu token_example/token_example.module Implements hook_menu().
token_example_example_form_submit token_example/token_example.module Submit callback; store the submitted values into storage.
token_example_example_form token_example/token_example.module Form builder; display lists of supported token entities and text to tokenize.
token_example_entity_info_alter token_example/token_example.module Implements hook_entity_info_alter().

Classes

Namesort ascending Location Description
TokenExampleTestCase token_example/token_example.test Functional tests for the Token Example module.