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]

ARGHH! The Attachment Manager is not allowing me to upload GIFs and I can't link them from my site since I have hotlink protection enabled. So here is a ZIP file.

[Edit - I was able to upload a JPG of the screencap]

[Boofo]

Can you please make a text file for this so it will be easier to download and install?

And can we use the words Subscribe and Unsubscribe for this instead of images?

[kyrnel]

Sure, sorry, this is my first real hack. Will upload shortly.

[Boofo]

I just edited my post. Can we use words instead of images for this (as in my post above)?

[kyrnel]

Certainly. That option would actually be much easier, since you dont really have to add a new column to the table.
Did you want a separate column, or just the text in the same cell as the Forum title?

[Boofo]

I just want to add it underneath the forumd escription on a separate line and have it say Subscribe or Unsubscribe and have it change accordingly when it is clicked. vB2 used to have a hack like this and it was great!

[kyrnel]

OK, to JUST add a text link beneath the forum description, follow these steps:

1) Make file changes as indicated above (index.php and forumdisplay.php)
2) Edit forumhome_forumbit_level1_post
Find:

<if condition="$show['forumsubscription']"><div class="smallfont"><strong><a href="subscription.php?$session[sessionurl]do=removesubscription&amp;f=$forum[forumid]">$vbphrase[unsubscribe_from_this_forum]</a></strong></div></if>

and CHANGE to:

<if condition="$forum[subscribeforumid]"><div class="smallfont"><a href="subscription.php?$session[sessionurl]do=removesubscription&amp;f=$forum[forumid]">$vbphrase[unsubscribe]</a></div>
<else />
<div class="smallfont"><a href="subscription.php?$session[sessionurl]do=addsubscription&amp;f=$forum[forumid]">$vbphrase[subscribe]</a></div>
</if>

3) Make the exact same change as above to forumhome_forumbit_level2_post.

This will basically make the forums look like they currently do in the UserCP with the 'Unsubscribe" link.

I'd like to get some feedback and see if I need to make any other changes before I finalize these two options and make the associated text files.

[Boofo]

Ok, I did like you said, and the subscribe link shows up but when I click on it and subscribe to a thread, it still says subscribe for the link. It doesn't change to unsubscribe.

Should it be saying subscribe on all of them, even the ones I am already subscribed to?

[Boofo]

This is the code I have for the indedx.php:

PHP Code:

cache_ordered_forums(1); 


It doesn't have a second number. Now if I add that second number, then it works like it should. But is that going to mess up the moderator cache that way?