Create a node type programmatically

Submitted by elyzium on Tue, 2019-03-26 17:43

Example of writing a node module that lets users add a job posting to a site. A job posting node will include a
title, a body where the details of the job posting will be entered, and a field where the user can enter the
name of the company. For the job posting title and a body, I’ll use the built-in node title and body that
are standard with all Drupal nodes. I’ll need to add a new custom field for the company’s name.
I’ll start by creating a folder named job_post in your sites/all/modules/custom directory.

1. job_post.info file:

name = Job Post
description = A job posting content type
package = French
core = 7.x
files[] = job_post.install
files[] = job_post.module

2. job_post.install
The install file for the job post module performs all of the set-up operations for things like defining the
node type, creating the fields that make up our new node type, and handling the uninstall process when
an administrator uninstalls the module.

/**
* @file
* Install file for Job Post module.
*/
/**
* Implements hook_install().
* - Add the body field.
* - Configure the body field.
* - Create the company name field.
*/
function job_post_install() {
  node_types_rebuild();
  $types = node_type_get_types();
  // add the body field to the node type
  node_add_body_field($types['job_post']);
  // Load the instance definition for our content type's body
  $body_instance = field_info_instance('node', 'body', 'job_post');
  // Configure the body field
  $body_instance['type'] = 'text_summary_or_trimmed';
  // Save our changes to the body field instance.
  field_update_instance($body_instance);
  // Create all the fields we are adding to our content type.
  foreach (_job_post_installed_fields() as $field) {
    field_create_field($field);
  }
 
// Create all the instances for our fields.
foreach (_job_post_installed_instances() as $instance) {
    $instance['entity_type'] = 'node';
    $instance['bundle'] = 'job_post';
    field_create_instance($instance);
  }
}
 
/**
* Return a structured array defining the fields created by this content type.
* For the job post module there is only one additional field – the company name
* Other fields could be added by defining them in this function as additional elements
* in the array below
*/
 
function _job_post_installed_fields() {
  $t = get_t();
  return array(
    'job_post_company' => array(
      'field_name' => 'job_post_company',
      'label' => $t('Company posting the job listing'),
      'type' => 'text',
    ),
  );
}
 
/**
* Return a structured array defining the field instances associated with this content type.
*/
function _job_post_installed_instances() {
  $t = get_t();
  return array(
    'job_post_company' => array(
      'field_name' => 'job_post_company',
      'type' => 'text',
      'label' => $t('Company posting the job listing'),
      'widget' => array(
        'type' => 'text_textfield',
      ),
    'display' => array(
      'example_node_list' => array(
        'label' => $t('Company posting the job listing'),
        'type' => 'text',
        ),
     ),
  ),
 );
}
 
/**
* Implements hook_uninstall().
*/
function job_post_uninstall() {
  // Gather all the example content that might have been created while this
  // module was enabled.
  $sql = 'SELECT nid FROM {node} n WHERE n.type = :type';
  $result = db_query($sql, array(':type' => 'job_post'));
  $nids = array();
  foreach ($result as $row) {
    $nids[] = $row->nid;
  }
  // Delete all the nodes at once
  node_delete_multiple($nids);
 
  // Loop over each of the fields defined by this module and delete
  // all instances of the field, their data, and the field itself.
  foreach (array_keys(_job_post_installed_fields()) as $field) {
    field_delete_field($field);
  }
  // Loop over any remaining field instances attached to the job_post
  // content type (such as the body field) and delete them individually.
  $instances = field_info_instances('node', 'job_post');
  foreach ($instances as $instance_name => $instance) {
    field_delete_instance($instance);
  }
  // Delete our content type
    node_type_delete('job_post');
  // Purge all field infromation
  field_purge_batch(1000);
 }

3.job_post.module
Last, you need the module file itself. Create a file named job_post.module, After you’ve completed the module, you can enable the module
on the module listings page (Modules). You begin with the opening PHP tag and Doxygen comments.

/**
* @file
* This module provides a node type called job post
*/
 
/**
* Implements hook_node_info() to provide our job_post type.
*/
function job_post_node_info() {
  return array(
    'job_post' => array(
    'name' => t('Job Post'),
    'base' => 'job_post',
    'description' => t('Use this content type to post a job.'),
    'has_title' => TRUE,
    'title_label' => t('Job Title'),
    'help' => t('Enter the job title,
      job description, and the name of the company that posted the job'),
    ),
  );
}

A single module can define multiple node types, so the return value should be an array. Here’s the
breakdown of metadata values that may be provided in the node_info() hook:
"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 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”).
"locked": Boolean indicating whether the administrator can change the
machine name of this type. FALSE = changeable (not locked), TRUE =
unchangeable (locked). Optional (defaults to TRUE).

Comments

AlfredoLow (not verified)

Sun, 2020-02-02 01:51

Main menu

Status message

You are here

All Tags

Top 30 viewed articles

Create a node type programmatically

Tags:

Comments

Pages

Add new comment

Filtered HTML

Plain text

To Do List