Follow us on Twitter!
Syndicate content
Login - Register - Latests submissions

Drupal 7.x

There are some conventions when using contributed modules and/or themes. Most users would want to place them in modules and themes folders.

Don't ever do that! Never place modules or themes in these directories!

Everything added to a fresh Drupal install should go somewhere in the sites directory:

  • Contributed modules (from drupal.org) should go in sites/all/modules/contrib
  • Project custom modules should go in sites/all/modules/custom
  • Contributed themes (from drupal.org) should go in sites/all/themes/contrib
  • Project custom themes should go in sites/all/themes/custom

Note that if you have a multisite environment, you could place somes of the modules/themes:

  • in sites/default/..
  • or sites/example.com/..
  • or sites/anotherdomain.com/..
  • and so on..

... depending on your configuration.

Note that using a contrib and custom directory convention will help you find out which modules are contributed by the drupal community and which you have developped specifically for the website.

This will allow you to update more easily your websites as the only directory you will need to preserve will be sites/*.

To let users translate your module strings, you must use the t() function. This allows the Drupal community to create translation files *.po. But this also allows user to tweak some strings to fit their needs, with the String Overrides module.

So everytime your write a sentence or a word in your module, surround your string with the t() function.

This is the bad way:

$foo = "Thank you for your submission";

This is the good way:

$foo = t("Thank you for your submission");

Note that you must always write your module strings in English as this is the default language in Drupal and is used as a base to provide the localization system.

You will need to insert values in your strings:

Don't write:

$points = 3;
$foo = t("You just won $points points");

This is the good way to insert placeholders values:

$points = 3;
$foo = t("You just won !points points", array('!points' => $points));

Check out the resources links to learn more about t() function use.

Note that starting with Drupal 6, you can also make your JavaScript files translatable.

In your code use Drupal.t() function. Example:

greetingMessage = Drupal.t("Your vote has been saved!");

When developping a module, we often use some commonly used PHP functions. As you may not know Drupal provides some overrides for these functions. They are often related to strings, they have the same name as their PHP native equivalent except that they are prefixed with drupal_. Here is a list of PHP functions you should replace with its Drupal equivalent:

  • Replace strlen() with drupal_strlen()
  • Replace strtoupper() with drupal_strtoupper()
  • Replace strtolower() with drupal_strtolower()
  • Replace ucfirst() with drupal_ucfirst()
  • Replace substr() with drupal_substr()
  • Replace eval() with drupal_eval()
  • Replace clone with drupal_clone()

For more on this, you should read includes/unicode.inc and includes/common.inc.

SEO SEO

Google analytics is a free and useful tool for getting information about your site visitors, and there is little reason not to set it up on your site before launch.

You will need a GA account, and know it's account number. Install the GA module linked, and enter the account number into /admin/settings/googleanalytics and customize if desired.

When using GA in Germany you have to publish "datenschutzrechtliche Hinweise" on your site to inform users, that some of their data - e.g. IP-adress - will be tracked. Normally you set up a text block in your imprint. Using GA is maybe not conform with contemporary requirements of protection of private data.

Having an .htaccess file is a pain regarding performances. Apache needs to read it on every single request (the page, every image, CSS files, JS files, etc.).

It is strongly recommended to move rules defined in Drupal .htaccess file in your Apache global configuration or in your vhost configuration file. This way all rules are only loaded 1 time, during Apache start.

To achieve this, just copy/paste your .htaccess content in your Apache server configuration file and don't forget to surround it by the directory where your Drupal install resides.

<Directory /var/www/path/to/drupal/directory/>
  AllowOverride None
  ###      ALL YOUR .HTACCESS CONTENT GOES HERE    ###
</Directory>

Note that we added AllowOverride None to prevent Drupal .htaccess to be read by Apache.

Check for syntaxe error:

$ apachectl configtest

And restart Apache:

$ apachectl restart

Note that if you are on Plesk, you must use the following command before restarting Apache:

$ /usr/local/psa/admin/sbin/websrvmng -u --vhost-name=example.com

Drupal comes with a set of TXT files at root level (things like install instructions, upgrade instructions, etc.). To avoid malicious users to have information on the Drupal version you are using, it is strongly recommended to remove those files.

From the root directory of your installation, remove the following files:

  • CHANGELOG.txt
  • COPYRIGHT.txt
  • INSTALL.mysql.txt
  • INSTALL.pgsql.txt
  • INSTALL.txt
  • LICENSE.txt
  • MAINTAINERS.txt
  • UPGRADE.txt

Whether or not these files contains security information (like Drupal version for example), the all contain a CVS header that gives a really precise version information on your Drupal installation.

Cron is a deamon which triggers certain actions (cron jobs) at configured times. Windows has an equivalent system called Task Scheduler. Calling cron.php at regular intervals will allow, amongst others, the indexation of content the content and to check for updates.

Setting up a cron job under a *nix system is fairly easy.

  1. Create or edit a crontab by typing in a terminal crontab -e
  2. Assuming that you have one of the following programs on your system, add one of the following line to trigger a request to cron.php every hour:
    • 0 * * * * /usr/bin/wget -O - -q -t 1 http://example.com/cron.php
    • 0 * * * *  /usr/bin/lynx -source http://example.com/cron.php
    • 0 * * * * curl --silent --compressed http://example.com/cron.php
  3. Save and exit your editor.

Setting up cron jobs on Windows is almost as easy! See Resources below.

Drupal logs information about cron jobs. Once you have configured it, you should see entries in your logs (Administer > Reports > Status report and Administer > Reports > Recent log entries) indicating the status of the related tasks.

fp

By default Drupal front page lists all nodes promoted to front page. We will often want the front page to display something different (a View, a panel, a node, etc.). To do so:

  • Go to Administer > Site configuration > Site Information
  • Set Default front page to the path of your View, Panel, node or anything.
  • Save your settings

Note that the default value for Default front page is node.

There are a number of settings for contact forms that are easy to miss, since they aren't readily visible on the site. After you are sure that all the settings are right, you should also submit a test contact on every unique contact form to make sure the email address actually works.

The Site Information settings page at /admin/settings/site-information contains the from address setting.

/admin/build/contact has "To:" addresses and auto-responders, etc.

If you use Webforms, there are similar settings at /admin/settings/webform and per-node at /admin/content/webform (minimally, check the to address in each webform node).

Create a node (a page content type for example) with some extra information so that your visitors don't ever fall on the default 404 page not found.

Once this node is created:

  • Remember its node ID,
  • Go to Administer > Site configuration > Error reporting
  • Set Default 404 (not found) page to the node ID you just created
  • Save your settings

You can alternatively use the Search 404 module.

Use full PHP tags

Write:

<?php print $foo; ?>

Don't write:

<? print $foo; ?>

Semicolons
Write:

<?php print $foo; ?>

Don't write:

<?php print $foo ?>

No closing tags
When writing a module or customizing your theme template.php, don't use PHP closing tag ?>.

Notice that at the bottom of the following snippet, there is no PHP closing:

<?php
// Your file starts here
function phptemplate_foo() {
  return $bar;
}
// Your file ends here
// Don't add PHP closing tag

By doing this you prevent PHP interpreter to stop and restart on the next source code file. This mean better performance.

Considering the domain name drupal-check.org, we want to redirect all users accessing your website from http://drupal-check.org to http://www.drupal-check.org.

Edit .htaccess file from the root directory of your Drupal installation, find the <IfModule mod_rewrite.c> section and uncomment the following lines, replacing example.com with your own domain name, in this example drupal-check.org:

RewriteCond %{HTTP_HOST} ^drupal-check\.org$ [NC]
RewriteRule ^(.*)$ http://www.drupal-check.org/$1 [L,R=301]

More information is provided in the .htaccess file itself.

It is recommended that websites provide translated versions of their online content in multiple languages for maximum reach. NativeTung - http://www.nativetung.com - is a powerful solution that works with the Drupal CMS platform.

Drupal makes it easy to achieve the following with the NativeTung Globalizer: Globalize --> Optimize --> Analyze your site for increased ROI and reach across the language barrier.

It is strongly recommended that you put your site off-line before performing any module/theme updates.

  • Go to Administer > Site configuration > Site maintenance
  • Set Site status to Off-line
  • Save your settings
  • Make a backup of your database and file structure
  • Upload new files to your server
  • As user 1, run http://www.example.com/update.php
  • Be sure to check that everything works fine after the update process
  • Go to Administer > Site configuration > Site maintenance
  • Set Site status to Online
  • Save your settings

During site development, test content will have to be created so that features can be tested and styled. However, you don't want that test content to go live!

First off, avoid making any content that could potentially be damaging if it accidentally went live. The Devel module can generate content of most types for you automatically, in a way that is clearly test content and won't accidentally offend anyone.

When you are ready to go live, go through the user and content lists to remove anything that shouldn't be available. Also, browse through the entire site structure and look for menu links that shouldn't be appearing.

Sometimes, you won't have content for a section, but for layout or structure reasons it has to be in place. Make the text of the page say something like "Coming Soon" so it's apparent that the page is important, and get it resolved as soon after the live launch as possible.

If you are working with a code repository (like svn, git, etc.) you might have found it useful to set up a cron job that regularly runs a script that in turn triggers the update of your code on the server. While this is nice while developing it may be disastrous in production environment!

Make sure to disable any automated update of your code before going live.

fp