Simple:Press Documentation

Plugin: Achievements

Plugin Description

Plugin: Achievements – This Simple:Press plugin extends the WordPress Achievements plugin to allow users to earn achievement points for creating new forum topics and/or creating reply posts.

Plugin Features

Once installed and activated Simple:Press forum Achievement “Events” can be set up by the admin under the WordPress Achievements plugin to allow:

  • Users to earn Achievement points for creating a new forum topic or multiple topics.
  • Users to earn Achievement points for creating a new reply to a topic or multiple replies to topics.
  • Note: The current operation of the WordPress achievement plugin appears to allow users to earn Achievement points for creating a new reply to a topic created before the achievement plugin was installed and activated.

There are no new top level Forum Admin menu items nor Forum Admin panels associated with adding this plugin.

An admin Forum/Plugins/Available Plugins sub-menu item is added for this plugin’s activation and deactivation.

Plugin Requirements

  • The  WordPress Achievements plugin is required and must first be downloaded, installed, and activated.
  • Upon its activation a new Admin menu item named “Achievements” is added where the characteristics of events and awards associated with achievements are defined.
  • All achievement criteria is set up under the “Achievements” item in the Admin menu provided when the WordPress “Achievements” plugin was activated.
  • Please see WordPress page Achievements for WordPress for more information.
  • Simple:Press version 6.0 and above is required.
  • The Simple:Press plugin must be installed and activated before it is operational.

As part of the installation, an “Achievements Integration” section is added to the Plugin Management panel under the admin menu Forum/Plugins/Available Plugins. From this panel the Achievements Integration plugin can be activated, deactivated, uninstalled, using its “Activate/Delete” and “Deactivate/Uninstall” selections.

There are no Options to be set through the Simple:Press plugin.

This plugin does not currently have template tags so no suggestion is being made to make a Child Theme in the event template tags are to be modified.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install the Simple:Press Achievements Integration 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” and then “Plugins” from the drop down Forum Admin menu. On the Simple:Press Administration panel select the “Achievements Integration” plugin on the “Plugin Management” panel 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 Administrative Options associated with this Simple:Press plugin.

There are no new permissions associated with this Simple:Press plugin that need to be set.

All Achievement Administrative Options are set up under the WordPress Achievements plugin using the Admin “Achievements” menu item. Please see WordPress page Achievements for WordPress for more information including Getting Started, Supported Plugins, Creating Achievements, Adding Support For Other Plugins, and more.

After the Simple:Press Achievement Integration plugin is activated, the WordPress “Achievements” menu can be used to make new achievements associated with Simple:Press events. When making the new achievement be sure to select the “Event” radio button associated with “Type” and clicking in the box labeled “Press here to pick events”. Scroll down in the drop down menu that appears until the Simple:Press events are shown and select one of them. A variety of events to be achieved can be set up by just selecting a different number of repetitions (1, 10, 50, etc.) associated with the Simple:Press events.

  • Simple:Press Events
    • The two default Simple:Press events are:
      • User creates a new topic reply
      • User creates a new forum topic.

Note: The current operation of the WordPress achievement plugin appears to allow users to earn Achievement points for creating a new reply to a topic created before the achievement plugin was installed and activated.

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 Achievements Integration plugin’s available language translation files with translation statistics, and message translations can be viewed at Achievements 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 Simple:Press 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

Please see the WordPress page Achievements for WordPress for information on viewing the WP Achievement leaderboard, available achievements, the newest available achievement, the individual site user’s achievements (“my achievements”), and the process for redeeming earned achievement awards.
Note: The current operation of the WordPress achievement plugin appears to allow users to earn Achievement points for creating a new reply to a topic created before the achievement plugin was installed and activated.

Plugin Special Notes

This Simple:Press plugin required that the WordPress “Achievements” plugin is installed, activated, and set up first.

Template Tags Used in the Plugin

There are no Template Tags available for this plugin that allows you to further customize it’s usage or otherwise customize your website.

Actions and Hooks Used in the Plugin

There are no Actions and Hooks associated with Template Tags because this plugin does not have Template Tags.
There is one (1) Action available for this plugin.

  • do_action( ‘dpa_init_simplepress_extension’ ) – Hook fired to extend the list of selectable events for achievements to include the “Simple:Press” category and the two (2) events, “User creates a new forum topic” and “User creates a new topic reply”. It is used in file sp-achievements-component-class.php

Plugin and Template Tag Changelog

Since Simple:Press version 5.4.2.

Codex page sync’d to code version 5.5.2.

More Topics In SimplePress: Plugins


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