Skip to content

VirtuallyCreative/qf-gbp-wp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

24 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒŸ ReviewFlow.me - Quick Feedback Reviews

Transform customer feedback into Google Business Profile reviews with intelligent routing

WordPress Plugin Version PHP Version License Elementor Compatible WCAG 2.1 AA


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 โ€ข ๐Ÿ“– Documentation โ€ข ๐ŸŽจ Customization โ€ข ๐Ÿ› ๏ธ Support


๐Ÿ“‹ Table of Contents


โœจ 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

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"]
Loading

๐Ÿ”„ 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

[quick_feedback]

๐ŸŽจ With Custom Styling

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

๐Ÿ–ฅ๏ธ Kiosk Mode (Perfect for Tablets)

[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 WCAG 2.1 AA WordPress 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
// 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
// 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

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

# 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
  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
  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
  • ๐Ÿ“ Detailed bug reporting template
  • ๐Ÿš€ Fast response times

๐Ÿ’ก Feature Requests

  • ๐ŸŒŸ GitHub 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 GitHub Stars


๐Ÿ”’ 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 - Lead Developer

Website GitHub


๐Ÿ› ๏ธ 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!

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors