Change comment wrapper title [#2637732]

Add the ability to change / update the comment wrapper title when a comment is added / deleted.

In our use case, the number of comments on the node is displayed as '# comments' - which is not changed when a new comment is added.

Comment	File	Size	Author
#4	test_ajax_comments.zip	2.82 KB	John Cook
#4	ajax_comments-2637732-4.patch	4.52 KB	John Cook
#4
#2	ajax_comments-2637732-2.patch	2.29 KB	John Cook
#2

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

18 December 2015 at 16:06

John Cook created an issue. See original summary.

Comment #2

John Cook CreditAttribution: John Cook at Curve Agency commented 18 December 2015 at 16:32

Status:

Active

» Needs review

File	Size
ajax_comments-2637732-2.patch	2.29 KB

I have solved this be creating a hook which is processed when a comment is added or deleted. This gives developers the ability to tailor the title to there requirements without having to hack ajax_comments and end up with unsupported code.

The hook hook_ajax_comments_title() expects a node id and returns the new title or NULL if it isn't to be changed.

Comment #3

formatC'vt CreditAttribution: formatC'vt as a volunteer commented 18 December 2015 at 17:59

Status:

Needs review

» Needs work

Thanks, nice feature, but i think we should implement something like hook_ajax_comments_custom_commands (and custom commands for _insert, _delete, etc), not a wrapper title specific hook.
What do you think?

Comment #4

John Cook CreditAttribution: John Cook at Curve Agency commented 3 March 2016 at 12:53

File	Size
ajax_comments-2637732-4.patch	4.52 KB

test_ajax_comments.zip	2.82 KB

I've refactored #2 to use the more generic hook_ajax_comments_custom_commands(). I've added insert and delete hooks so different ajax command can be called. Also, I've created hook_ajax_comments_custom_commands_alter() so the commands array can be inspected, and changed if necessary, by other modules.

The order the hooks are called is:

Common; hook_ajax_comments_custom_commands()
Specific; is hook_ajax_comments_custom_commands_insert()
Alter; hook_ajax_comments_custom_commands_alter()

Attached is test_ajax_comments.zip. This contains a module to check the hooks are working. For each hook, it dpm()s the passed in parameter and also puts it in the 'Recent log messages' table (the page needs to be refreshed to get the dpmed output to be displayed). The common hook also changes the title of the comment section and uses the same code as in ajax_comments.api.php.