User Guide of Magento 2 Testimonials Extension

Configurations

On the admin panel sidebar, go to FME EXTENSIONS and click Customer Review and Testimonials Configurations. Here you will find the following settings:

• Enable Module: Select ‘Yes’ or ‘No’ to Enable/Disable the module

• Layout Type: Select any one layout type:

  • Detail Layout
  • Simple Layout

Simple Layout Settings

• Enable Pagination: Select ‘Yes’ or ‘No’ to Enable/Disable the pagination
• Number of Testimonial Per Page: Specify the total number of testimonials that you want to display on one page e.g. 7
• Number of Character Per Testimonial: Specify the total number of characters per testimonials e.g. 500

Dashboard Settings

• Enable Dashboard: Select ‘Yes’ or ‘No’ to Enable/Disable the dashboard
• Main Header: Provide header for the testimonial page e.g. Customer Reviews
• Button Name: Enter the name of the button e.g. Write a Review
• Review Note: Enter a review note e.g. Share your thoughts with other customers

• Show Advantages: Select ‘Yes’ or ‘No’ to Show/Hide the advantages
• Show Dis-Advantages: Select ‘Yes’ or ‘No’ to Show/Hide the dis-advantages

Reply Settings

• Reply Label Option: Enter a title/label for the reply option e.g. Leave Comments
• Button Option: Enter a title/label for the button option e.g. Add Comment

Add Testimonials Settings

• Customers Allowed: Select ‘No’ to dis-allow customers or specify he allowed customers who can publish testimonials:
  • Guests
  • Registered
• Form Type: Select any of the following testimonials forms:
  • Pop Up
  • Sliding
• Need Admin Approval For Testimonial: Select ‘Yes’ or ‘No’ to Enable/Disable approval by admin once testimonials are submitted
• Need Admin Approval For Comments: Select ‘Yes’ or ‘No’ to Enable/Disable approval by admin once comments are submitted
• Button Name: Enter a text for testimonials submission button e.g. Add Testimonials
• Response Message: Enter a text for testimonial publishing message e.g. Testimonials Successfully Added

Testimonials List

• Page title: Enter title for testimonials listing page e.g. Testimonials
• List Heading: Enter a heading for the testimonial listing page e.g. What Our Customers Say!
• Meta Keywords: Enter the meta keywords
• Meta Description: Enter a meta description

Email Option

• Send Emails To: Enter an email address where testimonial submissions information will be delivered e.g. xyz@gmail.com

• Email Sender: Select email-sender from the following:

  • General Contact
  • Sales representative
  • Customer support
  • Custom Email 1
  • Custom Email 2

• Email Template: Choose an email template. An email template is chosen based on theme fallback when the "Default" option is selected.

• Email Template (Default)

• New Pickup Order

• New Pickup Order For Guest

Email Subject: Enter the subject of the email for submissions

Search Engine Optimization

● SEO URL Identifier: Specify URL identifier ● URL Suffix: Provide URL suffix e.g. .html

Footer Settings

● Footer Title: Specify the title for the footer link

GraphQL APIs

1. Show All Testimonials:

Description: Fetches paginated customer testimonials for a store, allowing filtering by image availability, sorting by rating, and displaying likes, dislikes, and related comments. Also provides pagination details, including total count, current page, total pages, and page size.

Query

query {
 showAllTestimonials(filterBy: WithAndWithOutImage, page: 2, pageSize: 5, sortBy: Rating,
sortOrder: DESC) {
 items {
 testimonial_id
 contact_name
 email
 summary
 review
 rating
 postingdate
 image
 likeCount
 disLikeCount
 comments {
 comment_id
 name
 email
 comment
 dateofposting
 }
 }
 total_count
 page_info {
 current_page
 total_pages
 page_size
 }
 }
}

Result

{
 "data": {
 "showAllTestimonials": {
 "items": [
 {
 "testimonial_id": 1,
 "contact_name": "waqar Ahmed",
 "email": "waqar.ahmed@unitedsol.net",
 "summary": "Testing 1",
 "review": "Testing 1",
 "rating": "0",
 "postingdate": "2025-02-11 05:41:10",
 "image": "http://guest-tocustomer.local/media/Testimonials/images/image/s/c/screenshot_from_2025-02-03_18-18-33.png",
 "likeCount": "1",
 "disLikeCount": "0",
 "comments": [
 {
 "comment_id": 1,
 "name": "Naeem Adil",
 "email": "naeem@gamil.com",
 "comment": "Test 12",
 "dateofposting": "2025-02-11 05:59:42"
 },
{
 "comment_id": 4,
 "name": "waqar Ahmed",
 "email": "waqar.ahmed@unitedsol.net",
 "comment": "Test 123",
 "dateofposting": "2025-02-13 10:32:45"
 },
{
 "comment_id": 5,
 "name": "waqar Ahmed",
 "email": "ahmedwaqar0304@gmail.com",
 "comment": "Yes You Are Correct",
 "dateofposting": "2025-02-14 06:39:54"
 }
 ]
 },
 {
 "testimonial_id": 2,
 "contact_name": "waqar Ahmed",
 "email": "waqar.ahmed@unitedsol.net",
 "summary": "Testing 1",
 "review": "Testing 1",
 "rating": "0",
 "postingdate": "2025-02-11 05:42:14",
 "image": "http://guest-tocustomer.local/media/Testimonials/images/image/s/c/screenshot_from_2025-02-03_18-18-33_1.png",
 "likeCount": "0",
 "disLikeCount": "0",
 "comments": []
},
 {
 "testimonial_id": 30,
 "contact_name": "waqar Ahmed",
 "email": "waqar.ahmed@unitedsol.net",
 "summary": "Summary",
 "review": "Review",
 "rating": "0",
 "postingdate": "2025-02-13 11:55:44",
 "image": null,
 "likeCount": "0",
 "disLikeCount": "0",
 "comments": []
 }
 ],
 "total_count": 8,
 "page_info": {
 "current_page": 2,
 "total_pages": 2,
 "page_size": 5
 }
 }
 }
}

2. Get All Review Statistics

Description: Retrieves all store-specific reviews, including a breakdown of ratings by star count and percentage distribution.

Query

query {
showAllReviewStatics {
 oneStarRating
 oneStarCounting
 twoStarRating
 twoStarCounting
 threeStarRating
 threeStarCounting
 fourStarRating
 fourStarCounting
 fiveStarRating
 fiveStarCounting
 totalPercentage
}
}

Result

{
 "data": {
 "showAllReviewStatics": {
 "oneStarRating": 50,
 "oneStarCounting": 4,
 "twoStarRating": 12,
 "twoStarCounting": 1,
 "threeStarRating": 0,
 "threeStarCounting": 0,
 "fourStarRating": 0,
 "fourStarCounting": 0,
 "fiveStarRating": 0,
 "fiveStarCounting": 0,
 "totalPercentage": 15
 }
 }
}

3. Create Testimonials

Description: Creates a new customer testimonial with details including rating, contact name, email, summary, full review, advantages, disadvantages, and an optional image in base64 format. Returns a success status and message upon successful submission.

Mutation

mutation {
 createTestimonials(input: {
29
 rating: "1.5",
 contact_name: "Waqar Ahmed from hassan",
 email: "waqar.ahmed@unitedsol.net",
 summary: "Great product!",
 review: "I really enjoyed using this product. Highly recommend!",
 advantage: "Easy to use, very efficient.",
 disadvantage: "A bit expensive.",
 image:”Here include base 64 converted image”
 }) {
 success
 message
 }
}

Result

{
 "data": {
 "createTestimonials": {
 "success": true,
 "message": "Testimonial Sucessfully Added"
 }
 }
}

4. Add Testimonial Comment

Description: Adds a comment to an existing testimonial by specifying the testimonial ID, commenter’s name, email, and comment text. Returns a success status and message upon successful submission.

Mutation

mutation {
 createTestimonialsComment(input: {
 testimonial_id: 29
 name: "Waqar Ahmed"
 email: "waqar.ahmed@unitedsol.net"
 comment: "Yes You Are Right"
 }) {
 success
 message
 }
}

Result

{
 "data": {
 "createTestimonialsComment": {
 "success": true,
 "message": "Your comment has been submitted successfully."
 }
 }
30
}