![[Show/Hide Right Column]](pics/icons/orightcol.png "[Show/Hide Right Column]"){kind=icon}
Plugin Subscribe Group
Introduced with Tiki 2.0If you have allowed users to subscribe themselves to (join) a group, you can use this 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.
Related: PluginMemberList
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 Admin > Groups.
Table of contents
Syntax
{SUBSCRIBEGROUP(group="Editors",
subscribe="Subscribe to %s", unsubscribe="Leave %s",
subscribe_action=Name of subscribe submit button, unsubscribe_action=Name of unsubscribe submit button) /}
or this screen
Parameters
| Parameter | Values | Description | Since | |
|---|---|---|---|---|
| group | string - a group | mandatory | The group you want the user to subscribe/unsubscribe. You must have allowed this group to be a subscribable group | |
| subscribe | string | optional | text to subscribe - default "Subscribe to %s" - %s will be replace by the groupname - use double quote to enclose the string if special character - if the param exists but has no value, only the button will be displayed | |
| unsubscribe | string | optional | text to unsubscribe - default "Unsubscribe %s" - %s will be replace by the groupname - use double quote to enclose the string if special character - if the param exists but has no value, only the button will be displayed | |
| subscribe_action | string | optional | label of the subscribe submit button - default OK | |
| unsubscribe_action | string | optional | label of the unsubscribe submit button - default OK |
Security
- A user must have the perm tiki_p_subscribe_group to be able to see the box
To set this permission go to Admin > Groups - The group must be set as being a user choice
To set this configuration go to Admin > Groups
Notice
- 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 uses after SUBSCRIBEGROUP will be fine
- A module with a filter on the group will be affected as soon as the group is changed
Advanced usage
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.
,
,
,
,
![[toggle]](javascript:icntoggle('mod-DocUserMenul1','module.png'); "[toggle]"){kind=small}
In Progress