How to create your own simple node type (4.7)

How to create your own simple node type...

• A simple node type is the most basic of node types such as 'page' and 'story' node types, with a title, teaser, body, etc.
• Why would you want or need this...
  The answer stems from a discussion about the Difference Between Page and Story
  and that ultimately each node type allows for separate theming, categorization, descriptions, etc...
• This example walks you through copying the 'story.module' and making the appropriate changes to the php code for your new simple node type.
• There are no database changes or hacking of code, the result will be a new module file that you will need to upload into its own module directory.
• What you need...
  • means to download/upload files to your modules directory
  • a text editor
  • a little php knowledge is helpful, but not required
  • some information about your node type
    • a technical-name for your node type - limit 32 characters - don't use the name of an existing module - no spaces, numbers or punctuation unless you know what you're doing
    • a user-friendly-name for your node type (and a plural version of this name) (this is how your node type will appear in most places on your site) - spaces and numbers are ok but again no punctuation unless you know what you're doing, note: you can use the same name as your technical-name above
    • a module-description - a short description of your node type that will appear on the administer->modules page - don't use quotes or apostrophes unless you know what you are doing
    • a create-content description - a short description of your node type that will appear on the create content page - don't use quotes or apostrophes unless you know what you are doing
    • a help-description - a short description of your node type that will appear on the help page - don't use quotes or apostrophes unless you know what you are doing
    • drupal-help-text and link - (these are specifically provided for you below)
    • an optional title-caption for the title field in the node entry/edit form if something other than 'Title' is desired - don't use quotes or apostrophes unless you know what you are doing
    • an optional body-caption for the body field in the node entry/edit form if something other than 'Body' is desired - don't use quotes or apostrophes unless you know what you are doing
• In the following bolded text in the code boxes is intended to show where the code changes. Quotes and apostrophes in the code are important, please place close attention.

As an example... say you want a simple press release node type.

• technical-name = release
• user-friendly-name = press release
• user-friendly-plural = press releases
• module-description = Enables the creation of press releases.
• create-content-description = Create a press release.
• help-description = Press Releases are notices sent to various media outlets informing them of some note-worthy information.
• drupal-help-text = This module was created by [your name here], following directions posted at drupal.org <a href="%release">How to create your own simple node type (from story node) (Drupal 4.7)</a>
  IMPORTANT: Note the use of our technical-name release in the drupal help text above (underlined for emphasis only), you should change the underlined text to your technical-name. You should also change [your name here] to your actual name. The rest of the text should be left as is (unless you know what you are doing).
• drupal-help-link = http://www.drupal.org/node/40684
• title-caption (optional) = Press Release Title
• body-caption (optional) = Press Release Body

I specifically use an example that has a different technical-name and user-friendly-name so that it is a little more clear in the changes where the two are used, but many node-types that exist (or that you may want to create) use the same value.

• Download the story.module file from the modules directory
• Save it as your technical-name .module in our example the file will be named release.module
• Open the new file in your text editor

Now, without getting into too many details on drupal modules and php code....
The first line of code should be <?phpdon't touch that

The next line of code will be something like...

You should remove this, so that there is no confusion with the story module

The next couple lines of code should be

change the bolded text above to your user-friendly-plural, in our example press releases seen below

The story.module file allows for story node types. The module file implements the following 7 drupal hooks

• hook_help
• hook_node_info
• hook_perm
• hook_access
• hook_menu
• hook_form

Before each hook is implemented you should you will see a php comment

for hook_help...

and for hook_node_info...

etc...

After the comment, the hook function is called, but instead of the word hook the word story is used as this module was originally for story nodes.

for hook_help...

and for hook_node_info...

etc...

In the function calls change story to your technical-name, in our example release

for hook_help...

becomes

and for hook_node_info

becomes

etc...

We will be changing all 7 in the following steps, plus a few more things...

Here are the changes, moving down the file, starting at the top
Again noting that in the following bolded text in the code boxes is intended to show where the code changes. Quotes and apostrophes in the code are important, please place close attention.

1. hook_help
hook_help shows helpful information in various places...
NOTE - this function has the most changes, so if you can get thru this one, the rest are a breeze.
for the curious: this 4.7 hook_help implementation was expanded with additional help text from 4.6

hook_help original

to change this function, we need most of our new node type information...

hook_help using our press release example

2. hook_node_info
hook_node_info registers the node type with drupal
for the curious: hook_node_info is new in 4.7 and replaced hook_node_name in 4.6

hook_node_info original

to change this function, we need our technical-name and our user-friendly-name

hook_node_info using our press release example

3. hook_perm
hook_perm assigns names for permissions that may exist for this node type (these need to agree with hook_access below)
for the curious: this 4.7 hook_perm implementation is the same as the 4.6 implementation

hook_perm original

to change this function, we need our technical-name and our user-friendly-plural

hook_perm using our press release example

4. hook_access
hook_access checks your permissions against a user and what the permission allows (these need to agree with hook_perm above)
for the curious: this 4.7 hook_access implementation is the same as the 4.6 implementation

hook_access original

to change this function, we need our technical-name and user-friendly-plural

hook_access using our press release example

5. hook_menu
hook_menu allows the node type to show in various menus, in this case just the create content menu (note the 'create' permission should agree with above)
for the curious: this 4.7 hook_menu implementation is the same as the 4.6 implementation

hook_menu original

to change this function, we need our technical-name, user-friendly-name and user-friendly-plural

hook_menu using our press release example

6. hook_form hook_form allows for a form for adding, editing and deleting nodes of the type for the curious: this 4.7 implementation of hook_form is substantially different from 4.6 hook_form original

to change this function, we need our technical-name and our two optional captions (note the optional captions are underlined for emphasis and do not need to be changed)

hook_form using our press release example

That's it for the code changes. Hopefully not too difficult.

Next

• Save the file, you're now ready to upload
• Create a directory in the modules directory with your technical-name; in our example the directory will be named release
• Upload your new module file to your new directory
• Go to your site, administer -> modules, you should see your new module listed, enable it as with any other module.
  Note: if you go to your administer -> modules page and get a white screen, it means you have an error in the php code of your new module, delete the file from your new directory and everything should be fine.
  You need to fix your new module, but it is probably easier to start over, re-read the directions and follow them carefully, if it still doesn't work, then consider these directions a bunch of bunk and try something else.

Your new node type should work the same as with page and story nodes, you will need to enable access to them (administer->access control), configure them (administer->settings->content types), allow for categorization (administer->categories), etc.

Sorry for the long directions, I hope they are understandable and usable.