Simple:Press Documentation

Plugin: Search By User

Plugin Description

Plugin: Search By User – This Simple:Press plugin builds on the “Enhanced Forum and Blog Search (Search)” Plugin and allows limiting display of the Forum search results to those of a single specified forum user as part of the advanced search set up.

The Blog Search functionality of the “Search” plugin is NOT limited and continues to provide WordPress post and page search results for viewing along with forum search results.

Plugin Features

Note: Independent of this plugin the “Enhanced Forum and Blog Search (Search) Plugin provides the fundamental Forum search capability required by this plugin. Please review the capabilities at Plugin: Enhanced Forum and Blog Searching Codex page.

Installing the Simple:Press Search By User plugin adds:

  • A new “Search By User” section in the Plugin Management panel under the Admin menu path Forum – Plugins – Available Plugins. From this panel the plugin can be activated, or deleted by the admin.

Activating this plugin provides:

  • A change to the new “Search By User” 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 “Search forum by user” check box in the “Forum Scope” section of the “Advanced Search” panel displayed when clicking on the text “Advanced Search” below the Search input text box found on the forum pages of the website.
  • When the “Search forum by user” check box is checked (contains a green check mark), a new text box is displayed for inputting the name of the user whose forum posts are to be searched for the “search criteria” text.
  • After the Forum search has completed, the “Search Results” page is displayed containing the list of forum posts authored by the specified user with the “search criteria” text highlight.

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

Plugin Requirements

Simple:Press version 5.5.11 and above is required.

The Simple:Press Enhanced Forum and Blog Searching plugin is required by this plugin. That plugin must be installed, activated and its options set up before installing this plugin.

The Simple:Press Search By User plugin must be installed, and activated before it is operational.

As part of the installation, a “Search by User” section is added to the Plugin Management panel under the admin menu Forum – Plugins – Available Plugins. From this panel the Search by User 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.

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 “search-by-user“.
  • 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 “search-by-user.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 “Search By User” 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

There are no Administrative Options to be set up with this plugin.

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 Search By User 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 “Search By User” 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 “Search By User” 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 Usage

Forum admins and forum users can select to search forum posts of a single user for specific text.

  • Search By User
      • While on a Forum page, input the “search criteria” in the text input box to the left of the “search” button.
      • Click the “Advanced Search” label below the Search criteria text input box to display the Advanced Search drop down menu.
      • Under the “Forum Scope” category,
        • Insure the “All forums” check box is selected. The check box is selected if it contains a green check mark.
        • Select the check box “Search forum by user”. The check box is selected if it contains a green check mark.
        • When the “Search forum by user” check box is checked (contains a green check mark), below the check box a user name text box is displayed for inputting the name of the user whose forum posts are to be searched for the ‘search criteria’ text.
          • Input the name of the user whose forum posts are to be searched. Note: auto-fill will complete the user’s name. Be sure to select the completed user’s name.
      • Select any other desired advanced search options from the columns in the advanced search section. The option is selected if its check box contains a green check mark.
      • Click on either of the “search” buttons to initiate the search of the specified user’s posts in a the forums for the text in the “search criteria” text box.
        • One Search button is to the right of the Search criteria text input box. The other is on the Advance Search drop down menu.
      • After the Forum search has completed, by default the “Search Results” page displays the forum posts authored by the specified user which contain the “search criteria”.
        • Click on the “Go To Post” text associated with a post to go to the forum post where the post can be viewed in its entirety.
        • Click on the back arrow to return to the search list page showing the forum posts.
        • Repeat the process to see the individual forum posts listed.
        Note:
        If the “Include blog posts” option was selected, a button with default text “Forum search results ()” is shown above the list of forum posts along with a button with default text “Blog search results ()” where the number of each type of post is contained within the “()”.The text for the buttons is specified under the forum menu on the left side of the forum admin page at Forum > Options > General Display Settings in the “Site Integrated Search” section of the “Options – General Display Settings” panel.
        • Click on the “Forum search results” button anytime to again display the list of forum posts with the search criteria text highlighted.

    If “Include blog posts” option was selected as part of the search, all the blog posts containing the “search criteria” will not be limited to those of the specified user.

    • Click on the “Blog search results ()” button anytime to again display the total list of blog posts with the search criteria text highlighted.

Plugin Special Notes

None

Template Tags Used in the Plugin

There are no Template Tags used in this plugin.

Action and Hooks Used in the Plugin

There are no Action and Hooks used in this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 5.5.11.

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

More Topics In SimplePress: Plugins


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