Forum topic notifications

[blg002]

Similarly to how you can subscribe to specific forum *topics*. I would like to offer my users the ability to subscribe to entire *forums* i.e. be notified whenever a new topic is posted in a specific forum.

[johnjamesjacoby]

There's a plugin for this out there. Might be value in having this in core, so moving to future release incase anyone wants to pick it up and write it as a feature.

[mordauk]

I'd love to see this make it in and would be willing to start on a patch.

Some details to think about when a user subscribes to an entire forum:

• Do the Subscribe links show on individual topics?
• Do all topics in the forum show unsubscribe links allow for individual topics to be excluded?

[mordauk]

Ignore those two questions above, I was thinking forum subscriptions would include new replies in forum topics, but now I realize it should probably just be for new topics.

[mordauk]

Where do we think the Subscribe / Unsubscribe link should go for Forums? The first place I thought of was next to the Topic column, as shown in the attached screenshot, though I'm not sure it makes sense.

[mordauk]

​forum-subscriptions.patchis a mostly working patch.

Notes:

• JS hasn't been patched to update forum subscriptions with ajax.
• bbp_is_user_subscribed() is a bit messy. I'd like to clean it up more and get rid of some of the nested ifs.
• Improvements for backwards compatibility need to be made, since I modified some of the existing function names.

[mordauk]

The additional bbp_get_forum_subscribers() function may not be necessary since the existing bbp_get_subscribers() function could be used instead.

I renamed bbp_get_user_subscribed_topic_ids() to bbp_get_user_subscribed_ids() since it retrieves ID numbers for both topics and forums.

[mordauk]

How do we feel about renaming topic.js to forums.js (or bbpress.js) to be more general and allow the Forum subscription handler to be in the same file?

[quan_flo]

Replying to blg002:

Similarly to how you can subscribe to specific forum *topics*. I would like to offer my users the ability to subscribe to entire *forums* i.e. be notified whenever a new topic is posted in a specific forum.

+1 for this feature request (notify about new topics (not replies) in a subscribed forum.
would be happy to see this feature in bbpress

[mordauk]

New patch completely reworked.

[mordauk]

Anyone feel like testing out ​http://bbpress.trac.wordpress.org/attachment/ticket/2299/forum-subscriptions2.diff and providing some feedback?

[quan_flo]

Replying to mordauk:

Anyone feel like testing out ​http://bbpress.trac.wordpress.org/attachment/ticket/2299/forum-subscriptions2.diff and providing some feedback?

If this works, will it be part of 2.5 or 2.4.x?

[mordauk]

It is planned for 2.5.

[johnjamesjacoby]

Replying to mordauk:

Anyone feel like testing out ​http://bbpress.trac.wordpress.org/attachment/ticket/2299/forum-subscriptions2.diff and providing some feedback?

I will tomorrow evening.

[netweb]

Nice work, I had a look around and play on the weekend and works really well.

I think we just need to decide on what to do with bbPress' .js files

Option 1: Two javascript files bbpress.js and minified bbpress.min.js

• Merge topic.js into \bbPress\templates\default\js\bbpress.js
• Merge reply.js into \bbPress\templates\default\js\bbpress.js
• Include the forum js requirements of this patch

Option 2: Six javascript files and minified versions

• \bbPress\templates\default\js\forum.js forum.min.js
• \bbPress\templates\default\js\topic.js topic.min.js
• \bbPress\templates\default\js\reply.js reply.min.js

[johnjamesjacoby]

I'm fine with having two JS files as long as the non-mini is documented thoroughly. This way we can just always enqueue it, and skip the juggling of maybe-its-JS, maybe-it's-broken when using things like shortcodes.

[netweb]

Updated patch incoming...

[netweb]

Latest patch forum-subscriptions.diff​ based on forum-subscriptions2.diff

• PHPDoc updates
• Standardized order of functions, 'Forums' before 'Topics'
• includes/users/functions.php NOT updated (Will do this tomorrow)
• .js files remain as they were in previous patch (i.e. not merged into bbpress.js)

@ToDo

• Add additional changes per includes/core/actions.php#227 (including repair tools to 'Remove trashed forums from user subscriptions')
• Update the includes/users/functions.php patch (Primarily clearer PHPDoc's)
• Audit function name changes and function naming consistency, examples:
  • bbp_notify_subscribers -> bbp_notify_topic_subscribers / bbp_notify_forum_subscribers
  • bbp_pre_notify_subscribers -> bbp_pre_notify_topic_subscribers / bbp_pre_notify_forum_subscribers
  • bbp_subscription_mail_headers -> bbp_topic_subscription_mail_headers / bbp_forum_subscription_mail_headers
  • _bbp_subscriptions -> _bbp_topic_subscriptions / _bbp_forum_subscriptions
  • bbp_is_user_subscribed -> bbp_is_user_subscribed_to_topic / bbp_is_user_subscribed_to_forum
• Check subscriptions though forum hierarchy (eg. If you subscribe to a category are you subscribed to all child forums, if not add support for this or remove to ability to subscribe to categories and/or forum parents)

[mordauk]

Replying to netweb:

Nice work, I had a look around and play on the weekend and works really well.

I think we just need to decide on what to do with bbPress' .js files

Option 1: Two javascript files bbpress.js and minified bbpress.min.js

• Merge topic.js into \bbPress\templates\default\js\bbpress.js
• Merge reply.js into \bbPress\templates\default\js\bbpress.js
• Include the forum js requirements of this patch

Option 2: Six javascript files and minified versions

• \bbPress\templates\default\js\forum.js forum.min.js
• \bbPress\templates\default\js\topic.js topic.min.js
• \bbPress\templates\default\js\reply.js reply.min.js

I'd prefer having just the two (bbpress.js and bbpress.min.js).

[mordauk]

​forum-subscriptions.2.diff is an updated version with better standardization of includes/users/functions.php

[johnjamesjacoby]

Thanks!

[netweb]

In ​forum-subscriptions.3.diff

• PHPDoc fixes includes/users/functions.php
• Added 'Repair Tool' Remove trashed forums from user subscriptions bbp_admin_repair_user_forum_subscriptions to includes/admin/tools.php

[johnjamesjacoby]

In 5156:

Forum Subscriptions - Allow users to subscribe to new topics in specific forums.

• Code largely lifted from existing Topics Subscriptions, and is based largely on forum-subscriptions.2.diff from mordauk, with edits for code consistency across bbPress components.
• Refactor existing ambiguous function names into base functions for both forum and topic subscriptions.
• Include new functions for getting and outputting subscriptions.
• Modify user-subscriptions.php to show subscribed forums. This includes a modification to content-single-forum.php to include the "Unsubscribe" link if looking at a user profile page.
• Modify templates/default/bbpress-functions.php to enqueue new JS file to handle forum subscription ajax.
• Rename HTML element classes from bbp-topic-action to bbp-row-actions to better accommodate forum subscriptions (and any future actions.)
• BuddyPress tested, JJJ approved.
• See #2299. Props mordauk, netweb for the considerable effort.
• More to do here, largely from forum-subscriptions.3.diff

[johnjamesjacoby]

In 5157:

Forum Subscriptions:

• Update @since and @deprecated to r5156.
• Introduce tool for removing trashed and deleted forums from user subscriptions.
• See #2299. Props netweb.

[johnjamesjacoby]

Forum subscriptions are in. Going to mark this as fixed. New bug; new ticket please.

Thanks everyone! Awesome work.

[mordauk]

Heck yeah!

[netweb]

In 5159:

Fix copy pasta in user profile subscriptions template. See #2299