Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/virtuallycreative/qf-gbp-wp

A WordPress plugin that provides a shortcode and an Elementor widget for rapid in-person customer feedback.
https://github.com/virtuallycreative/qf-gbp-wp

Last synced: 8 months ago
JSON representation

A WordPress plugin that provides a shortcode and an Elementor widget for rapid in-person customer feedback.

Awesome Lists containing this project

README 

          



# 🌟 ReviewFlow.me - Quick Feedback Reviews



**Transform customer feedback into Google Business Profile reviews with intelligent routing**



[![WordPress Plugin Version](https://img.shields.io/badge/WordPress-6.0%2B-blue.svg)](https://wordpress.org/)

[![PHP Version](https://img.shields.io/badge/PHP-7.4%2B-purple.svg)](https://php.net/)

[![License](https://img.shields.io/badge/License-GPL%20v2%2B-green.svg)](https://www.gnu.org/licenses/gpl-2.0.html)

[![Elementor Compatible](https://img.shields.io/badge/Elementor-Compatible-pink.svg)](https://elementor.com/)

[![WCAG 2.1 AA](https://img.shields.io/badge/Accessibility-WCAG%202.1%20AA-brightgreen.svg)](https://www.w3.org/WAI/WCAG21/quickref/)



---



_A powerful WordPress plugin that provides a shortcode and Elementor widget for rapid in-person customer feedback with smart routing to Google Business Profile reviews. Features kiosk mode for tablets and real-time WCAG accessibility checking._



[🚀 **Get Started**](#installation) • [📖 **Documentation**](#usage) • [🎨 **Customization**](#customization-options) • [🛠️ **Support**](#support)






---



## 📋 Table of Contents



-   [✨ Key Features](#-key-features)

-   [🔄 How It Works](#-how-it-works)

-   [🚀 Installation](#-installation)

-   [📖 Usage](#-usage)

    -   [Shortcode Usage](#shortcode-usage)

    -   [Elementor Integration](#elementor-integration)

-   [🎨 Customization Options](#-customization-options)

-   [🔒 Security & Privacy](#-security--privacy)

-   [👩‍💻 Developer Features](#-developer-features)

-   [❓ FAQ](#-frequently-asked-questions)

-   [📸 Screenshots](#-screenshots)

-   [📝 Changelog](#-changelog)

-   [🛠️ Support](#-support)



---



## ✨ Key Features



### 🎯 **Smart Rating System**



-   ⭐ 5-star rating interface with intelligent routing

-   🔄 Dual workflow for optimal customer experience

-   📱 Mobile-responsive design



### 🛡️ **Security & Privacy**



-   🍯 Honeypot anti-spam protection

-   ⏱️ Time-trap bot prevention

-   🔐 Nonce verification & input sanitization

-   🇪🇺 GDPR-compliant consent management



### ♿ **Accessibility First**



-   🏆 WCAG 2.1 AA compliant

-   ⌨️ Full keyboard navigation support

-   📢 Screen reader announcements

-   🎨 High contrast mode support



### 🔌 **Multiple Integration Options**



-   📝 Shortcode: `[quick_feedback]`

-   🎨 Elementor Widget with visual controls

-   📦 Block Editor compatible

-   🖥️ **NEW:** Kiosk mode for tablets



### 🎨 **Highly Customizable**



-   🎨 CSS variables & color schemes

-   📝 Typography customization

-   💬 Custom text & messages

-   📐 Adjustable spacing controls



### 👨‍💻 **Developer Friendly**



-   🪝 Action & filter hooks

-   🌐 REST API endpoint

-   📊 JavaScript events

-   🔧 Extensible architecture



### 🔄 **Intelligent Workflow**



```mermaid

graph LR

    A["Customer sees rating interface"] --> B{"Rating given"}

    B -->|"1-3 stars"| C["Private feedback form"]

    B -->|"4-5 stars"| D["Success message"]

    C --> E["Email notification to admin"]

    D --> F["Redirect to Google Business Profile"]

    D --> G["QR Code display - Kiosk mode"]

```



## 🔄 How It Works






### 📱 **Step-by-Step Process**






| Step   | Action                         | Result                                         |

| ------ | ------------------------------ | ---------------------------------------------- |

| **1️⃣** | Customer sees rating interface | Large, accessible 5-star selector displayed    |

| **2️⃣** | **Low ratings (1-3 stars)**    | Shows feedback form with optional contact info |

| **3️⃣** | **High ratings (4-5 stars)**   | Shows success message + redirect/QR code       |

| **4️⃣** | Admin notification             | Email sent with feedback details (low ratings) |

| **5️⃣** | Optional logging               | Submissions stored in WordPress database       |






### 🎯 **Perfect For**



🏪 **Retail Stores** • 🍽️ **Restaurants** • 🏥 **Healthcare** • 🏨 **Hospitality** • 🔧 **Service Businesses**






## 📖 Usage



### 📝 **Shortcode Usage**



🔽 Basic & Advanced Examples



#### 🚀 **Basic Usage**



```php

[quick_feedback]

```



#### 🎨 **With Custom Styling**



```php

[quick_feedback brand_color="#ff6b35" redirect_target="_blank" show_contact="false"]

```



#### 🖥️ **Kiosk Mode (Perfect for Tablets)**



```php

[quick_feedback kiosk_mode="true" qr_code_image="https://example.com/qr-code.png"]

```



🔽 All Available Attributes



| Attribute              | Type    | Description                          | Example                                     |

| ---------------------- | ------- | ------------------------------------ | ------------------------------------------- |

| `gbp_url`              | URL     | Override Google Business Profile URL | `gbp_url="https://g.page/..."`              |

| `redirect_target`      | String  | `"_self"` or `"_blank"` for redirect | `redirect_target="_blank"`                  |

| `brand_color`          | Color   | Custom brand color (hex code)        | `brand_color="#ff6b35"`                     |

| `show_contact`         | Boolean | Show/hide contact fields             | `show_contact="false"`                      |

| `headline`             | String  | Custom main headline                 | `headline="Rate Your Experience"`           |

| `subhead`              | String  | Custom subheading text               | `subhead="Help us improve"`                 |

| `success_message_low`  | String  | Success message for low ratings      | `success_message_low="Thanks for feedback"` |

| `success_message_high` | String  | Success message for high ratings     | `success_message_high="Please review us!"`  |

| `kiosk_mode`           | Boolean | Enable kiosk mode (QR code)          | `kiosk_mode="true"`                         |

| `qr_code_image`        | URL     | Custom QR code image for kiosk       | `qr_code_image="https://..."`               |



### 🎨 **Elementor Integration**






**🎯 Drag & Drop Widget with Visual Controls**






#### 📝 **Content Settings**



-   📰 Headlines & messages

-   🔗 URLs & redirects

-   🖥️ Kiosk mode options



#### 🎨 **Style Controls**



-   🎨 Colors & branding

-   📐 Spacing & layout

-   📝 Typography settings



#### ⚙️ **Behavior Options**



-   📞 Contact field settings

-   🔄 Redirect preferences

-   🛡️ Privacy controls



#### 👁️ **Real-time Preview**



-   ✅ Live editor preview

-   🎯 WCAG contrast checking

-   📱 Responsive design



## 🔒 Security & Privacy






**🛡️ Enterprise-Grade Security with Privacy-First Design**






### 🔐 **Security Features**



-   ✅ **Nonce Verification** - All submissions verified

-   🍯 **Honeypot Protection** - Invisible spam traps

-   ⏱️ **Time-trap Prevention** - Blocks bot submissions

-   🧹 **Input Sanitization** - All data cleaned & validated

-   👮 **Capability Checks** - Admin function protection

-   🌐 **URL Validation** - Google domain allowlist



### 🇪🇺 **GDPR Compliance**



-   🍪 **No Cookies Required** - Basic functionality cookie-free

-   📊 **Optional Logging** - Can be completely disabled

-   📋 **Clear Privacy Notices** - Transparent data usage

-   ☑️ **Consent Checkboxes** - User permission controls

-   🗂️ **Data Retention** - Admin-controlled storage

-   🔒 **Privacy-First** - Minimal data collection






### 🏆 **Compliance Standards**



[![GDPR](https://img.shields.io/badge/GDPR-Compliant-green.svg)](https://gdpr.eu/)

[![WCAG 2.1 AA](https://img.shields.io/badge/WCAG%202.1-AA%20Compliant-brightgreen.svg)](https://www.w3.org/WAI/WCAG21/quickref/)

[![WordPress Security](https://img.shields.io/badge/WordPress-Security%20Best%20Practices-blue.svg)](https://wordpress.org/about/security/)






## 🎨 Customization Options






**🎯 Make it uniquely yours with extensive customization options**






### 🎨 **Visual Styling**



-   🌈 **Colors** - Brand, star, button colors

-   📝 **Typography** - Inherit theme or customize

-   📐 **Spacing** - Adjustable spacing scale

-   🎭 **CSS Variables** - Advanced customization



### 💬 **Content & Text**



-   📰 **Headlines** - Custom main & sub headings

-   💬 **Messages** - Success & error messages

-   🏷️ **Labels** - Form field labels

-   🌍 **Translation** - Full i18n support



### ⚙️ **Behavior Settings**



-   📞 **Contact Fields** - Required/optional

-   ☑️ **Consent Options** - GDPR compliance

-   🔄 **Redirect Settings** - Target & timing

-   🖥️ **Kiosk Mode** - Tablet-friendly options



## 👩‍💻 Developer Features






**🔧 Built for developers with extensible architecture**






### 🪝 **WordPress Hooks**



🔽 Action Hooks



```php

// Before email is sent

do_action('qfr_before_email_send', $email_data, $submission);



// After submission is processed

do_action('qfr_submission_processed', $submission_id, $rating, $feedback);

```



🔽 Filter Hooks



```php

// Customize email subject

apply_filters('qfr_email_subject', $subject, $rating, $feedback);



// Modify redirect URL

apply_filters('qfr_redirect_url', $url, $rating);



// Customize widget configuration

apply_filters('qfr_widget_config', $config, $widget_id);

```



### 📊 **JavaScript Events**



```javascript

// Listen for rating changes

document.addEventListener("qfr:ratingChanged", function (e) {

	console.log("Rating:", e.detail.rating);

});



// Low rating submitted

document.addEventListener("qfr:lowRatingSubmitted", function (e) {

	// Custom analytics tracking

});



// High rating submitted

document.addEventListener("qfr:highRatingSubmitted", function (e) {

	// Custom success actions

});

```



### 🌐 **REST API Endpoint**



```bash

# Custom integrations

POST /wp-json/qfr/v1/submit-feedback

```



## 🚀 Installation



### 📦 **Quick Setup**



🔽 Click to expand installation steps



1. **📁 Upload Plugin**



    ```

    Upload files to: /wp-content/plugins/quick-feedback-reviews/

    ```



2. **⚡ Activate Plugin**



    - Go to WordPress Admin → Plugins

    - Find "ReviewFlow.me - Quick Feedback Reviews"

    - Click "Activate"



3. **⚙️ Configure Settings**



    - Navigate to **Settings → Quick Feedback**

    - Add your Google Business Profile URL

    - Customize colors, text, and behavior



4. **🎯 Add to Pages**

    - Use shortcode: `[quick_feedback]`

    - Or add Elementor widget to your pages



### 🔗 **Getting Your Google Business Profile URL**



🔽 Step-by-step guide



1. 🌐 Go to your [Google Business Profile dashboard](https://business.google.com/)

2. 📝 Click on **"Get more reviews"**

3. 📋 Copy the provided URL (starts with `https://search.google.com/` or `https://g.page/`)

4. 📌 Paste it in the plugin settings



**✅ Supported URL formats:**



-   `https://search.google.com/local/writereview?placeid=...`

-   `https://g.page/your-business/review`

-   `https://maps.app.goo.gl/...`



## ❓ Frequently Asked Questions






**💡 Quick answers to common questions**






🔗 How do I get my Google Business Profile review URL?



1. Go to your [Google Business Profile dashboard](https://business.google.com/)

2. Look for the **"Get more reviews"** option

3. Copy the provided direct URL

4. Paste it in the plugin settings



**✅ Accepted URL formats:**



-   `https://search.google.com/local/writereview?placeid=...`

-   `https://g.page/your-business/review`

-   `https://maps.app.goo.gl/...`



🎨 Can I customize the appearance to match my theme?



**Absolutely!** The plugin is designed to:



-   🎨 Inherit your theme's typography and colors by default

-   ⚙️ Allow customization through settings page

-   🎯 Provide Elementor widget controls for visual editing

-   🔧 Support CSS variables for advanced customization



♿ Is the plugin accessible for users with disabilities?



**Yes!** Built with WCAG 2.1 AA compliance:



-   ⌨️ **Keyboard Navigation** - Full keyboard support for star ratings

-   📢 **Screen Reader Support** - Proper announcements and labels

-   🏷️ **ARIA Labels** - Proper roles and descriptions

-   🎯 **Focus Management** - Clear focus indicators

-   🌓 **High Contrast** - Support for high contrast modes



🔒 Does the plugin store customer data?



**Privacy-first approach:**



-   📧 By default: Only sends email notifications

-   💾 Optional: Enable submission logging in settings

-   🇪🇺 GDPR-compliant with proper consent management

-   🍪 No cookies required for basic functionality



🎨 Can I use this plugin without Elementor?



**Yes!** The plugin works perfectly with:



-   📝 **Shortcode** - `[quick_feedback]` works anywhere

-   📦 **Block Editor** - Compatible with Gutenberg

-   🎨 **Elementor** - Enhanced visual controls (optional)



🛡️ What spam protection is included?



**Multiple layers of protection:**



-   🍯 **Honeypot Fields** - Invisible to humans, catch bots

-   ⏱️ **Time-trap Protection** - Prevents too-fast submissions

-   🔐 **Nonce Verification** - WordPress security tokens

-   🧹 **Input Validation** - All data sanitized and validated



🌍 Can I translate the plugin?



**Fully internationalized:**



-   🌐 All text strings use WordPress translation functions

-   📝 Ready for translation with standard WordPress tools

-   🗂️ `.pot` file included in `/languages/` directory



🔄 The 4-5 star redirect isn't working. What should I check?



**Troubleshooting steps:**



1. ✅ Valid Google Business Profile URL in Settings → Quick Feedback

2. 🔗 URL should start with approved domains (see above)

3. 🔍 Check browser developer console (F12) for JavaScript errors

4. 🐛 Enable Debug Mode in plugin settings

5. 💻 Local testing (.local domain) should still work - check console



🍪 I'm getting a "Cookie check failed" error when submitting feedback



**Usually a nonce/security token issue:**



1. 🔄 Refresh the page and try again

2. 🧹 Clear your browser cache

3. 🗂️ Clear caching plugin cache if using one

4. 🛡️ Check for interfering security plugins

5. 🐛 Enable Debug Mode for detailed error information



🔧 How do I troubleshoot issues?



**Debug process:**



1. ⚙️ Go to **Settings → Quick Feedback** and enable **"Debug Mode"**

2. 🔄 Try to reproduce the issue

3. 📋 Check WordPress debug log (`/wp-content/debug.log`)

4. 🔍 Look for entries starting with **"[QFR]"**

5. 🌐 Check browser developer console (F12) for JavaScript errors



## 📸 Screenshots






**🎯 See the plugin in action**






| Screenshot                | Description                                                     |

| ------------------------- | --------------------------------------------------------------- |

| 🌟 **Rating Interface**   | Clean, accessible 5-star rating selector with smooth animations |

| 📝 **Feedback Form**      | Low rating feedback form with optional contact fields           |

| ⚙️ **Settings Page**      | Comprehensive plugin configuration with live preview            |

| 🎨 **Elementor Widget**   | Visual controls in Elementor editor with real-time preview      |

| 📧 **Email Notification** | Rich HTML email template for low rating feedback                |

| ✅ **Success Messages**   | Customizable success messages for different rating levels       |

| 🖥️ **Kiosk Mode**         | Tablet-friendly interface with QR code display                  |

| ♿ **Accessibility**      | WCAG contrast checker and keyboard navigation demo              |






_📷 Screenshots coming soon! Plugin is actively maintained and updated._






## 📝 Changelog






**🚀 Latest updates and improvements**






### 🆕 **Version 1.0.5** - _Kiosk Mode Release_



🔽 View all changes



#### ✨ **NEW: Kiosk Mode**



-   🖥️ Perfect for tablets and shared devices in physical locations

-   📱 Shows QR code instead of redirecting for 4-5 star ratings

-   ⚙️ Global kiosk mode setting with QR code image upload

-   🎨 Per-widget kiosk mode override in Elementor

-   📝 Shortcode support: `[quick_feedback kiosk_mode="true"]`

-   🔒 Enhanced security for shared device environments

-   🏪 Ideal for restaurants, shops, waiting areas, service counters

-   📲 Customers scan QR code with personal phone to leave reviews

-   📱 Responsive QR code display with clear instructions



---



### 🎨 **Version 1.0.4** - _Accessibility Enhancement_



🔽 View all changes



#### ♿ **NEW: Real-time Accessibility Checker**



-   🎯 Live WCAG contrast checking in Elementor editor

-   🚦 Visual indicators: AAA (green), AA (yellow), FAIL (red)

-   📊 Coverage of all 13 color controls across sections

-   🔄 Real-time updates when navigating Elementor sections

-   🐛 Debug console respects plugin's debug mode setting

-   🏆 Enhanced WCAG 2.1 AA compliance features

-   🧮 Improved color contrast calculations with gamma correction

-   💡 Tooltips with detailed WCAG guidelines and ratios



---



### 📧 **Version 1.0.2** - _Email Testing_



🔽 View all changes



#### 🧪 **Email Configuration Testing**



-   ✅ "Send Test Email" button in Settings → Quick Feedback

-   ⚡ Real-time feedback on email success/failure

-   🔍 Detailed error reporting for troubleshooting

-   📊 Improved email delivery diagnostics



---



### 🎨 **Version 1.0.1** - _Elementor Enhancements_



🔽 View all changes



#### 🆕 **New Elementor Controls**



-   📝 **Typography Section:**

    -   Headline Typography

    -   Subhead Typography

    -   Button Typography

    -   **NEW:** Form Label Typography

    -   **NEW:** Form Input Typography

-   🎨 **Style Section:**

    -   Brand Color

    -   Active Star Color

    -   Inactive Star Color

    -   Button Border Radius

    -   Spacing

-   🌈 **NEW: Form Colors Section:**

    -   Label Color

    -   Input Text Color

    -   Input Background Color

    -   Input Border Color

    -   Input Focus Border Color

    -   Placeholder Color



---



### 🎉 **Version 1.0.0** - _Initial Release_



🔽 View all features



#### 🚀 **Core Features**



-   ⭐ 5-star rating system with smart routing

-   📝 Shortcode and Elementor widget support

-   📧 Email notifications for low ratings

-   🔗 Google Business Profile integration

-   ♿ Accessibility features (WCAG 2.1 AA)

-   🛡️ Anti-spam protection

-   🔒 Privacy-focused design

-   🎨 Comprehensive customization options

-   👨‍💻 Developer hooks and filters

-   🌍 Internationalization support



---



## 🛠️ Support






**💬 Get help when you need it**






### 🐛 **Bug Reports & Issues**



-   🔗 [GitHub Issues](https://github.com/vip3rousmango/quick-feedback-reviews/issues)

-   📝 Detailed bug reporting template

-   🚀 Fast response times



### 💡 **Feature Requests**



-   🌟 [GitHub Discussions](https://github.com/vip3rousmango/quick-feedback-reviews/discussions)

-   🗳️ Community voting on features

-   🛣️ Public roadmap



### 📖 **Documentation**



-   📚 Comprehensive guides

-   🎥 Video tutorials (coming soon)

-   💻 Code examples



### 🤝 **Community**



-   💬 WordPress.org support forum

-   🐦 Follow updates on social media

-   📧 Direct developer contact






[![GitHub Issues](https://img.shields.io/github/issues/vip3rousmango/quick-feedback-reviews.svg)](https://github.com/vip3rousmango/quick-feedback-reviews/issues)

[![GitHub Stars](https://img.shields.io/github/stars/vip3rousmango/quick-feedback-reviews.svg)](https://github.com/vip3rousmango/quick-feedback-reviews/stargazers)






---



## 🔒 Privacy Policy






**🛡️ Transparent data handling practices**






### 📊 **Data Collection**



This plugin may collect and process the following data **only when feedback is submitted**:



| Data Type                            | Purpose                 | Required    |

| ------------------------------------ | ----------------------- | ----------- |

| ⭐ Rating value (1-5 stars)          | Feedback processing     | ✅ Yes      |

| 💬 Feedback message                  | Low rating responses    | ❌ Optional |

| 👤 Contact info (name, email, phone) | Follow-up communication | ❌ Optional |

| 🌐 Page URL                          | Context tracking        | ✅ Yes      |

| ⏰ Timestamp                         | Submission tracking     | ✅ Yes      |

| 🔍 User agent & IP                   | Spam prevention         | ✅ Yes      |



### 🔐 **Data Usage**



-   📧 **Contact information** is only used for follow-up when consent is given

-   🗂️ **Data logging** can be completely disabled in plugin settings

-   🚫 **No tracking** of users who don't submit feedback

-   🍪 **No cookies** required for basic functionality



---



## 🏆 Credits






**💝 Built with love for the WordPress community**



---



### 👨‍💻 **Developer**



**[Al Romano](https://virtuallycreative.ca)** - _Lead Developer_



[![Website](https://img.shields.io/badge/Website-virtuallycreative.ca-blue.svg)](https://virtuallycreative.ca)

[![GitHub](https://img.shields.io/badge/GitHub-vip3rousmango-black.svg)](https://github.com/vip3rousmango)



---



### 🛠️ **Built With**



-   🎯 **WordPress Coding Standards** - Following best practices

-   🔒 **Security First** - Comprehensive security measures

-   ♿ **Accessibility** - WCAG 2.1 AA compliance

-   🚀 **Performance** - Optimized for speed

-   🌍 **Internationalization** - Translation-ready



---



### 💖 **Special Thanks**



-   🌟 WordPress community for feedback and support

-   🎨 Elementor team for excellent widget API

-   ♿ Web accessibility advocates for guidance

-   🧪 Beta testers and early adopters



---



**⭐ If you find this plugin helpful, please consider leaving a review!**