Simple:Press Documentation

Plugin: Membership Subscribe

Plugin Description

The Simple:Press Auto Subscribe User Groups (aka Membership Subscribe) plugin allows the forum admin to automatically (auto) subscribe an entire usergroup membership to a forum when adding the usergroup with its permission to a forum.

This action relieves the individual usergroup members being added to the forum from having to manually subscribe to the forum themselves.

Plugin Features

Installing this plugin adds:

  • A new “Membership Subscribe” section to the Plugin Management panel under the Admin menu path Forum – Plugins – Available Plugins. From this panel the “Membership Subscribe” plugin can be activated, deactivated, uninstalled, or deleted. There are no options to be set by the admin with this plugin.

Activating this plugin provides:

  • A new sub-section “Auto Subscribe Membership to Forum” entry with a radio button and the text “Auto subscribe selected user group to this forum when adding permission” when the admin has selected “Add Permission” to add a new permission set and a new user group to a selected forum. The admin gets to the desired forum by navigating under the Admin menu to Forum – Forums – Manage Groups and Forums.

Plugin Requirements

Requires Simple:Press version 5.5.5 and above.

The Simple:Press “Subscriptions” plugin must be installed, activated, and its options set up before the “Membership Subscribe” plugin. Please see the Simple:Press codex page Subscriptions to review its particulars.

The “Membership Subscribe” plugin must be installed, and activated before it is operational.

As part of the installation, a “Membership Subscribe” section is added to the Plugin Management panel under Admin menu – Forum – Plugins – Available Plugins. From this panel the Membership Subscribe plugin can be activated, deactivated, uninstalled, and deleted using its “Activate/Delete” and “Deactivate/Uninstall” selections.

The plugin does not have template tags incorporated into current themes so developing a Custom or Child Theme to accommodate any desired template tag changes is not needed before installing this plugin.

Installation and Activation

Please see Using Plugins on how to obtain and install the Simple:Press Auto Subscribe User Groups (aka Membership Subscribe) plugin.

As mentioned there the default location for Simple:Press plugin folders is …/wp-content/sp-resources/forum-plugins. If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Activation is accomplished from the Admin Dashboard panel menu by selecting Forum – Plugins – Available Plugins. In the “Plugin Management” section select the “Membership Subscribe” plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall”. To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall” label changes to “Activate/Delete”.

Plugin Administrative Options

There are no option settings associated with this plugin to be set up by the forum admin.

There are no new permissions inserted in the permission sets with the activation of this plugin. When a new usergroup with a new permission set is being added to the forum, the admin needs to verify that the usergroup has been set up with the permission to subscribe to forums. This permission is inserted into the permission sets for the forum admin to select upon activation of the Subscription plugin.

  • Assigning Permissions
    • Allowing users to subscribe to topics (or forums) is controlled by their group permissions.
    • Each member group that is to have the ability to subscribe must have the permission turned on.
    • This is accomplished from the Admin menu by navigating to Forum – Permissions and selecting “Manage Permissions Sets” in its sub-menu.
    • Select “Edit Permission” for the permission set to be updated to view the “Permissions – Manage Permissions” panel.
    • Under “General” click the radio button next to “Can subscribe to forums (if enabled) and topics” to set/enable the permission.
    • When enabled, the radio button is green in color. Click “Update Permission” at the bottom of the permission set to have the selection saved.
    • At a later time clicking the radio button when it is green removes the green color and will remove the permission when followed by clicking “Update Permission” to save the revised selection.

If the forum admin elects to use the plugin’s feature when adding a new permission (combination of user group and permission set) to a forum, all members of the user group are automatically (auto) subscribed to the forum where the permission set is being added with whatever subscription options had been set up by the forum admin for that forum. The individual users do not have to manually subscribe to the forum as they would have to do if this feature were not selected by the forum admin.

  • Users will still have the option of choosing to remove the forum subscription through editing via the subscription tab in their profile or by selecting to Unsubscribe from the forum on the Group View page. See the Subscriptions Plugin codex page at Subscriptions for details.

Plugin Language Translation

A plugin’s message strings can be translated from English to other languages and then the translation displayed if language translation files are available. Some plugins may not have such files.

Information regarding downloading language files, “mo’ language file placement, and translation (language localization) is found at Localization.

More information is available regarding translation files at Simple:Press Translations. On the base page, select the “Getting Started Guide” link for basics about it’s use. On that page, select the “register a username here” link to obtain a password to the site. Use the “Contact Form” link to request the desired language if it is not currently available. The “Contact Form” link may also be used to volunteer to be a validator for a translation project.

The Membership Subscribe plugin’s available language translation files with translation statistics, and message translations can be viewed at Membership Subscribe Translations. Select the Version link to see the languages available. Select the link for the desired language to see forum messages and their available translations. If available, export the file for the selected language to its proper forum language sub-folder as a “mo” file using the export link at the bottom of the page displaying the actual message translations for the language selected.

The default location for plugin language files is …/wp-content/sp-resources/forum-language/sp-plugins. If this path is changed, it is important to note that the plugin’s language file needs to reside in the language sub-folder for sp plugins wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Plugin Usage

The Forum Admin can indirectly use the plugin when adding a usergroup and its new permission to a forum.

  • Setting / deselecting Auto Subscribe to Forum for all members in the new user group when added a usergroup and permission set

    • After the “Membership Subscribe” plugin has been installed and activated, from the Admin menu, navigate to Forum – Forums – Manage Groups and Forums.
    • For the forum that is to have the new user group and permission set added, click on “Forum Permissions”.
    • Under “View Forum Permissions” click on the “Add Permission” selection.
    • Under “Add Permission Set” sub-section:
      • From the drop-down menu shown when clicking the down arrowhead adjacent to “Select usergroup”, select the usergroup to be added.
      • From the drop-down menu shown when clicking on the down arrowhead adjacent to “Select permission set”, select the permission set for the newly added usergroup.
    • Under the “Auto Subscribe Membership to Forum” sub-section:
      • Click on the radio button adjacent to “Auto Subscribe selected usergroup to this forum when adding permission”. The radio button turns green when selected.
      • Click on the radio button if already green to deselect the option. The radio button turns gray when not selected.
      • When the desired usergroup, permissions set, and “Auto Subscribe Membership to Forum” selections have been made, click on the nearby “Add Permission Set” button to save the settings.

    Forum Members / Users do not use the plugin. Once the user’s usergroup has been auto subscribed, the user can control subscription activity including deselecting the forum subscription as described in the Subscriptions Plugin codex page at Subscriptions.

    Plugin Special Notes

    Note: The “Membership Subscribe” plugin only needs to be activated when a new usergroup and its new permission are to be added to a forum or forums and the “Auto Subscribe Membership to Forum” capability is to be selected. After the “Auto Subscribe Membership to Forum” feature has been completed, the “Membership Subscribe” plugin might be “deactivated” until the next time the capability is needed.

    Note: The “Auto Subscribe Membership to Forum” feature is not available when adding a usergroup with permission set to all the forums in a group from the Admin menu at Forum – Forums – Manage Groups and clicking “Add Permission” associated with the  “Forum Group” entries.

    Template Tags Used in the Plugin

    There are no template tags available for this plugin that allow further customization of the plugin’s usage or otherwise customize the website.

    Action and Hooks Used in the Plugin

    There are no Actions and Hooks available for the plugin.

    Plugin and Template Tag Changelog

    Since Simple:Press version 5.0.

    Codex page sync’d to code version 5.5.3.

    Related

    Subscriptions

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.