Drupal 7.x Development - Naming conventions

Question

Because of a recent project I need to dig into this drupal thing and try to fix a bug inside.

I am a drupal CMS beginner,and studying this CMS for several days, also going through the drupal module development website.

But I still have no clue about how to do proper development in Drupal, especially the function naming, database table naming, and relationship between .module, .info and so on.

e.g. hook_revision_publish become revisioning_revision_publish

My question:

How are names mapped and what is the sequence of functions that are called (the workflow?)

Hope that my question is clear and help someone to shorten the learning path of Drupal.

Thank you very much in advance for helping.

Answer 1

From the sound of the question you are looking for a simple overview to help you get started. I would suggest that rather than initially tracing the way that the (labyrinthian) drupal core passes requests through functions, you should start with looking at how simple modules and themes connect to it to get an idea of the larger design pattern. Once you have an idea of the concepts and terminology used, the commented code examples are invaluable for this, giving examples of things you can do, and describing how to accomplish it.

Basically, as Djouuuuh points out, you can safely leave drupal core to do its thing. That is why you will work exclusively within the sites directory. Your interaction as a developer is to configure the installation to behave how you you would like (site building), create themes to customise display (theming) and create modules (development) to match very site-specific functionality. Always look to existing, supported modules first, it will save you a lot of time, even if must add to their functionality with your own module.

To understand the naming conventions for files and functions used in modules and themes, you will need to learn about the hook system and then look to the examples and the API(via google) to understand the uses of those hooks. More than likely you will rely heavily on just a few hooks to start with, for example hook_menu, hook_node_load, hook_form_alter (forms are a big subject).

Drupal.org holds extensive documentation about development methods.

Also Jeff Eaton of lullabot looks to have created a good slideshow on the subject of drupal development, which might be worth a click through.

Answer 2

I'm a bit surprised that you haven't found anything on the internet that could answer your questions. Here is an article about coding standards for Drupal.

Anyway, here are several things I always do with naming, functions and directories (that doesn't mean it's the best conventions):

• The only directory you should work in is ./sites (please never ever edit something in the other directories).
• The contribute modules you download should be placed in ./sites/all/modules/contrib
• The custom modules that you develop yourself should be placed in ./sites/all/modules/custom
• When you create a custom module, chose a simple and suitable name of it, preceded by the name of your project (better), for example myproject_blog.
• The .module and .info files should have the same name as your module's, for example myproject_blog.module and myproject_blog.info. It will automatically make the relationship between them.
• All the functions that appear in your .module file should be named by your module's name, for example myproject_blog_revision_publish().
• If your custom module needs a table in your database, the name of your module has to show up somewhere, for example $schema['myproject_blog']. If you need more than one table, keep the prefix and add some explicit suffix.
• Idem for the custom themes in ./sites/all/themes.

If I forgot something, just ask ;)