WordPress Plugin

Skip to end of metadata
Go to start of metadata

Unable to render {include} The included page could not be found.

 

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.1 is compatible with WordPress versions 3.6.x-4.2.5 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.

Social Plugins 

The Gigya platform includes a series of plugins that integrate your site with users' social networks and create a compelling and fulfilling user experience. These plugins have a fully configurable user interface design:

  • Share – Users can easily Share posts with their social networks friends.
  • Comments – Gigya's Comments plugin enables site users to post comments and have discussions about published content on your site.
  • Loyalty – Also known as "Gamification", this is a social loyalty and rewards platform that can be easily embedded in your website, increasing site engagement and making your users' experience more enjoyable.
  • Reactions – The Reactions plugin allows users to react to content in your site and share their reaction to social networks.
  • Rating & Reviews – The R&R plugins 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.

 

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:

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

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.

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:

  • Download the Gigya Plugin for WordPress.

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

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

  • You should see your new plugin listed:

    Click to enlarge screenshot

    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.

  • Click the Activate link below the "Gigya – Make Your Site Social" plugin title. The page should now show the Gigya plugin as active.

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

Click to enlarge screenshot

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.

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.

FieldDefault 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).

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 CenterUS Data CenterThe 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 Consultant 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.
LanguageEnglish

The plugin supports localization. In the list, select a supported language for display on your website.

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 Web SDK and initializes the Gigya API. The configuration is passed as an object to the script call).

Enable Google Social AnalyticsNoSelect Yes to enable the Google Social Analytics plugin. For details, refer to the Third-Party Analytics Integration page.
Enable Gigya debug logNoSelect 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" }

Click to enlarge screenshot

  • The Additional Parameters in all sections override existing configurations and must be used carefully.
  • The Additional Parameters cannot include events. or hooks.

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.

Click to enlarge screenshot

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:

FieldDefault Description
Button styleStandardSpecify 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
(Deprecated) 
Login existing userFor 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.
Width210Specify the display width of the login widget in pixels.
Height110Specify 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, instagram , renren, qq, sina, vkontakte, blogger, wordpress, paypal, amazon, netlog, orangefrance, mixi, odnoklassniki, spiceworks, livedoor, xing.
For example, if you would like this plugin to show only the icons of Facebook and Twitter, define: facebook,twitter.
Show terms linkNoSelect Yes to display a link to the Gigya terms of use agreement.
Show Complete Registration FormNoSelect 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, see the 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, see the 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 NameYesSelect Yes to map Gigya's User.firstName field to WP's "First Name" field. Once mapped, the WP field is populated from the Gigya field whenever a user registers.
Last NameYesSelect Yes to map Gigya's User.lastName field to WP's "Last Name" field. Once mapped, the WP field is populated from the Gigya field whenever a user registers.
NicknameYesSelect Yes to map Gigya's User.nickname field to WP's "Nickname" field. Once mapped, the WP field is populated from the Gigya field whenever a user registers.
AvatarYesSelect Yes to map Gigya's User.photoURL field to WP's "Avatar" field. Once mapped, the WP field is populated from the Gigya field whenever a user registers.
Biographical InfoYesSelect Yes to map Gigya's User.bio field to WP's "Biographical Info" field. Once mapped, the WP field is populated from the Gigya field whenever 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.

Click to enlarge screenshot

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 the 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 custom-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.

Make sure that the screen-set IDs defined in your integration's settings match the screen-set IDs defined for your site in the Screen-Sets page in the Gigya console.

  • If your Gigya RaaS was set up in the Gigya Console after 10/26/2015, it is using new default screen-set names, which do not match the screen-set names used by this integration out-of-the-box. To set up your integration to use the correct screen-sets names, go to your integration settings and select Registration-as-a-Service settings. In the screen-set IDs table, copy the ID of every Web Screen-Set into the matching Mobile Screen-Set. For example, in the integration's default settings, the Registration/Login screen-sets are set to Default-RegistrationLogin and DefaultMobile-RegistrationLogin, for web and mobile, respectively. They should both say Default-RegistrationLogin.
  • If your site was set up in the Gigya console before September 2014, it will be using older screen-set names.

See Default Screen-Sets for more information.

FieldDefault Description
Connect without Login BehaviorAlways LoginFor 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 IDDefault-RegistrationLoginName of a web screen-set containing the screens used in managing user login.
Mobile Screen Set IDDefaultMobile-RegistrationLoginName of a mobile screen-set containing the screens used in managing user login.
Login Screen IDgigya-login-screenName 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 IDgigya-register-screenName 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 IDDefault-ProfileUpdateName of a web screen-set containing the screens used in entering user profile details.
Mobile Screen Set IDDefaultMobile-ProfileUpdateName of a mobile screen-set containing the screens used in entering user profile details.
Override Wordpress Link
Override Wordpress LinkYesSelecting 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 these 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.
LoginloginformWithin the WordPress login page.
RegisterregisterformWithin the WordPress registration page.
Profileprofile-pageWithin 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 NameYesSelect Yes to map RaaS's Profile.firstName field to WP's "First Name" field. Once mapped, the WP field is updated from the RaaS field whenever a user registers, logs in or updates their profile (using RaaS update profile screen).
Last NameYesSelect Yes to map RaaS's Profile.lastName field to WP's "Last Name" field. Once mapped, the WP field is updated from the RaaS field whenever a user registers, logs in or updates their profile.
NicknameYesSelect Yes to map RaaS's Profile.nickname field to WP's "Nickname" field. Once mapped, the WP field is updated from the RaaS field whenever a user registers, logs in or updates their profile.
AvatarYesSelect Yes to map RaaS's Profile.photoURL field to WP's "Avatar" field. Once mapped, the WP field is updated from the RaaS field whenever a user registers, logs in or updates their profile.
Biographical InfoYesSelect Yes to map RaaS's Profile.bio field to WP's "Biographical Info" field. Once mapped, the WP field is updated from the RaaS field whenever a user registers, logs in or updates their profile.
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 AllNo

Select this checkbox to check all the boxes - meaning all the roles listed below will be allowed to login via standard WordPress login UI.

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.

AuthorYesAn out-of-the-box WordPress role. This role is selected by default, meaning Authors are allowed to login via standard WordPress login UI by default.
ContributorYesAn out-of-the-box WordPress role. This role is selected by default, meaning Contributors are allowed to login via standard WordPress login UI by default.
EditorYesAn out-of-the-box WordPress role. This role is selected by default, meaning Editors are allowed to login via standard WordPress login UI by default.
Other custom rolesNoIf you add custom roles in you site, these roles are listed below. The custom roles are not selected by default, i.e., not allowed to login via standard WordPress login UI by default.

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.

Click to enlarge screenshot

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://<your-domain>/wp-login.php?admin=true .

Share Settings

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

Click to enlarge screenshot

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.

FieldDefault Description
Enable Share Bar pluginCheckedCheck 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 positionTopChoose 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 countsRightSpecify if and where (right or top) to display the number of times a share button was clicked for this product.
LayoutHorizontalHorizontal or Vertical.
Share Providersshare,facebook-like,google-plusone,twitter,emailType 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, see the parameters table in the socialize.showShareBarUI API page.

 

Comments Settings (or Rating & Reviews)

Gigya Comments enable site users to post comments and have discussions about published content on the site. Gigya Ratings & 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 widgets supports SEO, meaning the comments/reviews content is searchable by the main search engines.

For instructions on adding the widget, see below.

 

Comments:

Click to enlarge screenshot

Rating & Reviews:

Click to enlarge screenshot

Click to enlarge screenshot

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.

FieldDefault Description
Enable Gigya CommentsCheckedCheck 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 modeNoSelect 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 pageUnder postUnder 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, see the parameters table in the comments.showCommentsUI API page.

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:

Click to enlarge screenshot

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.

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.

FieldDefaultDescription
Enable Reactions PluginCheckedCheck 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.BothNone, Bottom, Top, Both
Providers*Specify a comma-separated list of social networks. Leave blank or enter an asterisk (*) to enable all.
Show countsRightRight, Top or None. Each reaction button will show a count of the number of times it was activated.
Count typeNumberNumber or Percentage. The reaction button count is shows as a literal number or as a percentage of the total buttons pressed.
LayoutHorizontalHorizontal or Vertical. The direction in which the buttons are arranged.
Set image URLNo 
Allow multiple reactionsNoSelect Yes to allow a single user to activate multiple reactions, when set to No only one reaction is allowed per user.
Reaction ButtonsNoA 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, see the parameters table in the socialize.showReactionsBarUI API page.

Reaction Buttons Code Sample:

The following sample code displays these Reaction buttons:

Click to enlarge screenshot

[ {
    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 Loyalty - Gamification and User Behavior 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.

Click to enlarge screenshot

 

FieldDefault Description
Enable Gamification pluginsCheckedCheck 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 NotificationsYesSelect Yes to enable popups notifying the user of Gamification achievements: See Notifications for more details.
Leaderboard time period7 DaysDisplays for the top users for the challenge within the set period: See Leaderboard for more details.
Leaderboard user count20Select 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, see the parameters table for the gm.showAchievementsUI API method.
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, see the parameters table for the gm.showChallengeStatusUI API method.
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, see the parameters table for the gm.showLeaderboardUI API method.
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, see the parameters table for the gm.showUserStatusUI API method.
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, see the parameters table for the gm.showNotifications API method.

Activity Feed

The Activity Feed widget has been deprecated. If you are using the Activity widget in your site, please deactivate it before that time to prevent errors.

To deactivate the Follow Bar:

  1. In the admin console, go to Gigya > Activity Feed
  2. Uncheck the Enable Activity Feed Plugin checkbox.

 

Follow Bar

The Follow Bar widget has been deprecated. If you are using the Follow Bar widget in your site, please deactivate it before that time to prevent errors.

To deactivate the Follow Bar:

  1. In the admin console, go to Gigya > Follow Bar.
  2. Uncheck the Enable Follow Bar Plugin checkbox.

 

Adding the Gigya Widgets to Your Site

Gigya provides the following widgets for your site:

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.

Click to enlarge screenshot

  • Click on the Widget you want to add:Gigya comments, 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.

Click to enlarge screenshot

  • A box will appear for entry of options specific to this widget (the example below shows the comments widget). Options available by widget:
  • Comments – A title for the WordPress display, select Override to change the comment category or set the rating mode.
  • 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.
    Click to enlarge screenshot

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: 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:

    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.

    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/R&R 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

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.

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

Troubleshooting

General

  • The server clock must be set to GMT+0, otherwise errors and unexpected behaviors may occur. We recommend using NTP daemon to ensure that the server time is accurate.
  • Gigya screen-sets must entirely replace any login, registration etc. screen provided by the CMS. The CMS registration, login and edit profile screens should not be rendered at all. Otherwise, the Gigya screen is placed inside the CMS screen and both will behave unexpectedly. 
  • After changing the value of the application key, you should re-enter the application secret.

 

Save

Save