Skip to main content

theme(INSTANCE, $var) VS theme_INSTANCE($var)

The following is most common for functions like theme('table', $var) that are included by default in Drupal core instead of calling straight theme_table($var). Since theme_table is stored in includes/theme.inc file it is always available. It might be stored in a file not always loaded though. In that case theme('table', $var) would be our only way. What's the difference though?

If we check the theme_table() function (@see https://api.drupal.org/api/drupal/includes!theme.inc/function/theme_table/7) we will read the following lines:
$header = $variables['header'];
$rows = $variables['rows'];
$attributes = $variables['attributes'];
$caption = $variables['caption'];
$colgroups = $variables['colgroups'];
$sticky = $variables['sticky'];
$empty = $variables['empty'];


This requires the header, rows, attributes, capton, colgroups, sticky and empty keys to exist even with no content. If a key is not found, an error is written to the watchdog table. Each error is of course a request to the database to insert the error message for display by the admin. If we want to create a table without any erros to the database or to the error_log file of our server, we have to make sure all the indexes above exist! Or we can recall what we define in any hook_theme() implementation (@see https://api.drupal.org/api/drupal/modules!system!system.api.php/function/hook_theme/7).

In our return array, as stated in the documentation, we may return a variables index key. This key must be a variable where "each array key is the name of the variable, and the value given is used as the default value if the function calling theme() does not supply it. Template implementations receive each array key as a variable in the template file (so they must be legal PHP variable names). Function implementations are passed the variables in a single $variables function argument.". Therefore, it is better to call theme('table', ...) or theme('item_list', ...) instead of theme_table(...) or theme_item_list(...) since this way we allow the function to be correctly called, having all the values required set at least to their default values!

Comments

Popular posts from this blog

Configure drupal_http_request() on the fly

The drupal_http_request() function supports connections using a proxy. You can configure a global proxy to use for all drupal_http_request() callbacks from the settings.php file of your website/installation by filling the following lines with the proper information:For those of you preferring a UI, then HTTP proxy module is for you.But what if you only want to use a proxy in some cases; like a custom module? In that case you will need the following function(modify accordingly):Now all you have to do is Call <?php _MYMODULE_change_proxy(); ?>.Do your drupal_http_request() calls.Call <?php _MYMODULE_change_proxy(TRUE); ?> to reset your previous settings.

Drupal: Allow registrations through Invite or Referral modules only

The Invite module provides invitations from existing users to their contacts. The Referral module, in contrary, creates a special URL for each existing user, which can be found in each user's profile, and allows new user registration. Even though, these two modules seem to provide the same functionality, they don't (and they shouldn't). Invite module, provides a mechanism for a site administrator to limit new registrations to "Invitations only". Referral module doesn't provide any of this functionality. Some users have requested the Invite module and Referral module to join in one module. Until now, there isn't anything to that direction. Wouldn't it be great though if there was a solution to limit drupal registration to referral or invitation only? Copy the functions below to a refinvite.module file in your sites→all→modules→refinvite folder and enable the module. Then go to http://<your-address-here>/admin/user/settings and enable the new …

Send mass email to certain users using VBO

Views Bulk Operations uses the built-in actions to act upon nodes, users, entities etc. Among these actions is our ability to send emails to users. If you try to use this action though you will encounter a small but serious problem. You are asked for an email address to send your message. You might say "but I have selected the users I want this message to reach. Why should I input an address again?". Don't get overwhelmed. What this field expects is not an address but a token. Specially this token [user-email]. If the website is intended for you, then you might say that's not such a problem to write this token down again and again. But if the manager of the website is bound to be the client or if you just want to spend less time writing things down, you might prefer to use a custom hook_form_alter() callback to set a default value. It could be done in both theme and module environment so suit yourself. Just add the following in your module or theme.