Forum Subscription Indicator/Links on ForumHome

Description:

This hack will add an indicator to each Forum on ForumHome (and to subforums in ForumDisplay) that indicates whether the forum has been subscribed to.
The indicator can be clicked to Add/Remove the subscription to the forum.

Hack Overview:
Queries added: 0
Files to modify: 2 (1 if you have no subforums)
Templates to edit: 5
Phrases to add: 2
New Image files: 2

================================================== =======
Instructions:

<file edits>

Step 1) Edit index.php
Find:

PHP Code:

cache_ordered_forums(1,); 


and replace with:

PHP Code:

cache_ordered_forums(1, 0, $bbuserinfo['userid']); 


Step 2) Edit forumdisplay.php (only necessary if you have subforums)
Find:

PHP Code:

cache_ordered_forums(1, 1); 


and replace with:

PHP Code:

cache_ordered_forums(1, 1, $bbuserinfo['userid']); 


<phrase additions>

Step 3) Add GLOBAL phrase
Varname: subscribed_click_to_unsubscribe
Text: Currently Subscribed - Click to REMOVE Subscription

Step 4) Add GLOBAL phrase
Varname: unsubscribed_click_to_subscribe
Text: Currently UNsubscribed - Click to ADD Subscription

<template edits>

Step 5) Edit FORUMDISPLAY (only necessary if you have subforums)
Find:

<td class="thead" width="100%" align="$stylevar[left]">$vbphrase[forum]</td>

after it ADD:

<td class="thead">$vbphrase[subscribe]</td>

Step 6) Edit FORUMHOME (4 changes)
(1)Find:

<td class="tcat" colspan="<if condition="$vboptions['showmoderatorcolumn']">6<else />5</if>">

CHANGE it to:

<td class="tcat" colspan="<if condition="$vboptions['showmoderatorcolumn']">7<else />6</if>">

(2)Find:

<td class="alt1" colspan="<if condition="$vboptions['showmoderatorcolumn']">6<else />5</if>">

CHANGE it to:

<td class="alt1" colspan="<if condition="$vboptions['showmoderatorcolumn']">7<else />6</if>">

(3)Find:

<td class="thead" width="100%" align="$stylevar[left]">$vbphrase[forum]</td>

after it ADD:

<td class="thead">$vbphrase[subscribe]</td>

(4)Find:

<td class="tfoot" align="center" colspan="<if condition="$vboptions['showmoderatorcolumn']">6<else />5</if>">

CHANGE it to:

<td class="tfoot" align="center" colspan="<if condition="$vboptions['showmoderatorcolumn']">7<else />6</if>">

Step 7) Edit forumhome_forumbit_level1_nopost
Find:

<td class="tcat" colspan="<if condition="$vboptions[showmoderatorcolumn]">6<else />5</if>">

CHANGE to:

<td class="tcat" colspan="<if condition="$vboptions[showmoderatorcolumn]">7<else />6</if>">

Step 8) Edit forumhome_forumbit_level1_post
Find:

<if condition="$show['subforums']"><div class="smallfont" style="margin-top:$stylevar[cellpadding]px"><strong>$vbphrase[subforums]</strong>: $forum[subforums]</div></if>
			</td>
		</tr>
		</table>
		
		</td>

after it ADD:

<td class="alt1" align="center">
<if condition="$bbuserinfo['userid']"><table cellpadding="0" cellspacing="0" border="0">
		<tr>
                      <td>
        <if condition="$forum[subscribeforumid]">
	         <a href="subscription.php?do=removesubscription&f=$forum[forumid]"><img src="./images/buttons/subscribed_new.gif" alt="$vbphrase[subscribed_click_to_unsubscribe]" border="0" align="absmiddle" /></a>
        <else />
                <a href="subscription.php?do=addsubscription&f=$forum[forumid]"><img src="./images/buttons/subscribe_new.gif" alt="$vbphrase[unsubscribed_click_to_subscribe]" border="0" align="absmiddle" /></a>
        </if>
                        </td>
               </tr>
</table></if>
                        </td>

Step 9) Edit forumhome_forumbit_level2_post
Find:

<if condition="$show['subforums']"><div class="smallfont" style="margin-top:$stylevar[cellpadding]px"><strong>$vbphrase[subforums]</strong>: $forum[subforums]</div></if>
	</td>

after it ADD:

<td class="alt1" align="center">
<if condition="$bbuserinfo['userid']"><table cellpadding="0" cellspacing="0" border="0">
		<tr>
                      <td>
        <if condition="$forum[subscribeforumid]">
	         <a href="subscription.php?do=removesubscription&f=$forum[forumid]"><img src="./images/buttons/subscribed_new.gif" alt="$vbphrase[subscribed_click_to_unsubscribe]" border="0" align="absmiddle" /></a>
        <else />
                <a href="subscription.php?do=addsubscription&f=$forum[forumid]"><img src="./images/buttons/subscribe_new.gif" alt="$vbphrase[unsubscribed_click_to_subscribe]" border="0" align="absmiddle" /></a>
        </if>
                        </td>
               </tr>
</table></if>
                        </td>

Step 10) Upload the image files (subscribe_new.gif and subscribed_new.gif) to the images/buttons folder.

That's it!
================================================== =======

Screencap and images attached...
Enjoy

[kyrnel]

You're right. The '0' wont change anything because the default value is 0 for that function.

I have updated the instructions. The next file edit was wrong as well, I fixed it too.

[MrNase]

Hey,

this could come in handy when i use subscriptions

thx

[Boofo]

Originally Posted by kyrnel

You're right. The '0' wont change anything because the default value is 0 for that function.

I have updated the instructions. The next file edit was wrong as well, I fixed it too.

I don't see any difference in the forumdisplay.php file edit. It looks the same to me.

Now this won't work with forums you are already subscribed to, right? Any way to run a query to set it up like that?

[kyrnel]

It was the "Find:" code that was wrong for forumdisplay.php, not the replacement code.

Basically how it works is this:
When you pass the userid to the cache_ordered_forums() function it adds the field [subscribeforumid] to the query. If this field is populated with a value, then that means that you are subscribed to that forum. So it doesnt add any queries, but it makes an existing query slightly more complex.

So it will work with existing subscriptions. No need to update anything.

[Boofo]

Ahhh, ok, that makes more sense now. Thank you for the explanation. I was wondering how it worked.

[Boofo]

Any way to make the links work in the Forum tools dropdown?

[kyrnel]

That is a good question. I will have to look into that. I expect that it will require a different approach since the forum details in ForumDisplay (other than subforums) are not generated by the cache_ordered_forums function.

[Edit] Actually, this has already been done in another hack, here:
https://vborg.vbsupport.ru/showthrea...ubscribe+forum
[/Edit]

[Boofo]

Originally Posted by kyrnel

That is a good question. I will have to look into that. I expect that it will require a different approach since the forum details in ForumDisplay (other than subforums) are not generated by the cache_ordered_forums function.

[Edit] Actually, this has already been done in another hack, here:
https://vborg.vbsupport.ru/showthrea...ubscribe+forum
[/Edit]

Thank you, sir. Apparently I had already clicked install in that thread but never installed it. Must have forgotten about it.

Your hack works like a charm. Thank you, again.

[kyrnel]

Well, if there are no more comments/questions, then I will go ahead and write this up as a full release.

There is actually little that can go wrong with this hack since it mostly utilizes the existing code in vB. I just wanted to make sure that my instructions were accurate.

[Boofo]

Accurate and excellent!