Simple:Press Documentation

Plugin: Profile Display Control

Plugin Description

With this Simple:Press plugin elements of the profile edit form can be optionally removed or re-instated. The profile edit form with its various tabs is displayed when users select the “Profile” button in the forum header. On the profile edit forms users can input data for their own profile.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new Profile Display Control 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 “profile-display-control” containing the plugin’s files.

Activating this plugin provides:

  • A change to the new Profile Display Control section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the Simple:Press plugin can be deactivated, uninstalled, or have its Options set up.
    • The Options link goes to the “Profiles – Display Control” forum Admin panel.
    • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.
  • A new “Profiles – Display Control” forum Admin panel where elements on the users Profile Edit Form can be turned off and on.
  • A new sub-menu entry “Display Control” linked to the new “Profiles – Display Control” forum Admin panel under the “Profiles” menu item access from the Admin menu at Forum > Profiles.

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

Plugin Requirements

Simple:Press version 5.5 and above is required.

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

As part of the installation, a “Profile Display Control” 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, deleted, or its options set using its “Activate/Delete” and “Deactivate/Uninstall/Options” selections.

  • The Options link goes to the “Profiles – Display Control” forum Admin panel.

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.

Plugin 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 “profile-display-control“.
  • 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 “profile-display-control.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 > Plugins > Available Plugins from the drop down forum Admin menu. On the “Available Plugins – Install Simple:Press Plugins” panel select the Profile Display Control plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options” with a “Getting Started” Link.

  • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.

To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall/Options” label changes to “Activate/Delete”.
To re-activated the plugin, click on on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options”.

Plugin Administrative Options

After activation, a) on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the Profile Display Control plugin section or b) under the Profiles entry on the forum menu on the left side forum admin page click the Display Control sub-menu item to get the “Profiles – Display Control” Admin panel with the “Display Control Settings” section.

Turning “On” or “Off” Individual Profile Edit Form Elements

    In the “Display Control Settings” section the individual Profile Edit form elements can be turned off or on as desired.

    • To remove/hide an element from the Profile Edit form, click inside the check box associated with the element if it contains a green check mark to remove the check mark.
    • To re-instate a hidden Profile Edit form element, click inside the check box associated with the element if it does not contain a green check mark to cause the check mark to appear.
    • Click on the “Update” button at the bottom of the panel to save the Profile Edit form settings.
Note:
Only the core profile elements by default are available to be hidden on the profile edit form, but this plugin does provide hooks for other plugins to add their profile forms or elements to this list.However, it is up to those plugins to actually use this ability or the Admin to configure the plugin appropriately.
    The Core profile elements which can be hidden are:

    • Login Name (profile form)
    • Display Name (profile form)
    • First Name (profile form)
    • Last Name (profile form)
    • Website (profile form)
    • Location (profile form)
    • Short Biography (profile form)
    • AIM (identities form)
    • Yahoo IM (identities form)
    • ICQ (identities form)
    • Google Talk (identities form)
    • MSN (identities form)
    • Skype (identities form)
    • MySpace (identities form)
    • Facebook (identities form)
    • Twitter (identities form)
    • LinkedIn (identities form)
    • YouTube (identities form)
    • Google Plus (identities form)
    • Account Login Name (account settings form)
    • Email Address (account settings form)
    • New Password (account settings form)
    • Sync Forum and WP Display Name (global options form)
    • Preferred Editor (posting options form)
Note:
This plugin allows the Admin to remove elements in the profile edit forms that users fill out, but it does not

  • remove the elements from the profile pages viewed when portions of the users’ profile are view by clicking the “Members” button to see the list of forum users and then selecting to view the profile of one of the listed users.
  • provide the Admin with the ability to remove/hide/edit an entire tab in the Profile Edit form.
  • Please see the “Plugin Special Notes” section below for information on how to accomplish these modifications, if they are desired.

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 Profile Display Control 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 “Profile Display Control” 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 “Profile Display Control” 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

Forum Admins may wish to make modifications to the profile information allowed for editing or displaying that this plugin does not control. Two (2) possible changes are discussed here.

Removing Profile Elements from the Profile Display Templates

    • This plugin allows the Admin to remove elements in the profile edit forms that users fill out, but it does not remove those elements from the profile pages viewed when portions of the users’ profile are displayed by clicking the “Members” button to see the list of forum users and then selecting to view the profile of one of the listed users.

    • To remove profile elements from the front end profile displays, one must remove them from the Simple:Press theme being used. The template files within a theme that are responsible for displaying a selected user’s profile information and might be edited are ‘spProfilePopupShow.php’ and ‘spProfileShow.php’.
Note:
If any item is going to be removed or commented out from a theme, it is recommended that a Child or Custom theme is created first to accept the changes prior to installing this plugin.

    • An element can be removed from the display by deleting it’s instruction entirely or just commenting it out.
    • Place a # in front of an element’s instruction to comment it out, then save the modified file. For example:
      • sp_ProfileShowMSN(”, __sp(‘MSN ID’)); becomes
      • #sp_ProfileShowMSN(”, __sp(‘MSN ID’));

Hiding/Editing Profile Edit Form Tabs and Pages

    This plugin does not provide the Admin with the ability to remove/hide/edit an entire tab in the Profile Edit form.

  • To remove any entire profile tab or profile menu from a tab, do so from the Admin menu at Forum > Profiles > Profile Tabs & Menus to view the “Profiles – Tabs” Admin panel with its “Profile Menu Order” section.
    • Clicking the down arrow head on any tab will open the tab to show information about the tab
    • A tab is shown if there is a green check mark in the check box next to “Display Menu” for the tab.
      • To remove a tab from the display, click inside the check box containing a green check mark to remove the check mark.
      • To re-display a hidden tab, click inside the check box without a green check mark to cause the check mark to appear.
      • Click on the “Update Profile Tabs and Menus” button at the bottom of the panel to save the tab settings.

Plugin Usage

Forum Admin use the plugin to remove/hide or re-instate elements in the Profile Edit forms via the Administrative Options.
Forum users do not use the plugin directly. After the forum Admin has configured the Profile Edit forms and Profile Display files appropriately, forum users:

  • fill out the Profile Edit form elements remaining after the Admin has customized the Profile Edit forms.
  • view user profile information allowed by the Admin by clicking the “Members” button in the forum header, selecting a specific user from the members list, and clicking that user’s avatar to see the user’s
    • Popup Profile page, and/or
    • Full Profile page

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.3.

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

More Topics In SimplePress: Plugins


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