Simple:Press Documentation

Plugin: Gravatar Cache

Plugin Description

This Simple:Press plugin allows Gravatars (Globally Recognized Avatars) used on the forum to be cached within the local file system for improved speed and performance rather than requested and retrieved from the Gravatar server each time.

After plugin installation and users with Gravatars log into the forum, their Gravatars are accessed from the Gravatar server and the Gravatar files are automatically copied into a local folder for rapid retrieval on future logins.

Note:
This plugin should only be used if Gravatars are being utilized in the forum.If using Gravatars, please review the settings in the “Avatar Priorites” section on the “Profiles – Avatars” admin panel to make sure that Gravatars are shown and used in the order desired.The “Profiles – Avatars” admin panel can be seen from the Admin menu at Forum > Profiles >Avatars.

Note:
Gravatars must have been made by the forum user(s) at Gravatar.com with the e-mail address specified by the user(s) in their forum profile listed with the Gravatar made.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new Gravatar Cache section in the “Available Plugins – Install Simple:Press Plugins” panel under the forum Admin menu path Forum > Plugins > Available Plugins. From this panel the plugin can be activated, or deleted by the admin.
  • When properly installed, a new folder in the “forum-plugin” folder named “gravatar-cache” containing the plugin’s files.

Activating this plugin provides:

  • A change to the new “Gravatar Cache” section in the Plugin Management panel under the Admin menu path Forum > Plugins > Available Plugins so the plugin can be deactivated, or uninstalled.
    • There are no options for this plugin.
    • The “Getting Started” link associated with the “Deactivate/Uninstall” selections should be selected to view the pertinent information regarding the plugin.
  • A new folder named “forum-gravatar-cache” located by default in the “sp-resources” folder for the forum used for storing Gravatars to be used in the forum.
    • The users’ Gravatar files are stored with filenames that are the users’ Gravatar “hashed” value of their e-mail address.
  • A new entry “Gravatar Cache Folder” on the Integration – Storage Locations admin panel viewed from the admin menu at Forum > Integration > Storage Locations. This entry identifies the location of the local folder where the user gravatar files will be stored.
    • The default location is …wp-contents/sp-resources/forum-gravatar-cache.
    • See Storage Locations for more information.

There are no new permissions added to the permission sets due to this plugin.

Plugin Requirements

This plugin requires that gravatars have been made by the forum user(s) at Gravatar.com with the e-mail address specified by the user(s) in their forum profile listed with the gravatar made.

Simple:Press version 5.3.1 and above is required.

This plugin must be installed, and activated before it is operational.

As part of the installation, a “Gravatar Cache” section is added to the Plugin Management panel under the admin menu Forum > Plugins > Available Plugins. From this panel the plugin can be activated, deactivated, uninstalled, or deleted.

  • There are no options that need be set up for this plugin.

There are no new permissions added to the permission sets due to this plugin.

The plugin does not have template tags so no recommendation regarding Custom or Child Themes is being made.

Installation and Activation

Please see Using Plugins on how to obtain and install this Simple:Press plugin.

  • Whatever method is used to add the Simple:Press plugin, the folder that should have been added to the forum plugin folder is named “gravatar-cache“.
  • If using the “Simple:Press Upload Plugin – Upload a Simple:Press Plugin” panel at the forum Admin menu Forum > Plugins > Plugin Uploader, the folder to browse for after downloading it from the Simple:Press site is “gravatar-cache.zip” before clicking the “Upload Now” button.

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 “Gravatar-Cache” 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”. Activating the plugin again reinstates plugin functionality.

Plugin Administrative Options

After installing and activating, there are no necessary plugin admin options to be set.

There are no new permissions that must be set in the permission sets because of this plugin.

To be complete for multilingual forums, the language translation files for this plugin should be installed or downloaded/properly placed in the appropriate forum-language folder for SP plugins using one of the procedures below in the “Plugin Language Translation” section of this page.

Plugin Language Translation

A plugin may not have language translation files, but in general each Simple:Press plugin has its own language translation files each with multiple pages for translating the forum plugin’s message strings.

Forum Plugin translation files are to reside in a unique forum folder location as defined by the “Simple:Press Plugin Language Files” entry on the “Integration – Storage Locations” forum Admin panel available through the forum Admin menu at Forum > Integration > Storage Locations.

  • The default location for forum plugin translation files is the folder “…/wp-content/sp-resources/forum-language/sp-plugins”.

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

WARNING: On the Localization page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.

More information is available regarding translation files at Simple:Press Translations. which is the repository for Simple:Press language translation files. 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.

This plugin’s available language translation files with translation statistics, and message translations can be viewed at Gravatar Cache within the repository for Simple:Press language translation files.

  • Installing this Simple:Press Plugin’s Language Translation “.mo” files
    The plugin’s language translations files for each language can be correctly located in two ways.

    • Using the Admin Word:Press “Site Language” and Simple:Press “Language Translation” Features
      WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
        • Under the “Language Translation Selection Sequences” heading, the “Coordinated Language Translation File Download Using the Simple:Press ‘Language Translation’ Selection” section, follow the instructions at “Adding its Translation File(s) After Downloading/Activating a Simple:Press Theme or Simple:Press Plugin”.
          • Follow the instructions to select the “Site Language” and then get to the admin page with the “Integration – Language Translations” section where there should be an entry for “Gravatar Cache” along with an “Install” button.
          • Click on the “Install” button for this plugin to install the language translation file for the current “Site Language” language.
            • Note: If the message “No Translation Project Exists” is displayed rather than the “Install” button, a translation file for that language could not be found in GlotPress at this time. Consider posting in the Simple:Press forum if it is felt there needs to be one added.
          • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
          • As called out in the section, continue to change the “Site Language” language and repeat the process until all desired translation files for this plugin have been installed.

       

    • Manually Finding and Storing Simple:Press Plugin’s Language Translation ‘mo’ files
    • WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
    • After reviewing the material discussed under the “Language Translation Selection Sequences” heading, the “Manual Installation of Simple:Press Language Translation Files section, follow the steps outlined at “Finding and Storing ANY Simple:Press Plugin’s Language Translation ‘mo’ files”.
    • Each time through the process at the step, “Scroll down the list and click on the name of the plugin whose language files are being sought to see the translation file Version Number available”, substitute “Gravatar Cache” for the phrase “the name of the plugin whose language files are being sought”.
    • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
    • Repeat the steps for each language it is desired to have a translation file (french, spanish, etc.) for the plugin on the website.

Plugin Special Notes

If using Gravatars, please review the settings in the “Avatar Priorites” section on the “Profiles – Avatars” admin panel to make sure that Gravatars are shown and used in the order desired. The “Profiles – Avatars” admin panel can be seen from the Admin menu at Forum > Profiles >Avatars.

Plugin Usage

No action is required by the forum Admin nor the forum users other than having made a gravatar at Gravatar.com for themselves with the e-mail address specified in their forum profile associated with the gravatar made.

After plugin installation and the gravatars have been made, when the forum users (including admins) log into the forum and their gravatars are accessed from the Gravatar server, the gravatar files are automatically copied into the local folder for rapid retrieval on future logins as specified at Storage Locations under the “Gravatar Cache Folder” entry.

Template Tags Used in the Plugin

There are no Template Tags used in this plugin.

Actions and Hooks Used in the Plugin

There are no Actions and Hooks available in Template Tags for this plugin.

There are no other Actions and Hooks available for this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 5.2.

Codex page sync’d to code version 5.6.0 and plugin version 1.2.5.

More Topics In SimplePress: Plugins


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