WordPress Plugin

Last modified 13:51, 6 May 2015

wordpress

Overview

The Gigya Plugin for WordPress allows you to integrate Gigya's customer identity management platform throughout your WordPress site. With the Gigya plugin, you can easily build and maintain secure and scalable registration, authentication, profile management, data analytics and third-party integrations. Increase registrations and identify customers across devices, consolidate data into rich customer profiles, and provide better service, products and experiences by integrating data into marketing and service applications.

 

Version and Compatibility

Gigya WordPress plugin version 5.2 is compatible with WordPress versions 3.6.x-4.1.x and PHP version 5.3.x-5.5.x.

To view the version of your Gigya WordPress plugin, go to the WordPress Admin Panel and select Gigya > Global Settings.

View update details on the latest and earlier versions in our change log

 

Main Features

Customer Identity Management

The Gigya plugin provides two main Customer Identity Management packages: 

  1. Registration-as-a-Service (RaaS) - An end-to-end user management system package. This platform offers a comprehensive cloud-based user registration system that supports login by social networks while allowing sites to maintain a unified user database for both social and traditional site authentication. For additional information and advanced implementation options see Registration-as-a-Service.
  2. Social Login - The Gigya plugin can be used as an external authentication system, allowing users to sign up to your site using their social networks. As with standard WordPress registration, new WordPress user accounts will be created in the process. 

 

Social Widgets

The Gigya Plugin comes with a series of WordPress widgets that integrate your site with the user's social networks and create a compelling and fulfilling user experience.  These WordPress widgets come with a fully configurable user interface design that can be controlled from the WordPress back-office.

  • Share - users can easily share posts with their social networks friends.
  • Comments - enables site users to post comments and have discussions about published content on your site.
  • Gamification - a social loyalty and rewards platform that can be easily embedded in your website, increasing site engagement and making your users' experience more enjoyable.
  • Rating & Reviews - give your customers an easy way to provide feedback on product and content across your site, and then share that feedback with friends in their social networks. 
  • Reactions - allows users to react to content in your site and share their reaction to social networks.
  • Activity Feed - allows users to see the latest actions on a site, according to who performed the actions.
  • Follow Bar - place a bar with buttons for following news and keeping your customers updated through different communications channels, such as a Facebook page, a Twitter account, a newsletter, a blog, etc.

 

Administration & Configuration

All features and user interfaces are fully configurable, require little time to install and can be controlled from the ​WordPress dashboard.

 

Implementing the Gigya Plugin in Your Site

Implementation of the Gigya plugin follows three stages: 

  1. Installing the Gigya Plugin for WordPress: Installing Gigya's WordPress plugin is easy and does not require any programming skills.
Note: If you are already using an older (4.x) version of the plugin, see Upgrading the ​Gigya WordPress Plugin instead.
  1. Gigya Plugin and Widget Configuration: The plugin requires some basic configuration. Some widgets need to be enabled before you can use them.

  2. Adding the Gigya Widgets: As a final step, you may choose which widgets to add and where you want them in your site. Alternatively, you may Use Gigya's WordPress Shortcodes for embedding Gigya widgets in your site with greater degree of flexibility.

 

For compatibility with multi-site WordPress installations, see Using the Gigya Plugin in Multi-Site Installations.

For advanced users we provide Advanced Customization options for customizing the implementation through code using Actions and Filters.

 

Installing the Gigya Plugin for WordPress

No programming skills are necessary to install and use the Gigya plugin for WordPress. Everything works out of the box and the plugin is fully configurable through WordPress's Administration Panels.

Note: If you are already using an older (4.x) version of the plugin, see Upgrading the ​Gigya WordPress Plugin instead.

 

Follow the installation steps below:

  1. Create an account in the Gigya website.
  1. Access the Gigya Site Settings page and follow the steps described in the Setup Wiki page. Make sure you enable status updates in Facebook by checking the Enable publishing user actions checkbox on the Permissions page (see Permissions for a detailed explanation).
Note: For setting up the Gigya plugin for WordPress multi-site installations, see Using the Gigya Plugin in Multi-Site Installations.
  1. Download the Gigya Plugin for WordPress.

  2. Access your site’s server through an FTP application and upload (copy) the plugin's unzipped folder to the /wp-content/plugins folder.

  3. In your WordPress Administration Panel, click Plugins in the main menu.

  4. You should see your new plugin listed:

    Activate plugin
     

    Note: If you don't see Gigya's plugin listed try the following: check the "plugins" folder with your FTP program and see whether "Gigya" is located there. If not, upload the files again. If it is located there, delete the files and upload them again.
  5. Click the Activate link below the "Gigya - Make Your Site Social" plugin title. The page should now show the Gigya plugin as active.

  6. In the sidebar you should now see a "Gigya" item. Go to Gigya > Global Settings and enter your Gigya API Key and Secret Key (Base64-encoded), which you can see in the Gigya Console.

global settings.jpg

 

Note: Use different Gigya API keys for development and production sites. Before going live, change your Gigya API key.

 

RaaS

Implementing Gigya's Registration-as-a-Service (RaaS) requires additional preparation. See Using RaaS with WordPress for implementation instructions and other important information.

 

Roles and Permissions

Access to the Gigya Secret Key is limited for security reasons. By default, the Secret Key can only be edited and viewed by network admins (in a multi-site installation) or admins (in a single-site installation). Any other users of the page, including site admins in a multi-site installation, cannot see or edit the Secret Key.

If you edit WordPress permissions or create your own user roles (using one of the available third-party plugins), you may change these settings. The installation of the Gigya plugin adds two WordPress permissions to the system. You may grant them to any user role and assign that role to users as needed:

  • edit_gigya - gives general access to Gigya plugin options
  • edit_gigya_secret - gives access to the Gigya Secret Key

 

Gigya Plugin Configuration

After the Gigya WordPress plugin has been installed, both the plugin and widgets can be configured through the WordPress Admin Panel under the Gigya entry.
Under Gigya you will find the following tabs which configure global Gigya settings such as which social networks to use:

  1. Global Settings: Global Settings are general settings affecting all the widgets.
  2. User Management Settings: Enable and configure the Registration-as-a-Service (RaaS) or Social Login widgets.
  3. Share Settings: Enable and configure the Gigya Share widget.
  4. Comments Settings (or Rating & Reviews): Enable and configure the Comments widget or the Rating & Reviews widget. 
  5. Reactions Settings: Enable and configure the Reactions widget.
  6. Gamification Settings: Enable and configure the Gamification widget.
  7. Activity Feed Settings: Enable and configure the Activity Feed widget.
  8. Follow Bar: Enable and configure the Follow Bar widget.

Widgets are added from the Appearance option in the WordPress Admin Panel. Additional options such as the widget's title in your site are set when adding the widget. For instructions on adding widgets see Attaching Gigya's WordPress Widgets

 

Advanced Extension Customization

If you wish to extend or override the Gigya functionality using the WordPress "hooks" methodology, learn more here.

 

Global Settings

The settings in this section define basic configurations of the Gigya integration on your WordPress site.

Customers who upgrade from Gigya's WordPress plugin version 4.x will see a button entitled Database cleaner after upgrade. The database cleaner is optional and removes all version 4.x settings from your database.  It should not be run until you are fully satisfied that the upgrade has succeeded as it prevents reversion from version 5.x to version 4.x. In addition you should backup your WordPress database before running the cleaner. 

Field Default  Description
Gigya API key (no default)
Paste the API key for your site domain that was generated for you in the Gigya site (see Installing the Gigya Plugin for Wordpress).

Gigya Secret key

(no default)

Paste the Gigya Secret key for your site domain that was generated for you in the Gigya site (see Installing the Gigya Plugin for Wordpress).

Note: By default, the Global Settings page only displays the Gigya Secret Key to network admins (in a multi-site installation) or admins (in a single-site installation). See Roles and Permissions for more information.
Data Center US Data Center The location of the data center associated with your Gigya account. Default is 'US', however if you are using a different one (e.g Europe) change it here.
Options are:
  • US Data Center - United states (default option)
  • EU Data Center - Europe
  • AU Data Center - Australia
  • Other
When selecting the 'Other' option, you will be prompted to enter the name of your data center. Add the prefix of the data center URL (e.g. the URL for the European data center is eu1.gigya.com, therefore the prefix for it will be 'eu1'). The name is an acronym that represents the data center you will be using. If you are not sure, contact your implementation manager to receive the name of your data center. This option is meant to support data centers that are added between versions.
List of Providers * The default * setting specifies all available networks. Otherwise type a comma-separated list of networks that you want to include. For the full list of available providers, refer to the global configuration object page. 
Language English
The plugin supports localization. In the list, select a supported language for display on your website.
Note: If your desired language is not in the list, refer to the language support section. You then add the relevant string to the Additional Parameters below.
Additional Parameters (advanced) (no default)
This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section below.

For the list of available configuration options, refer to the Global Conf page.

Technical note: the Global Configuration automatically fulfills the Gigya requirement to insert a Global Conf block of code in the header section of any page of your website that has a Gigya block in the page body (the block calls the main Gigya JavaScript library and initializes the Gigya API. The configuration is passed as an object to the script call).

Enable Google Social Analytics No Select Yes to enable the Google Social Analytics plugin.
For details, refer to the Third-Party Analytics Integration page.
Enable Gigya debug log No Select Yes to enable the Gigya Plugin debug log. When checked, the plugin logs all Gigya's requests and responses into Wordpress's logging system. Learn more about configuring the logging system in Wordpress.

Remember to click the "Save Changes" button before continuing.

 

Additional Parameters (advanced)

Most of the Gigya settings tabs include an Additional Parameters (advanced) box. These boxes enable you to specify configuration options beyond those available in the other fields for that tab.

Additional parameters must be entered in "JavaScript Object Notation" (JSON) format. The required format is {"key1": "value1", "key2": "value2", ..., "keyN": "valueN"}​ where "key" represents the name of the API method field and "value" is the value you are passing to it.

For example, the following use of JSON sets values for the Global Conf object's enabledProviders and ShortURLs fields: {"enabledProviders":"facebook, twitter", "shortURLs":"whenRequired" }

 Additional Parameters

 

Note: The Additional Parameters in all sections override existing configurations and must be used carefully.

 

User Management Settings

The settings in this section configure the user registration and management (RaaS and Login) widgets.

There are three basic options, and the settings displayed vary depending on the option you select:

  • Wordpress only - This (default) option disables Gigya's login and Gigya's user management. The Widgets remain available.
  • Wordpress + Social Login - This option enables Gigya's social login, allowing users to login to your site using their social networks and enabling the Login widget. User management is handled by WordPress.
  • Registration-as-a-Service - This option enables both Gigya's social login and Gigya's user management, giving you extended data and control over your site users and enabling the RaaS widget. 

user mng settings.jpg

 

Wordpress + Social Login

If you choose to enable Gigya's social login without Gigya's registration-as-a-service, the the following User Management Settings are displayed:

Field Default  Description
Button style Standard Specify how Social Login buttons are displayed. The default option is Standard and the other options are Full logos, Sign In With.
Connect Without Login Behavior Login existing user
For users not logged into the site, this field determines login requirements for performing a Gigya social action (for example, sharing, reacting, or commenting).
  • Always login – before proceeding with the Gigya social action, users are first directed to site login.
  • Login existing user – social actions are allowed with no requirement to log into the site. Behind the scenes, the following happens when such users successfully access one or more social networks:
    • Registered site users are automatically logged into the site.
    • Other users are logged into the site as temporary users.
Width 210 Specify the display width of the login widget in pixels.
Height 110 Specify the display height of the login widget in pixels.
Post Login Redirect (no default) You can choose the page to which your users will be redirected after logging in. To redirect to your blog's home page, enter http://localhost/wordpress. For your blog admin page, enter http://localhost/wordpress/wp-admin/.
Login Providers   A comma delimited list of providers that should be displayed on this plugin. Valid provider names include: facebook, twitter, yahoo, messenger, googleplus, linkedin, aol, foursquare, instagramrenren, qq, sina, kaixin, vkontakte, blogger, wordpress, typepad, paypal, amazon, livejournal, verisign, openid, netlog, signon, orangefrance, mixi, odnoklassniki, spiceworks, livedoor, skyrock, vznet, xing. 
For example, if you would like this plugin to show only the icons of Facebook and Twitter, define: facebook,twitter.
Show terms link No Select Yes to display a link to the Gigya terms of use agreement.
Show Complete Registration Form  No Select Yes if you have defined required fields in your site registration form. When checked a 'Complete Registration' form will pop up during user social registration, to let the user enter the missing required fields.
Additional Parameters (advanced) LoginUI (no default)
This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the socialize.showLoginUI API page.
Additional Parameters (advanced) AddConnectionsUI (no default) This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section. For the list of available configuration options, refer to parameters table in the socialize.showAddConnectionsUI API page.
Mapping Gigya User Fields to WordPress Fields - Gigya plugin supports pushing data from Gigya's User object fields into WordPress user fields. 
You may select below which fields to map. As a consequence, when a user registers the data will be copied from the RaaS fields to the corresponding mapped WordPress fields. Learn more in Mapping Gigya User Fields to WordPress Fields.
First Name Yes Selecting Yes would map Gigya's User.firstName field to WP's "First Name" field. Once mapped, the WordPress field will be populated from the Gigya field each time a user registers.
Last Name Yes Selecting Yes would map Gigya's User.lastName field to WP's "Last Name" field. Once mapped, the WordPress field will be populated from the Gigya field each time a user registers.
Nickname Yes Selecting Yes would map Gigya's User.nickname field to WP's "Nickname" field. Once mapped, the WordPress field will be populated from the Gigya field each time a user registers.
Avatar Yes Selecting Yes would map Gigya's User.photoURL field to WP's "Avatar" field. Once mapped, the WordPress field will be populated from the Gigya field each time a user registers.
Biographical Info Yes Selecting Yes would map Gigya's User.bio field to WP's "Biographical Info" field. Once mapped, the WordPress field will be populated from the Gigya field each time a user registers.

 

Enabling Social Login activates the Login widget. You do not have to use the widget and can rely on existing WordPress links, which will open the standard WordPress login page with added social network options (see image). You can use the Login widget to customize the sign-in options within your site. See below for an explanation of how to add the Login widget.

For more information on the Gigya Login plugin, you can refer to the Login plugin page and to the socialize.showLoginUI API method.

wordpress-socialogin-page.jpg

Note: The Gigya plugin uses version 2 of both the socialize.showLoginUI and the socialize.showAddConnectionsUI APIs. 
 

Mapping Gigya User Fields to WordPress Fields:

Gigya plugin supports pushing data from Gigya User fields into WordPress user fields. You can configure which fields to map. As a consequence, when a user registers the data will be copied from the Gigya fields to the corresponding mapped WordPress fields. Currently we support through admin panel, mapping to the following out-of-the-box WordPress fields:

  • First Name
  • Last Name
  • Nickname
  • Avatar
  • Biographical Info

If you wish to mirror additional fields, such as customly created fields, you can do so using the 'gigya_after_social_login' hook. Learn more about Gigya hooks here.

 

Registration-as-a-Service

If you choose to implement Gigya's full Registration-as-a-Service package, the following settings are displayed.

To implement RaaS, follow the instructions in the Using RaaS with WordPress page.

Note: The predefined default screen-set IDs defined in the table below were updated on September 2014. If your site was defined beforehand, there may be earlier screen-set versions configured on your site, and you may have difficulty loading the screen-sets. We recommend upgrading your screen-sets in Gigya console , or otherwise - change the Registration-as-a-Service Settings in your WordPress plugin to match the screen-sets that are already defined for your site. 

 

Field Default  Description
Connect without Login Behavior Always Login
For users not logged into the site, this field determines login requirements for performing a Gigya social action (for example, sharing, reacting, or commenting).
  • Always login – before proceeding with the Gigya social action, users are first directed to site login.
  • Login existing user – social actions are allowed with no requirement to log into the site. Behind the scenes, the following happens when such users successfully access one or more social networks:
    • Registered site users are automatically logged into the site.
    • Other users are logged into the site as temporary users.
Post Login Redirect (no default) You can choose the page to which your users will be redirected after logging in. To redirect to your blog's home page, enter http://localhost/wordpress. For your blog admin page, enter http://localhost/wordpress/wp-admin/.
Login/Registration Screen Sets  - The screens used for new user registration and existing user login. For more information, see the Screen-sets tool and the Default Screen Sets. Changes to these settings require prior definition of screen-sets.
Web Screen Set ID Default-RegistrationLogin Name of a web screen-set containing the screens used in managing user login.
Sites added to the Gigya Console before September 2014 should either upgrade the screen-sets in Gigya console, or set this parameter to "Login-web​".
Mobile Screen Set ID DefaultMobile-RegistrationLogin Name of a mobile screen-set containing the screens used in managing user login. 
Sites added to the Gigya Console before September 2014 should either upgrade the screen-sets in Gigya console, or set this parameter to "Mobile-login​".
Login Screen ID gigya-login-screen Name of the initial user login screen. This is a screen defined in the web and mobile screen-sets (with the same name in both). The default screen set uses the same screens with different CSS.
Register Screen ID gigya-register-screen Name of the new user registration screen. This is a screen defined in the web and mobile screen-sets (with the same name in both). The default screen set uses the same screens with different CSS.
Profile Screen Sets - The screens used for entering and updating user profile information.
Web Screen Set ID Default-ProfileUpdate Name of a web screen-set containing the screens used in entering user profile details. 
Sites added to the Gigya Console before September 2014 should either upgrade the screen-sets in Gigya console, or set this parameter to "Profile-web​".
Mobile Screen Set ID DefaultMobile-ProfileUpdate Name of a mobile screen-set containing the screens used in entering user profile details. 
Sites added to the Gigya Console before September 2014 should either upgrade the screen-sets in Gigya console, or set this parameter to "Profile-mobile​".
Override Wordpress Link
Override Wordpress Link Yes Selecting Yes overrides the Wordpress Login, Registration and Edit Profile links, redirecting the user to the relevant Gigya RaaS screens instead of WordPress pages.
You can find those links in WordPress's "Meta" widget, which can be found in the default store.
DIV IDs - The HTML DIV IDs in which the screen sets should be embedded.
Login loginform Within the WordPress login page.
Register registerform Within the WordPress registration page. 
Profile profile-page Within the WordPress user profile page. 
Mapping Gigya User Fields to WordPress Fields - Gigya plugin supports pushing data from RaaS Profile object fields into WordPress user fields. 
You may select below which fields to map. As a consequence, when a user registers the data will be copied from the RaaS fields to the corresponding mapped WordPress fields. Learn more in Mapping Additional Profile Fields from RaaS to WordPress.
First Name Yes Selecting Yes would map RaaS's Profile.firstName field to WP's "First Name" field. Once mapped, the WordPress field will be populated and updated from the RaaS field each time a user registers, logs-in or updates his profile (using RaaS update profile screen).
Last Name Yes Selecting Yes would map RaaS's Profile.lastName field to WP's "Last Name" field. Once mapped, the WordPress field will be populated and updated from the RaaS field each time a user registers, logs-in or updates his profile (using RaaS update profile screen).
Nickname Yes Selecting Yes would map RaaS's Profile.nickname field to WP's "Nickname" field. Once mapped, the WordPress field will be populated and updated from the RaaS field each time a user registers, logs-in or updates his profile (using RaaS update profile screen).
Avatar Yes Selecting Yes would map RaaS's Profile.photoURL field to WP's "Avatar" field. Once mapped, the WordPress field will be populated and updated from the RaaS field each time a user registers, logs-in or updates his profile (using RaaS update profile screen).
Biographical Info Yes Selecting Yes would map RaaS's Profile.bio field to WP's "Biographical Info" field. Once mapped, the WordPress field will be populated and updated from the RaaS field each time a user registers, logs-in or updates his profile (using RaaS update profile screen).
Admin Login Roles - Select below which roles should be permitted to login via standard WordPress login UI (in /wp-login.php). Learn more in Admin Users, Roles & Permissions.
Check All No Checking this checkbox, will check all the checkboxes below, i.e. all the roles listed below will be allowed  to login via standard WordPress login UI.
Note: if you create a new custom role after checking the "Check All", the new role will not be checked automatically after creation. You will need to check it manually (it will be listed below after refresh), or re-check the "Check All" again.
Author Yes An out-of-the-box WordPress role. This role is selected by default, i.e. Authors are allowed to login via standard WordPress login UI by default.
Contributor Yes An out-of-the-box WordPress role. This role is selected by default, i.e. Contributors are allowed to login via standard WordPress login UI by default.
Editor Yes An out-of-the-box WordPress role. This role is selected by default, i.e. Editors are allowed to login via standard WordPress login UI by default.
Other custom roles No If you add custom roles in you site, those roles will be listed below. The custom roles are not selected by default, i.e. not allowed to login via standard WordPress login UI by default. You may select the roles, and by that allow those roles to login via standard WordPress login UI.
 

 

Enabling Registration-as-a-Service enables the RaaS widget. You do not have to use this widget and can continue to rely on the standard WordPress login link, which will now open a Gigya login pop-up (see image) instead of the standard WordPress page.

login.jpg

You can use the RaaS widget to customize the location, size and title of the login link. See below for an explanation of how to add the RaaS widget.

To access the WordPress dashboard after activating Gigya's RaaS enter /wp-login.php?admin=true after your site's URL, as in http://<www.your-WordPress-site.com>/wp-login.php?admin=true.

 

Share Settings

The Gigya Share Bar widget lets the user share stories to social networks. 

ShareBarUI.gif

You can easily integrate the Gigya Share Bar in your WordPress blog by enabling it in the Gigya > Share settings page. You can choose whether to place it at the top or bottom (or both) of each post, and select the share providers you would like to have by writing them in the 'Share Providers' field, separated by a comma. 

For instructions on adding the widget, see below

 

Field Default  Description
Enable Share Bar plugin Checked Check to enable the Share Bar widget so that it would show on your site. Uncheck to disable the Share Bar widget and hide it throughout your site.
Set the share bar position Top Choose whether to place the Share Bar at the Top, Bottom or Both of each post. Or, you can choose to disable it by selecting None.
Show counts Right Specify if and where (right or top) to display the number of times a share button was clicked for this product.
Layout Horizontal Horizontal or Vertical. 
Share Providers  share,facebook-like,google-plusone,twitter,email Type a comma-separated list of share buttons to display. For the full list of available providers, refer to the socialize.showShareBarUI API page.
Additional Parameters (advanced) (no default)
This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the socialize.showShareBarUI API page.

 

Comments Settings (or Rating & Reviews)

The Gigya Comments enables site users to post comments and have discussions about published content on the site. The Gigya Rating & Reviews give your customers an easy way to provide feedback on product and content across your site.

Comments Settings in the WordPress Admin Panel gives you the option to choose between the Comments widget or the Rating & Reviews widget using the "Ratings and Reviews mode" checkbox (see below). Both widgets share the same configuration parameters.

Note that both the Gigya Comments and Rating & Reviews widgets supports SEO, meaning the comments/reviews content is searchable by the main search engines.

For instructions on adding the widget, see below.

 

Comments  OR Rating & Reviews
File:015_Partners/030_CMS_and_Ecommerce_Platforms/030_Wordpress_Plugin/CommentsUI2_logged-in.gif  

File:015_Partners/030_CMS_and_Ecommerce_Platforms/030_Wordpress_Plugin/ratingsUIv2.png 

Rating&Reviews.jpg

 

To use this widget, define a Category ID in Gigya's Admin Console and enter it below, then set "Enable Gigya Comments" to Yes. The rest of the settings are optional.

Field Default  Description
Enable Gigya Comments Checked Check to enable the Comments widget so that it shows on your site.
Uncheck
to disable the Comments widget and hide it throughout your site.
Ratings and Reviews mode No Select whether the widget is Comments or Ratings & Reviews (default is comments). 
Category ID   Enter the name of a comment category that you have set up in the Gigya console. To define a comment category go to the Gigya Management Console, Settings > Comments > Comments Setup. Make sure that the Category ID you define has an "Operation mode" corresponding to your selection in the "Rating & Reviews mode" checkbox above.  To learn more refer to the Setup a New Comment Category on Gigya's website.
Set the position of the comment in the post page Under post Under post or none (preventing the display of comments).
Additional Parameters (advanced) (no default)
This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the comments.showCommentsUI API page.

 

Note: The WordPress module implements internally setting the "streamID" parameter with the post ID value. That way each comments instance has its own unique steamID value - the ID of the post that the comments are about. You can override this behavior using the 'gigya_comments_params' filter. 

 

Reactions Settings

The Gigya Reactions widget enables users to share defined reactions to site products on user social networks. 

This widget displays a set of buttons like the following in a webpage:

Reactions counters

Reaction buttons are defined by an array of JSON objects. Each object defines a single Reaction button to be displayed in the reactions bar. Refer to the Reaction object for the specification of the object structure, and see also the Reaction Buttons Code Sample below.

You may also use Gigya's Reactions wizard. Make sure you are logged-in to Gigya's website, you may access the wizard by clicking the "Plugins" tab, and then the "Reactions" on the side bar.

Note: If you copy Reactions from the Reactions wizard, make sure that you paste only the Reactions buttons' objects and not the entire code.

 

For instructions on adding the widget see below.

 
Field Default Description
Enable Reactions Plugin Checked Check to enable the Reactions widget so that it would show on your site.
Uncheck to disable the Reactions widget and hide it throughout your site.
Set the position of the Reactions in a post page. Both None, Bottom, Top, Both
Providers * Specify a comma-separated list of social networks.  Leave blank or enter an asterisk (*) to enable all.
Show counts Right Right, Top or None. Each reaction button will show a count of the number of times it was activated.
Count type Number
Number or Percentage. The reaction button count is shows as a literal number or as a percentage of the total buttons pressed.
Layout Horizontal Horizontal or Vertical.  The direction in which the buttons are arranged.
Set image URL No  
Allow multiple reactions No Select Yes to allow a single user to activate multiple reactions, when set to No only one reaction is allowed per user.
Reaction Buttons No A text area for defining an array of Reaction objects, representing the buttons to display in the reactions bar.  No more than ten reaction buttons can be displayed. See below a Reaction Buttons Code Sample.
Additional Parameters (advanced) (none) This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the socialize.showReactionsBarUI API page.

 

Reaction Buttons Code Sample:

The following sample code displays these Reaction buttons Reactions widget
[
{
    text: 'Amazing',
    ID: 'amazing',
    iconImgUp:'http://cdn.gigya.com/gs/i/reactions/icons/Amazing_Icon_Up.png',
    iconImgOver:'http://cdn.gigya.com/gs/i/reactions/icons/Amazing_Icon_Down.png',
    tooltip:'This item is amazing',
    feedMessage: 'This is amazing!',
    headerText:'Your reaction to this post is \'Amazing\''
}
,{
    text: 'Geeky',
    ID: 'geeky',
    iconImgUp:'http://cdn.gigya.com/gs/i/reactions/icons/Geeky_Icon_Up.png',
    iconImgOver:'http://cdn.gigya.com/gs/i/reactions/icons/Geeky_Icon_Down.png',
    tooltip:'This item is geeky',
    feedMessage: 'This is geeky!',
    headerText:'Your reaction to this post is \'Geeky\''
}
]

 

Gamification Settings

Gigya Gamification is a social loyalty and rewards platform that you can embed in your website, increasing site engagement and making your users' experience more enjoyable.  To use this widget set "Enable Gamification plugins" to Yes. The rest of the Gamification settings are optional.

For instructions on adding the widget see below.

 gm.gif

 

Field Default  Description
Enable Gamification plugins Checked Check to enable the Gamification widgets so that they would show on your site.
Uncheck to disable the Gamification widgets and hide them throughout your site.
Enable Notifications Yes Select Yes to enable popups notifying the user of Gamification achievements: See Notifications for more details.
Leaderboard time period 7 Days Displays for the top users for the challenge within the set period: See Leaderboard for more details.
Leaderboard user count 20 Select a number between 1 - 23 to set the number of users displayed in the leaderboard.
Additional Parameters (advanced) for showAchievementsUI (no default)
This box enables you to specify configuration options beyond those available in the fields above for the Achievements plugin. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the gm.showAchievementsUI API page.
Additional Parameters (advanced) for showChallengeStatusUI (no default)
This box enables you to specify configuration options beyond those available in the fields above for the Challenge Status plugin. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the gm.showChallengeStatusUI API page.
Additional Parameters (advanced) for showLeaderboardUI (no default)
This box enables you to specify configuration options beyond those available in the fields above for the Leaderboard plugin. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the gm.showLeaderboardUI API page.
Additional Parameters (advanced) for showUserStatusUI (no default)
This box enables you to specify configuration options beyond those available in the fields above for the User Status plugin. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the gm.showUserStatusUI API page.
Additional Parameters (advanced) for showNotifications (no default)
This box enables you to specify configuration options beyond those available in the fields above for the Notifications plugin. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the gm.showNotifications API page.

 

Activity Feed

The Gigya Activity Feed widget enables users to see the latest actions on a site, according to who performed the actions. The Activity Feed widget can display elements like the following in a webpage:

 File:015_Partners/030_CMS_and_Ecommerce_Platforms/050_Magento/clipboard_1370273404186.png

The following widgets support Activity Feed:

This means that actions that are performed on the above widgets (e.g. user shared a product) are reflected in the Activity Feed.

For instructions on adding the widget, see below.
 

Field Default  Description
Enable Activity Feed plugins Checked Check to enable the Activity Feed widget so that it would show on your site.
Uncheck to disable the Activity Feed widget and hide it throughout your site.
Activity Feed privacy level Private Private, Public and Friends. See Privacy Levels.
Enable Sharing to Activity Feed  External External or Both. External feeds are published only to social network providers. Both will also publish the feed on your site. 
Tabs order (none) Possible tabs are Everyone, Friends and Me. For an example, see the basic running example.
Custom Width (none) Widget width.
Custom Height (none) Widget height.
Additional Parameters (advanced) (no default)
This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the socialize.showFeedUI API page.

 

Follow Bar

The Follow Bar plugin allows you to easily place a bar with different buttons for following news and keeping updated through different communications channels, such as a Facebook page, a Twitter account, a newsletter, a blog, etc. The Follow Bar plugin is built out of one or more buttons, arranged horizontally or vertically in a bar. Each button represents one of the supported providers:

follow_bar_tw.gif

Once a user clicks one of the buttons, a "follow" action takes place; taking the user to a new window, or redirecting the user, or opening a provider-specific dialog.

For instructions on adding the widget, see below. 

Field Default  Description
Enable Follow Bar Plugin Checked Check to enable the Follow Bar widget so that it would show on your site.
Uncheck to disable the Follow Bar widget and hide it throughout your site.
Follow Bar Buttons (none) An array of FollowButton objects.
Layout Horizontal The orientation of the Follow Bar. Options are:
  • 'Horizontal' (default)
  • 'Vertical'
Icon Size 32 The size of each icon displayed in the Follow Bar (in pixels).
Additional Parameters (advanced) (none) This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Additional Parameters (advanced) section.
For the list of available configuration options, refer to parameters table in the socialize.showFollowBarUI API page.

 

Adding the Gigya Widgets to Your Site

Gigya provides the following widgets for your site:

  • RaaS or Login (depending on the choice made in the User Management Settings).
  • Activity Feed
  • Comments
  • Gamification
  • Reactions
  • Share
  • Follow Bar

 

Note:

 

To add a widget:
  • Select Appearance and then click on Widgets.  Users who choose RaaS (Registration-as-a-Service) in the User Management Settings will see a Gigya RaaS widget, users who choose Social Login will see a Gigya Login widget.

widgets

  • Click on the Widget you want to add: Gigya Activity Feed, Gigya comments, Gigya Follow Bar, Gigya Gamification, Gigya Reactions or Gigya Share.

  • Select a location: Primary sidebar, Content sidebar or Footer widget area and then click the "Add Widget" button.

widget location

  • A box will appear for entry of options specific to this widget (the example below shows the comments widget).  Options available by widget:
  • Activity Feed - A title for the WordPress display, select Override to change the width and height of the widget.
  • Comments - A title for the WordPress display, select Override to change the comment category or set the rating mode.
  • Follow Bar - A title for the WordPress display, icon size, icon layout and buttons code.
  • Gamification - A title for the WordPress display; Select which of the Gamification plugins to display; Width of the Gamification widget in the display. 
  • Login - A title for the WordPress display, select Override to change the width and height of the widget.
  • RaaS - A title for the WordPress display, select Override to change the width and height of the widget.
  • Reactions - A title for the WordPress display.
  • Share - A title for the WordPress display.

    Comments widget example

 

Using Gigya's WordPress Shortcodes

The Gigya plugin provides a set of shortcodes as an alternative means for embedding Gigya's WordPress Widgets in your site. Using shortcodes allows a greater degree of flexibility in the placement and usage of Widgets on WordPress sites. Note that before embedding Gigya shortcodes, you must Install the Gigya WordPress plugin. After the installation configuration is required: In particular you must at least specify User Management Settings and make sure the relevant features are enabled. 

Gigya provides the following shortcodes for your site:

  • [gigya-social-login] - shows the Social Login widget.
  • [gigya-raas-login] - shows a RaaS login/registration widget. The widget shows two links, each pops-up the corresponding RaaS's Login/ Registration screens:
    File:015_Partners/030_CMS_and_Ecommerce_Platforms/030_Wordpress_Plugin/WP-RaaS-widget-loggedout.png
    When the user is logged-in the widget disappears. This shortcode doesn't accept parameters, you may customize it through CSS.
  • [gigya-raas-profile] -  shows a RaaS profile widget. The widget shows the user's avatar and name, and a "LogOut" link for logging out. The name is a link, clicking it pop-up RaaS's Update Profile screen-set.
    File:015_Partners/030_CMS_and_Ecommerce_Platforms/030_Wordpress_Plugin/WP-RaaS-widget-loggedin.png
    When the user is logged-out the widget disappears. This shortcode doesn't accept parameters, you may customize it through CSS.
  • [gigya-share-bar] - will show the Share Bar widget. 
  • [gigya-comments] - will show Comments / Rating & Reviews widget - depending on the mode selected in the  Comments Settings (or Rating & Reviews) in the WordPress admin.
  • [gigya-reactions] - will show Reactions
  • [gigya-gm-achievements] - will show Gamification's Achievements.
  • [gigya-gm-challenge-status] - will show Gamification's Challenge Status
  • [gigya-gm-leaderboard] - will show Gamification's Leaderboard
  • [gigya-gm-user-status] - will show Gamification's User Status
  • [gigya-activity-feed] - will show Activity Feed 
  • [gigya-follow-bar] - will show Follow Bar
     

Configuration and Parameters

All admin configuration options apply to the shortcodes. Note that if a plugin is disabled in the admin configuration, it will disable the shortcode as well.

The shortcodes accept parameters. If you pass shortcodes parameters, they would override the admin configuration. The parameters that the shortcodes accept are the corresponding Gigya plugin parameters. However, due to WordPress limitation, the parameter names are slightly changed: instead of camel case the parameters should be written with all lower case letters and underscores between words.

For example:[gigya-social-login] shortcode accepts the socialize.showLoginUI parameters. E.g. buttonsStyle, facebookExtraPermissions, width. We'll change the parameters names to:  buttons_style, facebook_extra_permissions, width, and pass them as the shortcode attributes:

[gigya-social-login buttons_style="full_logo" facebook_extra_permissions="user_likes" width=100]

Buttons_style="full_logo" and width=100 override your corresponding WordPress + Social Login configuration.

Note: Some of the Gigya features require setup and enabling in the Gigya Plugin Configuration before they can be used.

 

Using the Gigya Plugin in Multi-Site Installations

Of the various multi-site configurations offered by WordPress, the following are supported for integration with Gigya:

(A) All sites share the same base domain:

This includes both configurations where sites reside in separate sub-domains and configurations where the sites are kept in sub-directories. In both cases, there is only one site to set up with Gigya, and therefore a single Gigya API key and a single user database.

To set up this configuration:

  1. In the Gigya console, set up your master site.
  2. If you are using sub-domains for your sub-sites, define them as Trusted URLs using wildcards (see Trusted URLs).
  3. In the WordPress dashboard of your master site, install the Gigya plugin as described above.

(B) Each site has a separate domain:

This configuration is possible if you use one of the available third-party plugins for WordPress that map your sub-domains to different base domains. The sites will share a single user database.

To set up this configuration:

  1. In the Gigya console, set up each site separately, so that each site gets its own Gigya API key.
  2. Define the sites as a site group, with the base domain as the master site, and connect the sites via Gigya's Single Sign-On feature. Please contact your Gigya Implementation Manager to configure Site Group and SSO for you.
  3. In the WordPress dashboard of your master site, install the Gigya plugin as described above.
  4. Enable the Gigya plugin in all your individual sites using Network Enablement.
  5. In each site's WordPress dashboard, change the Gigya API key to the key of the specific site. You may change other settings, such as language, if required for your installation.

In this configuration, deleting a user from one of the sub-sites does not remove that user from the shared database. The user is simply disconnected from the specific sub-site. To remove a user from the database, delete the user from the network panel.

Note also that when adding a new sub-site, the Gigya plugin settings are copied from the master site into the sub-site, but you have to save the plugin settings once in order to activate them.

 

In both of these configurations, the user database is shared between sites in the multi-site installation. If you want to use one of the available WordPress plugins to help you keep separate user lists for your sites, be advised that this capability has not been tested for use with Gigya, and the users may not be synchronized perfectly with the Gigya database.

Page statistics
5057 view(s) and 10 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments