problem when implementing hook_comment

By tormu on 18 Dec 2007 at 09:25 UTC

I have a mymodule.module and on it I have the following:

function mymodule_comment($comment, $op)
{
	switch ($op)
	{
		case 'insert':
			$to = 'someone@something.com;
			$subject = 'New comment added';
			$body = 'New comment added to the following page: ......';
			drupal_mail('comment-inserted', $to, $subject, $body);
		case 'update':
		case 'view':
		case 'form':
		case 'validate':
		case 'publish':
		case 'unpublish':
		case 'delete':
	}
}

For some reason this doesn't work at all - it stops showing the existing comments completely! Even I strip everything else out and just do it like below, it does the same.

function mymodule_comment($comment, $op)
{
}

$op seems to be Array at some points, so when I have one comment and print_r($op), it prints out

view
Array
(
    [comment_delete] => Array
        (
            [title] => delete
            [href] => comment/delete/3
        )

    [comment_edit] => Array
        (
            [title] => edit
            [href] => comment/edit/3
        )

    [comment_reply] => Array
        (
            [title] => reply
            [href] => comment/reply/48/3
        )

)
form

What makes this even more frustrating is the exact same implementation code works fine if I change the name of the hook implementation to some other activated module, for example taxonomy_breadcrumb_comment. Then the $op is always a string and never Array and it works all right :O

Comments

Sounds like some other part

pobster commented 18 December 2007 at 13:14

Sounds like some other part of your module is altering something it shouldn't, perhaps post the entire thing and I'll look it over?

Pobster

I also tried removing

tormu commented 18 December 2007 at 14:04

I also tried removing everything else than the mymodule_comment() and it's the same.
So even if the mymodule.module only contains "mymodule_comment($comment, $op) { }", it messes it up.

// $Id: mymodule.module

function mymodule_date($timestamp)
{
	$language = i18n_get_lang();
	//Daylight Savings Time
	if(date('I', $timestamp) == 1)
		$timestamp += 3600;
		
	if($language == 'en')
		return format_date($timestamp, 'custom', 'jS F Y');
	elseif($language == 'fi')
		return format_date($timestamp, 'custom', 'd.m.Y');
	elseif($language == 'sv')
		return format_date($timestamp, 'custom', 'j F Y');
	elseif($language == 'zh-hans')
		return format_date($timestamp, 'custom', 'Y.m.d');
}

function mymodule_get_title($nid)
{
	return db_result(db_query('SELECT title FROM {node} WHERE nid=%d',$nid));
}

function mymodule_get_news($sections, $limit = 10) {
	$language = i18n_get_lang();
	$result = pager_query("SELECT n.nid, n.title, n.created, cft.field_teaser_value teaser
							FROM node n INNER JOIN i18n_node i ON i.nid = n.nid
							INNER JOIN content_type_news c ON n.nid = c.nid
							INNER JOIN term_node tn ON n.nid = tn.nid
							INNER JOIN content_field_teaser cft ON cft.nid = tn.nid
							WHERE n.type = 'news' AND i.language = '$language'
							AND tn.tid IN(%s)
							ORDER BY n.created DESC", $limit, 0, null, $sections);
	return $result;
}

function mymodule_print_news($section, $limit = 10) {
	$news = mymodule_get_news($section, $limit);
	
	print "<ul>";
	while($news_item = db_fetch_object($news))
		print "<li>" . l($news_item->title, "node/$news_item->nid") . "<br /><span class=\"grey\">" . check_markup($news_item->teaser, 4, false) . mymodule_date($news_item->created) . "</span></li>";
	print "</ul>";
	
	//Paging links
	print theme('pager', NULL, $limit);
}

//Returns the ID of the newest Frontpage Topstory
function mymodule_frontpage_topstory($site = 'mymodule')
{
	if ($site != 'mymodule')
	{
		$db = 'drupal_' . $site;
		db_set_active($db);
	}

	$sql = "SELECT node.nid, node.title, node.created
			FROM {node}
			INNER JOIN node_data_field_frontpage_topstory ON node_data_field_frontpage_topstory.nid = node.nid
			WHERE node.status = 1
			AND node_data_field_frontpage_topstory.field_frontpage_topstory_value != ''
			ORDER BY node.created DESC
			LIMIT 1";

	$query = db_query($sql);
	
	if($query)
	{
		if(db_num_rows($query) > 0)
			$return = db_fetch_object($query);
		else
			$return = 0;
	}
	else
		$return = db_error($query);
	db_set_active();
	return $return;
	
}

// hook_update_index implementation. Ensure that news ticker nodes are not shown on search
function mymodule_update_index() {
  if (function_exists('search_wipe')) {
    $result = db_query("SELECT nid FROM {node} WHERE type = 'image'");
    while ($data = db_fetch_object($result)) {
      search_wipe($data->nid, 'node');
    }
  }
}

function mymodule_get_columns($limit) {
	$language = i18n_get_lang();
	$result = pager_query("SELECT n.nid, n.title, n.created, cft.field_teaser_value teaser
							FROM node n INNER JOIN i18n_node i ON i.nid = n.nid
							INNER JOIN content_field_teaser cft ON cft.nid = n.nid
							WHERE n.type = 'column' AND i.language = '$language'
							ORDER BY n.created DESC", $limit);
	return $result;
}

function mymodule_print_columns($limit) {
	$columns = mymodule_get_columns($limit);

	print "<ul>";
	while($column_item = db_fetch_object($columns))
		print "<li>" . l($column_item->title, "node/$column_item->nid") . "<br /><span class=\"grey\">" . check_markup($column_item->teaser, 4, false) . mymodule_date($column_item->created) . "</span></li>";
	print "</ul>";
	
	//Paging links
	print theme('pager', NULL, $limit);
}

//Input filtering - replaces [mp3player=url] with Flash MP3 Player embedding html and also reformats the [quotation]-tags
function mymodule_filter($op, $delta = 0, $format = -1, $text = '') {
	switch ($op) {
		case 'list':
			return array(0 => t('MP3 Player filter, Quotation filter'));
		case 'description':
			return t('replaces [mp3player:filename] with Flash MP3 Player embedding html, and [quotation:quote|saidby] with a inline quotation box.');
		case 'settings':
			return $form;
		case 'process':
			$text   = ' ' . $text . ' ';
			if (preg_match_all("/\[(mp3player):([^=\\]]+)=?([^\\]]*)?\]/i", $text, $match))
			{
				foreach ($match[2] as $key => $value)
				{
					$map[$value] = $key;
					$filename = $match[2][$key];
					$url = "/system/files/" . $filename;

					//Wimpy Button
					$replace = "<object classid=\"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\" codebase=\"http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,47,0\" width=\"15\" height=\"15\" id=\"wimpybutton274\">";
					$replace .= "<param name=\"movie\" value=\"http://xxxxxxx\" />";
					$replace .= "<param name=\"loop\" value=\"false\" />";
					$replace .= "<param name=\"menu\" value=\"false\" />";
					$replace .= "<param name=\"quality\" value=\"high\" />";
					$replace .= "<param name=\"bgcolor\" value=\"#undefined\" />";
					$replace .= "<param name=\"wmode\" value=\"transparent\" />";
					$replace .= "<param name=\"flashvars\" value=\"theFile=$url&playingColor=FFFFFF&rollOverColor=000000&displayRewindButton=no\" />";
					$replace .= "<embed src=\"http://xxxxxxx\" flashvars=\"theFile=$url&playingColor=FFFFFF&rollOverColor=000000&displayRewindButton=no\" width=\"15\" height=\"15\" bgcolor=\"#undefined\" loop=\"false\" menu=\"false\" quality=\"high\" name=\"wimpybutton274\" align=\"middle\" allowScriptAccess=\"sameDomain\" type=\"application/x-shockwave-flash\" pluginspage=\"http://www.macromedia.com/go/getflashplayer\" wmode=\"transparent\" /></object>";
					$mtch[] = $match[0][$key];
					$repl[] = $replace;
				}
				$text = str_replace($mtch, $repl, $text);
			}
			//REPLACE THE QUOTATIONS
			if (preg_match_all("/\[(quotation):([^=\\]]+)=?([^\\]]*)?\]/i", $text, $match))
			{
				foreach ($match[2] as $key => $value)
				{
					$wholeQuote = $match[2][$key];
					$parts = explode("|", $wholeQuote);
					$quote = $parts[0];
					$saidBy = $parts[1];

					if(empty($saidBy))
						$replace = "<div class=\"quote\"><strong>&#8220;$quote&#8221;</strong></div>";
					else
						$replace = "<div class=\"quote\"><strong>&#8220;$quote&#8221;</strong><br />- $saidBy</div>";
						$mtch[] = $match[0][$key];
						$repl[] = $replace;
				}
				$text = str_replace($mtch, $repl, $text);
			}
			return $text;
		default:
			return $text;
	}
}

//Due to unknown problem (http://drupal.org/node/201943) this implementation is called with another module's name
function mymodule_comment($comment, $op)
{
	switch ($op)
	{
		case 'insert':
		case 'update':
		case 'view':
		case 'form':
		case 'validate':
		case 'publish':
		case 'unpublish':
		case 'delete':
	}
}

Okay well, nothing looks out

pobster commented 18 December 2007 at 14:54

Okay well, nothing looks out of the ordinary I guess? So perhaps try looking at another module which successfully implements hook_comment (http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/spam/spam.m...)

I'm not able to upload anything to my test site from where I am at the moment to do any detective work, but it seems though that the spam module works fine (I use it myself)... I'm sure it won't help though as you said that even when the hook doesn't do anything and is just present that the comments are erased? I guess it's still probably going to be quite helpful to look at the spam module code though and see if it does anything else which you haven't thought of?

Pobster

This is the first time

tormu commented 18 December 2007 at 23:23

This is the first time Drupal is acting up really bad for me, there haven't been any total WTF moments before but this one sure is..
Yep - even if the whole function is completely empty but introduced, it hides the comments. Nothing fancy done with comment module either.

I've also checked other modules that implement the comment hook, but can't find anything that leads to this problem :(

...

mooffie commented 20 December 2007 at 00:45

What makes this even more frustrating is the exact same implementation code works fine if I change the name of the hook implementation to some other activated module, for example taxonomy_breadcrumb_comment.

So the name, and only the name, of the function, mymodule_comment, has some significance --which we need to find out. Drupal recognizes it as somthing; and calls it. It seems that we have accidentally implemented some hook. Printing the call stack would have easily solved the mystery.

it stops showing the existing comments completely!

Usually, when hooks return nothing, it breaks nothing. Let's think. It must be some enigmatic hook_comment. But this hook_comment isn't a normal hook: it breaks something; it affects something; what we see. Oh, it's easy: (WARNING: spoiler ahead!)

You have a theme by the name "mymodule". So when drupal does theme('comment', $comment, $links) when printing your comments it ends up as mymodule_comment($comment, $links).

--
Help save BLOCKQUOTE

correct

tormu commented 21 December 2007 at 07:58

Yeah you've got it - I have a theme that is named the same as the module is :P

Any idea how to correct this then? Would it help if I override the comment theming in template.php or so? The site is 97% ready from launching, so I wouldn't like to change the name of the theme, since we have tens of nodes in which some image paths are set to absolute (/sites/all/themes/mymodule/img/....)

3 years later :)

Jenechka commented 18 September 2010 at 15:22

I had the same problem. And I resolved it with renaming mymodule_comment() function to menu_comment(), because menu module does not have this hook. Name conflict was gone.

PS Big thanks to mooffie. I could not imagine what the problem is with this hook.

Holy ****. I never would have

charlie-s commented 3 July 2011 at 18:49

Holy ****. I never would have come to that conclusion. Thanks a million for posting this.

problem when implementing hook_comment

Comments

Sounds like some other part

I also tried removing

Okay well, nothing looks out

This is the first time

...

correct

3 years later :)

Holy ****. I never would have

New forum topics

News items

Our community

Documentation

Drupal code base

Governance of community