Loading...
 
Allow users to subscribe to a group

Plugin Subscribe Group

Introduced with Tiki 2

If you have allowed users to subscribe themselves to (join) a group, you can use this wiki plugin to allow them to subscribe/unsubscribe to a specific group. Please see PluginSubscribeGroups for a similar plugin for subscribing/unsubscribing to more than one group.

Security and permissions

  • A user must have the perm tiki_p_subscribe_group to be able to see the box
    To set this permission go to Settings > Groups
  • The group must be set as being a user choice
    To set this configuration go to Settings > Groups

 Security Caution

Using this plugin, any registered user will be able to access any group provided that the group has "User Choice" checked in the settings for the group at Settings > Groups.

Parameters

Introduced in Tiki2. Required parameters are in bold.
Preferences required: wikiplugin_subscribegroup
Parameters Accepted Values Description Default Since
(body of plugin) text displayed before the button
group groupname Group name to subscribe to or unsubscribe from 2.0
defgroup Make this the default group text, containing %s as the placeholder for the group name. OK 9.1
defgroup_action Default group button label. Will subscribe to the group first if not already a member. OK 9.1
undefgroup Stop this being default group text, containing %s as the placeholder for the group name. OK 9.1
undefgroup_action Stop this being default group button label. Does not unsubscribe from the group. OK 9.1
subscribe_action Subscribe button label, containing %s as the placeholder for the group name. OK 2.0
subscribe Subscribe text, containing %s as the placeholder for the group name. Subscribe%s 2.0
unsubscribe_action Unsubscribe button label, containing %0 as the placeholder for the group name. OK 2.0
unsubscribe Unsubscribe text, containing %s as the placeholder for the group name. Unsubscribe%s 2.0
postsubscribe_url url URL to send the user to after subscribing, if required. 8.0
postunsubscribe_url url URL to send the user to after unsubscribing, if required. 8.0
undefgroup_group groupname Group name to set as default when user stops this group being it. Registered 9.1
allowLeaveNonUserChoice (blank)
y
n
Always allow leaving a group even if the group settings do not allow user choice. n 14.0
defgroup_redirect_home (blank)
y
n
Redirect to new home page after default group change. (default is to redirect) y 9.1


Usage notes

  • If you use this plugin with the plugin GROUP, be careful that if GROUP is used first, the change will not immediately be shown. GROUP used after SUBSCRIBEGROUP will be fine
  • A module with a filter on the group will be affected as soon as the group is changed

Examples

Basic

This code:
{subscribegroup group="Editors" subscribe="Subscribe to %s" unsubscribe="Leave %s" subscribe_action="Name of subscribe submit button" unsubscribe_action="Name of unsubscribe submit button"}


Would produce:

Image

or this screen

Image

Advanced

It is possible to make a link to toggle from subscribed/unsubscribed status to some group called GroupName by creating a link to a page which contains this plugin and adding the following parameters:
group="GroupName&iSubscribeGroup=1&subscribeGroup=text"

Example:
http://www.example.com/somepage?group=GroupName&iSubscribeGroup=1&subscribeGroup=text

Of course, this works if the user is logged in, and GroupName needs the correct spelling and capitalization.

Aliases


doc.tiki.org


Bootstrap

AdminGuide

UserGuide

Keywords

Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting (7.x)
Articles and Submissions
Backlinks
Banners
Batch (6.x)
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution (2.x)
Cookie
Copyright
Credit (6.x)
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
Draw 7.x
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management (4.x)
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links (3.x)
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags (2.x)
Task
Tell a Friend, alert + Social Bookmarking
TikiTests (2.x)
Theme CSS & Smarty
Trackers
Transitions (5.x)
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebHelp
WebDAV (5.x)
Webmail
Web Services
Wiki 3D
Wiki History, page rename, etc
Wiki Page Staging and Approval (2.x)
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG (2.x)
XMLRPC


Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki