Loading...
 
Skip to main content

History: PluginSubscribeGroup

Source of version: 39 (current)

Copy to clipboard
            ! 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''

{REMARKSBOX(type=warning title=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__.''{REMARKSBOX}
!!Parameters
{pluginmanager plugin="subscribegroup"}
!! 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:''
{CODE(colors="tiki")}{subscribegroup group="Editors" subscribe="Subscribe to %s" unsubscribe="Leave %s" subscribe_action="Name of subscribe submit button" unsubscribe_action="Name of unsubscribe submit button"}{CODE}

''Would produce:''
{BOX()}
{img src="img/wiki_up/pluginSubscribeGroup.gif" }
{BOX}
or this screen
{BOX()}
{img src="img/wiki_up/pluginSubscribeGroup2.gif" }
{BOX}
!!!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:
{CODE(colors="tiki")}
group="GroupName&iSubscribeGroup=1&subscribeGroup=text"
{CODE}
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.
!!Related pages
* ((PluginMemberList))
!! Aliases
*(alias(Plugin SubscribeGroup))
*(alias(Plugin Subscribe Group))