hook_node_info

• Drupal 4.7
• Drupal 5
• Drupal 6
• Drupal 7

Versions

4.7 – 7

hook_node_info()

Define module-provided node types.

This hook allows a module to define one or more of its own node types. For example, the blog module uses it to define a blog node-type named "Blog entry." The name and attributes of each desired node type are specified in an array returned by the hook.

Only module-provided node types should be defined through this hook. User- provided (or 'custom') node types should be defined only in the 'node_type' database table, and should be maintained by using the node_type_save() and node_type_delete() functions.

The machine-readable name of a node type should contain only letters, numbers, and underscores. Underscores will be converted into hyphens for the purpose of contructing URLs.

All attributes of a node type that are defined through this hook (except for 'locked') can be edited by a site administrator. This includes the machine-readable name of a node type, if 'locked' is set to FALSE.

For a detailed usage example, see node_example.module.

Return value

An array of information defining the module's node types. The array contains a sub-array for each node type, with the machine-readable type name as the key. Each sub-array has up to 10 attributes. Possible attributes:

• "name": the human-readable name of the node type. Required.
• "base": the base string used to construct callbacks corresponding to this node type. (i.e. if base is defined as example_foo, then example_foo_insert will be called when inserting a node of that type). This string is usually the name of the module, but not always. Required.
• "description": a brief description of the node type. Required.
• "help": help information shown to the user when creating a node of this type.. Optional (defaults to '').
• "has_title": boolean indicating whether or not this node type has a title field. Optional (defaults to TRUE).
• "title_label": the label for the title field of this content type. Optional (defaults to 'Title').
• "has_body": boolean indicating whether or not this node type has a body field. Optional (defaults to TRUE).
• "body_label": the label for the body field of this content type. Optional (defaults to 'Body').
• "locked": boolean indicating whether the administrator can change the machine name of this type. FALSE = changable (not locked), TRUE = unchangable (locked). Optional (defaults to TRUE).

Related topics

Hooks

Allow modules to interact with the Drupal core.

Code

modules/node/node.api.php, line 648

<?php
function hook_node_info() {
  return array(
    'blog' => array(
      'name' => t('Blog entry'),
      'base' => 'blog',
      'description' => t('Use for multi-user blogs. Every user gets a personal blog.'),
    )
  );
}
?>

Login or register to post comments