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

Allow users to subscribe to a group
Introduced in Tiki 2. Required parameters are in bold.
Go to the source code
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:

Copy to clipboard
{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:

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