Merge pull request #86 from n49/slider_v1.1.15

nilay49 · web-flow · commit 985ea60fcfe1 · 2026-02-06T12:36:11.000-05:00
Slider v1.1.15
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -1,47 +1,60 @@
 # CLAUDE.md
 
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
 Be extremely concise in all interactions.
 
 ## Overview
 
-WordPress plugin for embedding OPIO review feeds and sliders on client websites. Displays reviews from op.io aggregation service.
+WordPress plugin ("Widget for OPIO Reviews") for embedding OPIO review feeds and sliders on client websites. Displays reviews from the op.io aggregation service. Current version: **1.1.15**.
+
+## Build & Development
+
+**No build system exists.** No package.json, composer.json, webpack, gulp, or linting configs. Assets (JS/CSS) are edited directly.
+
+**Testing:** No automated tests. Manual testing only via WordPress admin preview.
+
+**Deployment:** GitHub Actions (`.github/workflows/main.yml`) deploys to WordPress.org SVN on git tag push using `10up/action-wordpress-plugin-deploy`. Slug: `widget-for-opio-reviews`.
+
+**Version bump checklist** — update all three locations when releasing:
+1. `opio.php` — `Version:` in plugin header comment
+2. `opio.php` — `OPIO_PLUGIN_VERSION` constant
+3. `readme.txt` — `Stable tag:`
 
-**Plugin Name:** Widget for OPIO Reviews
-**Version:** 1.1.11
+**Debug mode:** Set WP option `opio_debug_mode` to `'1'` to load unminified assets from `assets/src/` instead of `assets/`.
 
 ## Architecture
 
+### Initialization Flow
+
+```
+opio.php → autoloader.php (PSR-4 for WP_Opio_Reviews\Includes)
+  → Plugin::register() on plugins_loaded
+    → Assets, Post_Types (opio_feed, opio_slider CPTs)
+    → Feed_Deserializer → Feed_Page, Builder_Page, Feed_Shortcode
+    → Slider_Deserializer → Slider_Feed_Page, Review_Slider, Slider_Shortcode
+    → Admin services (only when is_admin())
+```
+
 ### Two Rendering Modes
 
-1. **Feed Shortcode** (`[opio_feed id='X']`)
-   - Fetches pre-rendered HTML from `feed.op.io`
-   - No local review rendering - just displays server HTML
-   - File: `includes/class-feed-shortcode.php`
+1. **Feed** (`[opio_feed id='X']`) — Fetches pre-rendered HTML from `feed.op.io`, injects schema into `<head>` via output buffering. Handler: `class-feed-shortcode.php`.
+
+2. **Slider** (`[opio_slider id='X']`) — Fetches JSON from `op.io/api/entities/reviews-slider`, renders locally via PHP templates. Three layout variants (horizontal, horizontal-carousel, vertical), each with public + admin-preview templates in `includes/`.
 
-2. **Slider Widgets** (review carousels)
-   - Fetches JSON from `op.io/api/entities/reviews-slider`
-   - Renders reviews locally in PHP templates
-   - 6 template files (3 public + 3 admin previews):
-     - `reviews-slider-horizontal-template.php`
-     - `reviews-slider-horizontal-carousel-template.php`
-     - `reviews-slider-vertical-template.php`
-     - `admin-reviews-slider-*` (admin preview versions)
+### Data Storage
 
-### Key Files
+Widget settings are stored as JSON in `post_content` of custom post types (`opio_feed`, `opio_slider`). Serializers validate and save form data; deserializers retrieve and process it (RGBA→hex conversion, `wp_kses` allowlist filtering).
 
-- `opio.php` - Plugin entry point
-- `includes/class-plugin.php` - Plugin initialization
-- `includes/class-feed-shortcode.php` - Feed shortcode handler
-- `includes/class-review-slider.php` - Slider widget handler
-- `includes/class-opio-handler.php` - API communication
-- `assets/js/opio-main.js` - Feed JS functions
-- `assets/js/opio-slider-main.js` - Slider JS functions (lightbox, slick carousel)
+### Asset Loading
 
-### External Dependencies
+`class-assets.php` registers all CSS/JS. Debug mode toggle (`opio_debug_mode` option) switches between `assets/` and `assets/src/` paths. Bundled vendor libs: Slick Carousel, Moment.js, jQuery fallback (if WP jQuery unavailable).
 
-- Slick Carousel (bundled)
-- Moment.js (bundled)
-- jQuery (WordPress)
+**Known issue:** `assets/css/public-main.css` and `public-main-rtl.css` are 0 bytes — styles only work in debug mode loading from `assets/src/css/`.
+
+### REST API
+
+Single endpoint: `GET /opioreviews/v1/get_businesses?orgID={id}` — proxies to `op.io/api/organizations/landingpageUsername`.
 
 ## API Endpoints
 
@@ -52,35 +65,14 @@ WordPress plugin for embedding OPIO review feeds and sliders on client websites.
 
 ## Media Handling
 
-Current support:
-- `rev.images[]` - array of `{imageId}` objects
-- `rev.videos[]` - array of `{videoId}` objects
-
-NOT yet supported:
-- `rev.embeds[]` - social media embeds (YouTube, etc.)
-
-### JS Functions
-
-In `opio-main.js` (feeds):
-- `displayLargeImage(imageId, revId)` - shows large image (has bugs: fixed height, cover mode)
-- `addReview()` - builds review HTML dynamically
-
-In `opio-slider-main.js` (sliders):
-- `displayLargeImage(imageId, revId)` - different implementation for lightbox
-- `openPhotoLightbox(reviewData)` - opens review detail modal
-- `hideLargeImage(revId)` - closes large image view
-
-## Shortcodes
-
-```php
-[opio_feed id='123']     // Review feed
-[opio_slider id='456']   // Review slider
-```
-
-## Testing
+Supported: `rev.images[]` (imageId objects), `rev.videos[]` (videoId objects).
+Not yet supported: `rev.embeds[]` (social media embeds).
 
-No automated tests. Manual testing via WordPress admin preview.
+JS lightbox/gallery functions exist in both `opio-main.js` (feeds) and `opio-slider-main.js` (sliders) with separate implementations.
 
-## Deployment
+## Conventions
 
-Plugin distributed via WordPress plugin directory or direct ZIP upload.
+- **Namespace:** `WP_Opio_Reviews\Includes` with PSR-4 autoloading
+- **File naming:** `class-{name}.php` maps to `Class_Name`
+- **Methods/functions:** `snake_case`
+- **Security:** `wp_verify_nonce()` for forms, `sanitize_text_field()` for input, `wp_kses()` with allowlist for output, `esc_url()`/`esc_html()` for escaping
diff --git a/includes/class-feed-optimized-shortcode.php b/includes/class-feed-optimized-shortcode.php
@@ -0,0 +1,114 @@
+<?php
+
+namespace WP_Opio_Reviews\Includes;
+
+/**
+ * Optimized feed shortcode [opio_feed_optimized id='X']
+ *
+ * Completely isolated from Feed_Shortcode / Opio_Handler.
+ * Hits the -optimized routes on feed.op.io which return identical output
+ * but with smaller HTML (external JS, consolidated CSS, minimal JSON embeds).
+ *
+ * Only the "all" review_option has optimized routes:
+ *   - allReviewFeed-optimized?entId={id}
+ *   - multiReviewFeed/allReviews-optimized?orgId={id}
+ *
+ * The "opio" review_option falls back to standard routes (no optimized variant).
+ */
+class Feed_Optimized_Shortcode {
+
+    private $feed_deserializer;
+
+    public function __construct(Feed_Deserializer $feed_deserializer) {
+        $this->feed_deserializer = $feed_deserializer;
+    }
+
+    public function register() {
+        add_shortcode('opio_feed_optimized', array($this, 'init'));
+    }
+
+    /**
+     * Build the feed.op.io URL for optimized routes.
+     */
+    private function build_feed_url($biz_id, $org_id, $review_option, $review_type) {
+        if ($review_option == 'opio') {
+            // No optimized variant for opio — use standard routes
+            if ($review_type == 'orgfeed') {
+                return "https://feed.op.io/multiReviewFeed?orgId=${org_id}&schema_enabled=true&schema_type=Local%20Business";
+            }
+            if ($review_type == 'single') {
+                return "https://feed.op.io/reviewFeed?entityid=${biz_id}";
+            }
+            return "https://feed.op.io/reviewFeed?entId=${biz_id}";
+        }
+
+        // "all" review_option — use optimized routes
+        if ($review_type == 'orgfeed') {
+            return "https://feed.op.io/multiReviewFeed/allReviews-optimized?orgId=${org_id}&schema_enabled=true&schema_type=Local%20Business";
+        }
+        return "https://feed.op.io/allReviewFeed-optimized?entId=${biz_id}";
+    }
+
+    /**
+     * Fetch HTML from feed.op.io.
+     */
+    private function fetch_feed($url) {
+        $response = wp_remote_get($url);
+        if (is_wp_error($response)) {
+            return null;
+        }
+        $body = wp_remote_retrieve_body($response);
+        if (empty($body)) {
+            return null;
+        }
+        return $body;
+    }
+
+    public function init($atts) {
+        if (get_option('opio_active') === '0') {
+            return '';
+        }
+
+        $feed = $this->feed_deserializer->get_feed($atts['id']);
+        if ($feed == null) {
+            return '';
+        }
+
+        $feed_object = json_decode($feed->post_content);
+        if (!$feed_object) {
+            return '';
+        }
+
+        $biz_id = isset($feed_object->biz_id) ? $feed_object->biz_id : '';
+        $org_id = isset($feed_object->org_id) ? $feed_object->org_id : '';
+        $review_type = isset($feed_object->review_type) ? $feed_object->review_type : '';
+        $review_option = isset($feed_object->review_option) ? $feed_object->review_option : '';
+
+        // Validate IDs
+        $valid = preg_match('/^[a-zA-Z0-9]{15,20}$/', $biz_id)
+              || preg_match('/^[a-zA-Z0-9]{15,20}$/', $org_id);
+        if (!$valid) {
+            return '';
+        }
+
+        $url = $this->build_feed_url($biz_id, $org_id, $review_option, $review_type);
+        $reviews = $this->fetch_feed($url);
+        if ($reviews === null) {
+            return '';
+        }
+
+        ob_start();
+
+        echo '<div data-nitro-exclude="all" data-nitro-ignore="true" data-nitro-no-optimize="true" data-nitro-preserve-ws="true">';
+
+        $entity_id = !empty($biz_id) ? $biz_id : $org_id;
+        if (!empty($entity_id)) {
+            echo '<script>window.opioEntityId = "' . esc_js($entity_id) . '";</script>';
+        }
+
+        echo $reviews;
+        echo '</div>';
+
+        return ob_get_clean();
+    }
+}
diff --git a/includes/class-plugin.php b/includes/class-plugin.php
@@ -100,6 +100,9 @@ public function register_services() {
         $feed_shortcode = new Feed_Shortcode($feed_deserializer);
         $feed_shortcode->register();
 
+        $feed_optimized_shortcode = new Feed_Optimized_Shortcode($feed_deserializer);
+        $feed_optimized_shortcode->register();
+
         $slider_shortcode = new Slider_Shortcode($slider_deserializer);
         $slider_shortcode->register();
 
diff --git a/opio.php b/opio.php
@@ -3,7 +3,7 @@
 Plugin Name: Widget for OPIO Reviews
 Plugin URI: 
 Description: Instantly add OPIO Reviews on your website to increase user confidence and SEO.
-Version: 1.1.14
+Version: 1.1.15
 Author: Dhiraj Timalsina <dhiraj@n49.com>
 Text Domain: widget-for-opio-reviews
 Domain Path: /languages
@@ -22,7 +22,7 @@
 
 require(ABSPATH . 'wp-includes/version.php');
 
-define('OPIO_PLUGIN_VERSION'   , '1.1.14');
+define('OPIO_PLUGIN_VERSION'   , '1.1.15');
 define('OPIO_PLUGIN_FILE'      , __FILE__);
 define('OPIO_PLUGIN_URL'       , plugins_url(basename(plugin_dir_path(__FILE__ )), basename(__FILE__)));
 define('OPIO_ASSETS_URL'       , OPIO_PLUGIN_URL . '/assets/');
diff --git a/readme.txt b/readme.txt
@@ -2,7 +2,7 @@
 Author: Dhiraj Timalsina
 Tags: Widget for OPIO Reviews, opio, reviews, rating, widget, google business, testimonials
 Tested up to: 6.4
-Stable tag: 1.1.14
+Stable tag: 1.1.15
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
