mhinspeya/hyva-googlereviews

MHinspeya GoogleReviews Plugin

1.0.3 2026-07-22 13:12 UTC

Requires

• mhinspeya/backend-mod: ^1.0

GPL-3.0

• MHinspeya

• magento
• magento 2
• hyva
• MHinspeya

Published on Packagist.org on 2026-07-22 13:13 UTC

README

Package: mhinspeya/hyva-googlereviews
Module: MHinspeya_GoogleReviews
Version: 1.0.2
License: GPL-3.0

Magento 2 / Hyvä-compatible extension to connect Google Business reviews, manage them in the admin, and display them on the storefront via a widget and floating badge.

Table of contents

• Features
• Requirements
• Installation
• Upgrade
• Configuration
• Google account setup
• Import reviews
• Manage reviews in admin
• Frontend display
• Admin menu & ACL
• Cron
• Disable / uninstall
• Support

Features

Admin

• Google Account management – create accounts with Google OAuth Client ID / Client Secret
• Grant Access – OAuth flow to authorize Google Business access and store access/refresh tokens
• Import reviews – pull reviews from Google My Business API into Magento
• Reviews grid – list, filter, inline edit, enable/disable, favourite/unfavourite, mass actions, delete
• License key validation – module license check via configuration
• Store configuration – enable module, select accounts, widget options, badge position

Storefront

• CMS / Widget – MHinspeya Google Reviews widget with custom heading and item count
• Review display options – slider or grid, customer icon/name, star or numeric ratings
• Review filters – all reviews, latest reviews, or favourite reviews
• Floating Google badge – optional fixed badge (top/bottom left/right)

Technical

• ACL resources for Reviews, Account, and Configuration
• Admin routes under mhinspeya_googlereviews
• DB tables: mhinspeya_googlereviews_account, mhinspeya_googlereviews_reviews
• Depends on mhinspeya/backend-mod (Inspeya admin menu parent)

Requirements

Requirement	Version / note
Magento Open Source / Adobe Commerce	2.4.x
PHP	Compatible with your Magento version
Dependency	mhinspeya/backend-mod (^1.0)
Google Cloud	OAuth 2.0 Client ID & Client Secret
Google Business	Location with reviews API access
Optional	Hyvä Theme (compatible frontend usage)

Installation

In production, prefer php bin/magento setup:upgrade --keep-generated only when you understand your deploy pipeline. After code changes, run setup:di:compile and static content deploy as needed.

Option 1 – App code (zip / copy)

1. Copy the module into Magento:

app/code/MHinspeya/GoogleReviews

1. Enable and install:

php bin/magento module:enable MHinspeya_BackendMod MHinspeya_GoogleReviews
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

1. In production mode, also deploy static content if required:

php bin/magento setup:static-content:deploy -f

Option 2 – Composer

1. Ensure your Magento project can reach the package repository (private Packagist, VCS, or Artifactory).

2. Require and enable:

composer require mhinspeya/hyva-googlereviews
php bin/magento module:enable MHinspeya_BackendMod MHinspeya_GoogleReviews
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

Verify installation

php bin/magento module:status MHinspeya_GoogleReviews

Expected: Module is enabled.

In Admin you should see:

INSPEYA → MHinspeya Google Reviews → Reviews | Account | Settings

Upgrade

# After replacing module files or composer update
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

Configuration

Path: INSPEYA → MHinspeya Google Reviews → Settings
or Stores → Configuration → MHinspeya google reviews → Settings

ACL resource: MHinspeya_GoogleReviews::Config

1. License Key

Field	Path	Description
License Key	mhgooglereview/license/license_key	Required license key for the extension

Enter the key provided by MHinspeya and save. An invalid license may disable module usage.

2. General

Field	Path	Description
Enable	mhgooglereview/general/enable	Master switch for storefront output
Select accounts	mhgooglereview/general/accounts	Which Google accounts’ reviews are used on the frontend

1. Set Enable to Yes.
2. Select one or more accounts (accounts must exist under Account first).
3. Save config and flush cache.

3. Widget Settings

Field	Description
Display Slider	Show reviews in a carousel (Owl) instead of a static grid
Show Customer icon	Show reviewer profile image
Show Customer Name	Show reviewer display name
Show ratings	Show star / numeric rating
Rating Type	In numbers or In Stars
Show Ratings From	Minimum rating filter source
No of reviews pass to widget	Default number of reviews when widget “Show items” is empty
Filter Review To Display	All Reviews / Latest Reviews / Favourite Reviews

4. Badge Settings

Field	Description
Show badge	Enable floating Google reviews badge site-wide
Badge position	Top Left, Top Right, Bottom Left, Bottom Right

Badge is injected via default.xml when enabled.

5. Email settings (cron notifications)

Used when the import cron finds new reviews (config paths used by cron):

Path	Purpose
mhgooglereview/email_settings/email_sender_name	Sender name
mhgooglereview/email_settings/sender_email	Sender email
mhgooglereview/email_settings/receiver_name	Primary recipient
mhgooglereview/email_settings/reciever_name_2	Optional second recipient

Configure these under your store’s email / custom config as applicable, and ensure Magento email sending works.

Google account setup

Step 1 – Create Google OAuth credentials

1. Open Google Cloud Console.
2. Create or select a project.
3. Enable the required Google Business / My Business APIs for your project.
4. Create OAuth 2.0 Client ID (Web application).
5. Add authorized redirect URI:

https://YOUR-STORE-DOMAIN/mh_googlereviews/oauth/success/

Example for local:

http://localhost/Hyvapluginshyva/pub/mh_googlereviews/oauth/success/

1. Copy Client ID and Client Secret.

Step 2 – Create account in Magento

1. Go to INSPEYA → MHinspeya Google Reviews → Account.
2. Click Add new Account.
3. Fill in:
   • Name (unique)
   • Status
   • Client id
   • Client secret
4. Save the account.

Step 3 – Grant Access (OAuth)

1. Open the saved account.
2. Click Grant Access.
3. Sign in with the Google account that owns the Business Profile.
4. Allow the requested permissions.
5. On success, Magento stores:
   • Access token
   • Refresh token
   • Google account ID
   • Location ID / title

You should see a success message in the OAuth success window. Close it and return to Admin.

Import reviews

Manual import (recommended first time)

1. Open the connected Account.
2. Click Import.
3. The module refreshes the access token (if needed) and fetches reviews from Google.
4. New reviews are saved into the Reviews grid.
5. You are redirected to Reviews on success.

After import

• Open INSPEYA → MHinspeya Google Reviews → Reviews
• Enable reviews you want on the storefront (Status)
• Optionally mark Favourite reviews for the favourite filter

Manage reviews in admin

Path: INSPEYA → MHinspeya Google Reviews → Reviews
ACL: MHinspeya_GoogleReviews::Reviews_view

Action	Description
Enable / Disable	Control storefront visibility
Favourite / Unfavourite	Mark reviews for “Favourite Reviews” filter
Edit	Update review fields
Delete	Remove a review
Mass actions	Enable, disable, favourite, unfavourite, delete selected rows
Inline edit	Quick edits from the grid

Frontend display

A) CMS Widget

1. Ensure General → Enable is Yes.
2. Admin → Content → Widgets → Add Widget.
3. Type: MHinspeya Google Reviews.
4. Assign to store / layout / container (or CMS page).
5. Widget options:
   • Reviews heading – title above the list
   • Show items – how many reviews to show (falls back to config review_count if empty)
6. Save and flush cache.

Widget respects:

• Selected accounts
• Slider / grid settings
• Icon, name, rating display
• Review type filter (all / latest / favourite)
• Only enabled reviews

B) Floating badge

1. Badge Settings → Show badge = Yes
2. Choose Badge position
3. Save config + flush cache

The badge appears on pages using the default layout handle.

Admin menu & ACL

Menu parent: INSPEYA (MHinspeya_BackendMod)

Menu	ACL resource
MHinspeya Google Reviews (root)	MHinspeya_GoogleReviews::root
Reviews	MHinspeya_GoogleReviews::Reviews_view
Account	MHinspeya_GoogleReviews::Account_view
Settings	MHinspeya_GoogleReviews::Config

Assign these under System → Permissions → User Roles for non-administrator users.

Cron

Class: MHinspeya\GoogleReviews\Cron\ImportReview

Scheduled import can refresh tokens, fetch reviews, and email admins about new reviews.

To use cron:

1. Ensure Magento cron is running (cron:run / system crontab).
2. Register the job in your environment’s crontab.xml (or custom schedule module) pointing to:

MHinspeya\GoogleReviews\Cron\ImportReview::execute

1. Configure email sender/receiver paths listed above.

Disable / uninstall

Disable

php bin/magento module:disable MHinspeya_GoogleReviews
php bin/magento setup:upgrade
php bin/magento cache:flush

Or set General → Enable to No to hide storefront output while keeping admin data.

Uninstall (manual)

1. Disable the module.
2. Remove app/code/MHinspeya/GoogleReviews (or composer remove mhinspeya/hyva-googlereviews).
3. Optionally drop tables:

DROP TABLE IF EXISTS mhinspeya_googlereviews_reviews;
DROP TABLE IF EXISTS mhinspeya_googlereviews_account;

1. Run setup:upgrade and flush cache.

Quick start checklist

• [ ] Install & enable MHinspeya_BackendMod + MHinspeya_GoogleReviews
• [ ] Enter License Key
• [ ] Create Google OAuth client + redirect URI
• [ ] Create Magento Account with Client ID / Secret
• [ ] Click Grant Access and complete OAuth
• [ ] Click Import
• [ ] Enable desired reviews (and favourites if needed)
• [ ] Settings → Enable = Yes, select accounts, configure widget/badge
• [ ] Place MHinspeya Google Reviews widget on CMS/page
• [ ] Flush cache and verify storefront

Support

• Vendor: MHinspeya
• Module: MHinspeya_GoogleReviews
• Package: mhinspeya/hyva-googlereviews

For license keys, API access issues, or customization requests, contact MHinspeya support with your Magento version and module version (1.0.2).