function hook_shoutbox in Shoutbox 7

Same name and namespace in other branches

1. 6.2 shoutbox.api.php \hook_shoutbox()
2. 7.2 shoutbox.api.php \hook_shoutbox()

Implementation of hook_shoutbox()

See shoutbox_group for a detailed example

Parameters

$op: The current operation (see code below)

$shout: The shout object used in the operation

$a1: An additional parameter that contains data based on the operation

$form_state: The form state of the shout form. Usually only used on the shoutbox form. Modules like shoutbox_group attach extra data to the form with a form_alter.

6 functions implement hook_shoutbox()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

shoutbox_domain_shoutbox in shoutbox_domain/shoutbox_domain.module

Implements hook_shoutbox().

shoutbox_group_shoutbox in shoutbox_group/shoutbox_group.module

Implementation of hook_shoutbox()

shoutbox_points_shoutbox in shoutbox_points/shoutbox_points.module

Implements hook_shoutbox().

shoutbox_rules_shoutbox in shoutbox_rules/shoutbox_rules.module

Implements hook_shoutbox().().

shoutbox_tags_shoutbox in shoutbox_tags/shoutbox_tags.module

Implements hook_shoutbox().

... See full list

File

./shoutbox.api.php, line 18

Code

function hook_shoutbox($op, &$shout, &$a1 = NULL, $form_state = NULL) {
  switch ($op) {
    case 'insert':

      // A shout was just added.
      break;
    case 'presave':

      // A shout is about to be saved
      // ********** IMPORTANT**********
      // If it recommended that in presave, you set $shout->module to the name of your
      // module. This will prevent shoutbox from displaying your module's shouts on
      // general shoutboxes - unless that is what is desired.
      break;
    case 'edit':

      // An edited shout is about to be saved.
      break;
    case 'view':

      // A shout is about to be viewed.
      break;
    case 'unpublish':

      // A shout is being unpublished.
      // Will not be called if a shout is initially saved unpublished.
      break;
    case 'publish':

      // A shout is being published.
      // Will not be called if a shout is initially saved published.
      break;
    case 'delete':

      // A shout was just removed.
      break;
    case 'link':

      // Alter the link to the shoutbox page.
      $a1 = 'shoutbox/something/custom';
      break;
    case 'form':

      // Alter the shoutbox add form.
      $a1['new_field'] = array(
        '#type' => 'textbox',
        etc,
      );
      break;
    case 'js path':

      // Alter the AJAX callback path.
      $a1 = 'something/js/callback';
      break;
    case 'context':

      // Set a shoutbox "context", for example, indicating the current group.
      // These will be passed into hook_db_rewrite_query() so you can alter
      // the shout query accordingly.
      $a1['shoutbox_group'] = $group->nid;
      break;
  }
}