Merge pull request #221 from WebberZone/develop

Develop

Author: ajaydsouza

.github/workflows/cs.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           tools: cs2pr
           coverage: none
 

.github/workflows/unit-tests.yml

@@ -1,8 +1,6 @@
 name: Unit Tests
 
 on:
-  # Run on all pushes and on all pull requests.
-  # Prevent the build from running when there are only irrelevant changes.
   push:
     paths-ignore:
       - '**.md'
@@ -11,7 +9,6 @@ on:
     paths-ignore:
       - '**.md'
       - '**.txt'
-  # Allow manually triggering the workflow.
   workflow_dispatch:
 
 jobs:
@@ -21,100 +18,72 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Notes regarding supported versions in WP:
-        # Testing against stable PHP versions with WordPress 6.6+
         php: ['7.4', '8.1', '8.2', '8.3']
         wp: ['latest']
-        experimental: [false]
+        mysql: ['8.0']
 
         include:
-          # Test against older supported WordPress version
           - php: '8.3'
             wp: '6.6'
-          # Experimental builds for upcoming PHP versions
-          - php: '8.5'
+            mysql: '8.0'
+          - php: '8.4'
             wp: 'latest'
+            mysql: '8.0'
             experimental: true
-          - php: '8.4'
+          - php: '8.5'
             wp: 'latest'
+            mysql: '8.0'
             experimental: true
 
-    name: "PHP ${{ matrix.php }} - WP ${{ matrix.wp }}"
-
+    name: "PHP ${{ matrix.php }} - WP ${{ matrix.wp }} - MySQL ${{ matrix.mysql }}"
     continue-on-error: ${{ matrix.experimental == true }}
 
-    services:
-      mysql:
-        # WP 5.4 is the first WP version which largely supports MySQL 8.0.
-        # See: https://core.trac.wordpress.org/ticket/49344
-        # During the setting up of these tests, it became clear that MySQL 8.0
-        # in combination with PHP < 7.4 is not properly/sufficiently supported
-        # within WP Core.
-        # See: https://core.trac.wordpress.org/ticket/52496
-        image: mysql:${{ ( matrix.wp == 5.3 && '5.6' ) || ( (matrix.wp < 5.4 || matrix.php < 7.4) && '5.7' ) || '8.0' }}
-        env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: false
-        ports:
-          - 3306:3306
-        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=10s --health-retries=10
-
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Setup MySQL
+        uses: ankane/setup-mysql@v1
+        with:
+          mysql-version: ${{ matrix.mysql }}
+
       - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: mysqli, mysql
+          extensions: mysqli
           coverage: none
 
-      # On WP 5.2, PHPUnit 5.x, 6.x and 7.x are supported.
-      # On PHP >= 8.0, PHPUnit 7.5+ is needed, no matter what.
-      - name: Determine supported PHPUnit version
-        id: set_phpunit
+      - name: Set PHPUnit version
         run: |
           if [[ "${{ matrix.php }}" > "8.0" ]]; then
             echo "PHPUNIT=9.*" >> $GITHUB_ENV
           else
             echo "PHPUNIT=5.7.*||6.*||7.5.*||8.5.*" >> $GITHUB_ENV
           fi
 
-      - name: 'Composer: set up PHPUnit'
-        env:
-          PHPUNIT: ${{ env.PHPUNIT }}
-        run: composer require --no-update phpunit/phpunit:"${{ env.PHPUNIT }}"
+      - name: Set up PHPUnit
+        run: composer require --no-update phpunit/phpunit:"$PHPUNIT"
 
-      # Install dependencies and handle caching in one go.
-      # @link https://github.com/marketplace/actions/install-composer-dependencies
-      - name: Install Composer dependencies for PHP < 8.0
+      - name: Install dependencies for PHP < 8.0
         if: ${{ matrix.php < 8.0 }}
-        uses: "ramsey/composer-install@v2"
+        uses: ramsey/composer-install@v3
 
-      # For the PHP 8.0 and above, we need to install with ignore platform reqs as not all dependencies allow it yet.
-      - name: Install Composer dependencies for PHP >= 8.0
+      - name: Install dependencies for PHP >= 8.0
         if: ${{ matrix.php >= 8.0 }}
-        uses: "ramsey/composer-install@v2"
+        uses: ramsey/composer-install@v3
         with:
           composer-options: --ignore-platform-reqs
 
-      - name: Install Subversion
-        run: sudo apt-get install subversion
-
-      - name: Set up WordPress
-        run: phpunit/install.sh wordpress_test root '' 127.0.0.1:3306 ${{ matrix.wp }}
-
-      - name: Tool versions
+      - name: Set up WordPress test environment
         run: |
-          php --version
-          composer --version
-          ./vendor/bin/phpunit --version
-          which ./vendor/bin/phpunit
+          sudo apt-get install -y subversion
+          bash phpunit/install.sh wordpress_test root '' 127.0.0.1:3306 ${{ matrix.wp }}
 
-      - name: Run the unit tests - single site
-        run: ./vendor/bin/phpunit
+      - name: Run tests (single site)
+        run: vendor/bin/phpunit
 
-      - name: Run the unit tests - multisite
+      - name: Run tests (multisite)
         env:
           WP_MULTISITE: 1
-        run: ./vendor/bin/phpunit
+        run: vendor/bin/phpunit

.github/workflows/zipitup.yml

@@ -23,13 +23,16 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+
       - name: Build project
         run: |
           mkdir build
+
       - name: Create artifact
         uses: montudor/action-zip@v1
         with:
-          args: zip -X -r build/${{ github.event.repository.name }}.zip . -x *.git* node_modules/\* .* "*/\.*" CODE_OF_CONDUCT.md CONTRIBUTING.md ISSUE_TEMPLATE.md PULL_REQUEST_TEMPLATE.md *.dist *.yml *.neon composer.* package.json dev-helpers** build** wporg-assets** phpunit**
+          args: zip -X -r build/${{ github.event.repository.name }}.zip . -x *.git* node_modules/\* .* "*/\.*" "*/.git*" "*/.DS_Store" CODE_OF_CONDUCT.md CONTRIBUTING.md ISSUE_TEMPLATE.md PULL_REQUEST_TEMPLATE.md *.dist *.yml *.neon composer.* package.json package-lock.json dev-helpers** build** wporg-assets** docs/\* phpunit** phpstan-bootstrap.php
+
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -1,3 +1,11 @@
-node_modules
+# Ignore entire vendor except Freemius
+/vendor/*
+!/vendor/freemius/
+
+# Tooling
+/phpcompat-tools/
+/node_modules/
+
+# Lock files
 package-lock.json
 composer.lock

README.md

@@ -8,9 +8,9 @@
 [![Required PHP](https://img.shields.io/wordpress/plugin/required-php/contextual-related-posts?style=flat-square)](https://wordpress.org/plugins/contextual-related-posts/)
 [![Active installs](https://img.shields.io/wordpress/plugin/installs/contextual-related-posts?style=flat-square)](https://wordpress.org/plugins/contextual-related-posts/)
 
-__Requires:__ 6.3
+__Requires:__ 6.6
 
-__Tested up to:__ 6.8
+__Tested up to:__ 6.9
 
 __Requires PHP:__ 7.4
 
@@ -26,7 +26,7 @@ Keep visitors on your site longer with intelligent, fast-loading contextually re
 
 ### Key features
 
-* __Activate and Forget__: Activate the plugin. Contextual Related Posts automatically displays related posts on your site and feed after the content. There is no need to edit any template files.
+* __Activate and Forget__: Activate the plugin. Contextual Related Posts automatically displays related posts on your site and in your feed after the content. There is no need to edit any template files.
 * __Custom Control with Manual Install__: Want placement control? You have multiple options available:
   * __Gutenberg / Block Editor support__: You can easily add a "Related Posts [CRP]" block to any post or page with its options and settings.
   * __Widgets__: Add related posts to any widgetized theme area, such as the sidebar or footer. You can configure the widget options to suit your needs.
@@ -50,6 +50,14 @@ Additional features include:
 * __Customizable output__: Display post excerpts in the related posts list. Customize the HTML tags and attributes used to display the output.
 * __Extendable code__: Many filters and actions allow developers to easily add features, modify outputs, or integrate with other plugins.
 
+### MySQL FULLTEXT indices
+
+On activation, the plugin creates three MySQL FULLTEXT indices (or indexes), which are leveraged to find the related posts. [Learn more about how the algorithm works](https://webberzone.com/support/knowledgebase/contextual-related-posts-algorithm/).
+
+If you're running a multisite installation, an index is created for each blog upon activation. These indices occupy space in your MySQL database but are essential for running the plugin.
+
+Two options on the settings page allow you to remove these indices when deactivating or deleting the plugin. The latter is true by default.
+
 ### 💼 Features Exclusive to CRP Pro
 
 [CRP Pro](https://webberzone.com/plugins/contextual-related-posts/pro/) supercharges your related posts with advanced customization, better performance, and powerful content strategy tools.
@@ -58,12 +66,36 @@ Additional features include:
 
 * [Efficient Content Storage and Indexing](https://webberzone.com/support/knowledgebase/efficient-content-storage-and-indexing/): Speed up your site with optimized custom tables and efficient database indices for lightning-fast queries.
 * [Cache Setting](https://webberzone.com/support/knowledgebase/caching-in-contextual-related-posts/): Fine-tune your performance with configurable cache times from 1 hour to 1 year.
+* [Server Load Threshold](https://webberzone.com/support/knowledgebase/server-load-threshold-setting-in-contextual-related-posts-pro/): Prevent CRP from running queries when the database is under heavy load.
+* [Bot Protection](https://webberzone.com/support/knowledgebase/contextual-related-posts-bot-protection/): Skip CRP processing for known bots and crawlers using an extensible signature list, saving server resources.
 
 #### 🎯 Smarter Content Matching
 
 * [Advanced Algorithm](https://webberzone.com/support/knowledgebase/contextual-related-posts-algorithm/): Control exactly how relevant content is found by adjusting weights for title, content, and excerpt.
 * [Taxonomy Weight System](https://webberzone.com/support/knowledgebase/contextual-related-posts-algorithm/#weighting-categories-tags-and-taxonomies): Refine your matches with precise taxonomy weighting for perfect content relationships.
 
+#### 🛒 WooCommerce Integration
+
+* __Related Products for WooCommerce__: Seamlessly integrate with WooCommerce to show related products.
+* __Product Matching & Filtering__: Index SKUs and attributes, filter by stock status, and use category-based recommendations with native WooCommerce styling.
+* __Display Customization__: Toggle prices, ratings, and choose to replace or complement WooCommerce's related products.
+
+[📖 WooCommerce Related Products Documentation](https://webberzone.com/support/knowledgebase/woocommerce-related-products/)
+
+### WP-CLI Support
+
+Contextual Related Posts Pro includes comprehensive WP-CLI commands for advanced management and automation. Perfect for developers, agencies, and site administrators who need powerful command-line tools.
+
+__Key WP-CLI Features:__
+
+* __Database Management__: Migrate post meta, check index status, and manage database operations
+* __Cache Control__: Clear, warm, enable/disable cache with multisite support
+* __Custom Table Operations__: Sync content and manage FULLTEXT indexes for optimal performance
+* __Content Processing__: Reprocess posts and manage related content in bulk
+* __Multisite Ready__: All commands support `--network` flag for multisite installations
+
+[📖 Complete CLI Documentation](https://webberzone.com/support/knowledgebase/contextual-related-posts-wp-cli/)
+
 #### 🎨 Advanced Design & Display Options
 
 * [Block Editor Integration](https://webberzone.com/support/knowledgebase/contextual-related-posts-blocks/): Create beautiful layouts with the Query Loop Block and ready-to-use block patterns including Grid, Image with Title, and more.
@@ -75,14 +107,6 @@ Additional features include:
 * [Cornerstone Posts](https://webberzone.com/support/knowledgebase/cornerstone-posts-in-contextual-related-posts/): Guide visitors to your most important content by featuring key articles in your related posts lists.
 * [Additional Metabox Settings](https://webberzone.com/support/knowledgebase/contextual-related-posts-metabox/): Control related content at the individual post level for perfect content relationships.
 
-### MySQL FULLTEXT indices
-
-On activation, the plugin creates three MySQL FULLTEXT indices (or indexes), which are leveraged to find the related posts. [Learn more about how the algorithm works](https://webberzone.com/support/knowledgebase/contextual-related-posts-algorithm/).
-
-If you're running a multisite installation, an index is created for each blog upon activation. These indices occupy space in your MySQL database but are essential for running the plugin.
-
-Two options on the settings page allow you to remove these indices when deactivating or deleting the plugin. The latter is true by default.
-
 ### GDPR
 
 Contextual Related Posts doesn’t collect personal data or send information to external services — making it GDPR-friendly by default.
@@ -95,6 +119,13 @@ Love Contextual Related Posts? Help keep it alive!
 
 You can [donate](https://wzn.io/donate-crp) or upgrade to [CRP Pro](https://webberzone.com/plugins/contextual-related-posts/pro/) — both help support development and support.
 
+### Contribute
+
+Contextual Related Posts is also available on [Github](https://github.com/WebberZone/contextual-related-posts).
+So, if you've got some cool feature you'd like to implement into the plugin or a bug you've been able to fix, consider forking the project and sending me a pull request.
+
+Bug reports are [welcomed on Github](https://github.com/WebberZone/contextual-related-posts/issues). Please note Github is _not_ a support forum, and issues that aren't suitably qualified as bugs will be closed.
+
 ### Translations
 
 Contextual Related Posts is available for [translation directly on WordPress.org](https://translate.wordpress.org/projects/wp-plugins/contextual-related-posts). Check out the official [Translator Handbook](https://make.wordpress.org/polyglots/handbook/rosetta/theme-plugin-directories/) to contribute.