WordPress.org
Get WordPress

Plugin Directory

Changeset 3486189


Ignore:
Timestamp:
03/19/2026 07:35:18 AM (9 days ago)
Author:
wprashed
Message:

Here’s a WordPress.org–optimized version of your README. This is cleaner, keyword-focused, and aligned with how plugins rank and convert on wp.org:

---

## === CartFlush – Auto Clear WooCommerce Cart for Inactive Users ===

Contributors: wprashed
Tags: woocommerce cart cleanup, abandoned cart, cart timeout, woocommerce optimization, cart management
Requires at least: 5.8
Tested up to: 6.8
Requires PHP: 7.4
Stable tag: 2.0.0
License: GPLv2 or later
License URI: ​https://www.gnu.org/licenses/gpl-2.0.html(​https://www.gnu.org/licenses/gpl-2.0.html)

Automatically clear inactive WooCommerce carts with advanced timeout rules, exclusions, and import/export tools.

---

## == Description ==

CartFlush helps you automatically clear inactive WooCommerce carts, keeping your store clean, fast, and optimized.

Instead of relying on a basic timeout, CartFlush gives you full control over how cart expiration works. You can define different timeout rules based on user roles, product categories, and exclusions—making it flexible enough for real-world eCommerce scenarios.

Whether you want faster cart turnover, better session management, or cleaner abandoned cart handling, CartFlush gives you the tools to do it properly.

---

## 🚀 Why Use CartFlush?

  • Prevent stale and abandoned carts from piling up
  • Improve WooCommerce session performance
  • Apply smarter rules based on users and products
  • Save time with import/export configuration tools
  • Maintain clean and optimized cart behavior

---

## == Key Features ==

### ⏱ Default Cart Timeout

Set a global inactivity timeout (in minutes). If no other rules apply, this value determines when a cart is cleared.

---

### 👤 Role-Based Timeout Rules

Define custom cart expiration times based on user roles.

Examples:

  • Customers → 30 minutes
  • Subscribers → 60 minutes
  • Wholesale users → 120 minutes

Perfect for stores with different user types and behaviors.

---

### 🛍 Category-Based Timeout Rules

Set cart timeout rules based on product categories.

Use cases:

  • Flash sale items → shorter timeout
  • Subscription products → shorter timeout
  • High-value products → longer timeout

CartFlush checks all items in the cart and applies the most relevant rule.

---

### ⚡ Smart Timeout Logic

When multiple rules apply, CartFlush automatically selects the shortest timeout.

This ensures:

  • Predictable behavior
  • Better control over urgency
  • No rule conflicts

---

### 🚫 Product Exclusions

Exclude specific products from cart clearing.

If a cart contains an excluded product:
→ The cart will NOT be cleared.

---

### 📂 Category Exclusions

Exclude entire categories from auto-clear.

If any product in the cart belongs to an excluded category:
→ Cart clearing is skipped.

---

### 📥 CSV Import for Rules

Bulk import rules using CSV.

Supported types:

  • role
  • category
  • excluded_product
  • excluded_category

Quickly configure large stores without manual setup.

---

### 📤 JSON Export (Full Backup)

Export all settings into a JSON file.

Includes:

  • Default timeout
  • Role rules
  • Category rules
  • Exclusions

Perfect for backups and migrations.

---

### 🔁 JSON Import (Quick Setup)

Import settings instantly on another site.

Ideal for:

  • Agencies
  • Multi-store setups
  • Staging → production deployment

---

### 👥 Works for Guests & Logged-in Users

CartFlush uses WooCommerce sessions, so it works for:

  • Guest users
  • Logged-in customers

No additional configuration required.

---

### 🎯 Lightweight & Efficient

No unnecessary overhead. The plugin focuses only on:

  • Tracking inactivity
  • Applying rules
  • Clearing carts

---

### 🌍 Translation Ready

Includes text domain and POT file for easy localization.

---

### 🧹 Clean Uninstall

When the plugin is deleted:

  • All data and settings are removed automatically

---

## == How It Works ==

  1. Customer adds items to cart
  2. Inactivity timer starts
  3. Plugin checks:
  • Default timeout
  • User role rules
  • Product category rules
  1. Shortest valid timeout is applied
  2. If excluded items exist → skip clearing
  3. Cart is cleared after timeout

---

## == Supported Import Formats ==

CSV headers:

type,key,timeout_minutes

### Supported types:

  • role
  • category
  • excluded_product
  • excluded_category

### Example:

role,customer,30
category,subscription-box,10
excluded_product,123,
excluded_category,high-ticket,

---

## == Frequently Asked Questions ==

### Does this work for guest users and logged-in users?

Yes. CartFlush uses WooCommerce sessions, so both are supported.

---

### How is the timeout calculated?

The plugin starts with the default timeout, then checks role and category rules. The shortest valid timeout is applied.

---

### What if a cart contains excluded items?

CartFlush will skip clearing the cart entirely.

---

### Can I migrate settings between sites?

Yes. Export settings as JSON and import them on another site.

---

### Does uninstall remove all data?

Yes. All plugin options are deleted during uninstall.

---

## == Screenshots ==

  1. Clean and modern CartFlush settings panel
  2. CSV import interface for rules
  3. JSON export/import tools
  4. Active rules and exclusions overview

---

## == Changelog ==

2.0.0

  • Added JSON import/export system
  • Added CSV rule import support
  • Added role-based timeout rules
  • Added category-based timeout rules
  • Added product and category exclusions
  • Improved admin UI with modern layout
  • Added uninstall cleanup
  • Added localization support
  • Refactored plugin structure

1.0.0

  • Initial release
File:
1 edited

Legend:

Unmodified
Added
Removed

  • cartflush-autoclear-cart-for-inactive-users/trunk/readme.txt

    r3484396 r3486189  
    1 === CartFlush AutoClear Cart for Inactive Users ===
     1Here’s a **WordPress.org–optimized version** of your README. This is cleaner, keyword-focused, and aligned with how plugins rank and convert on wp.org:
     2
     3---
     4
     5## === CartFlush – Auto Clear WooCommerce Cart for Inactive Users ===
     6
    27Contributors: wprashed
    3 Tags: woocommerce, cart, abandoned cart, cart timeout, cart cleanup
     8Tags: woocommerce cart cleanup, abandoned cart, cart timeout, woocommerce optimization, cart management
    49Requires at least: 5.8
    510Tested up to: 6.8
    … …  
    712Stable tag: 2.0.0
    813License: GPLv2 or later
    9 License URI: https://www.gnu.org/licenses/gpl-2.0.html
    10 
    11 Automatically clear inactive WooCommerce carts with flexible timeout rules, exclusions, and import/export tools.
    12 
    13 == Description ==
    14 
    15 CartFlush helps store owners keep carts fresh by automatically clearing inactive WooCommerce carts after a configurable delay. Beyond a simple global timeout, the plugin also supports imported role-based rules, category-based rules, product exclusions, and settings migration between stores.
    16 
    17 = Key Features =
    18 
    19 * Set a default inactivity timeout in minutes
    20 * Import role-based timeout rules from CSV
    21 * Import category-based timeout rules from CSV
    22 * Exclude specific product IDs or category slugs from auto-clear
    23 * Export the full plugin configuration as JSON
    24 * Import JSON settings on another site
    25 * Clean uninstall that removes stored plugin options
    26 * Translation-ready text domain and POT template
    27 * Clean, modern WordPress admin screen
    28 
    29 = Supported Import Formats =
     14License URI: [https://www.gnu.org/licenses/gpl-2.0.html](https://www.gnu.org/licenses/gpl-2.0.html)
     15
     16Automatically clear inactive WooCommerce carts with advanced timeout rules, exclusions, and import/export tools.
     17
     18---
     19
     20## == Description ==
     21
     22CartFlush helps you automatically clear inactive WooCommerce carts, keeping your store clean, fast, and optimized.
     23
     24Instead of relying on a basic timeout, CartFlush gives you full control over how cart expiration works. You can define different timeout rules based on user roles, product categories, and exclusions—making it flexible enough for real-world eCommerce scenarios.
     25
     26Whether you want faster cart turnover, better session management, or cleaner abandoned cart handling, CartFlush gives you the tools to do it properly.
     27
     28---
     29
     30## 🚀 Why Use CartFlush?
     31
     32* Prevent stale and abandoned carts from piling up
     33* Improve WooCommerce session performance
     34* Apply smarter rules based on users and products
     35* Save time with import/export configuration tools
     36* Maintain clean and optimized cart behavior
     37
     38---
     39
     40## == Key Features ==
     41
     42### ⏱ Default Cart Timeout
     43
     44Set a global inactivity timeout (in minutes). If no other rules apply, this value determines when a cart is cleared.
     45
     46---
     47
     48### 👤 Role-Based Timeout Rules
     49
     50Define custom cart expiration times based on user roles.
     51
     52Examples:
     53
     54* Customers → 30 minutes
     55* Subscribers → 60 minutes
     56* Wholesale users → 120 minutes
     57
     58Perfect for stores with different user types and behaviors.
     59
     60---
     61
     62### 🛍 Category-Based Timeout Rules
     63
     64Set cart timeout rules based on product categories.
     65
     66Use cases:
     67
     68* Flash sale items → shorter timeout
     69* Subscription products → shorter timeout
     70* High-value products → longer timeout
     71
     72CartFlush checks all items in the cart and applies the most relevant rule.
     73
     74---
     75
     76### ⚡ Smart Timeout Logic
     77
     78When multiple rules apply, CartFlush automatically selects the **shortest timeout**.
     79
     80This ensures:
     81
     82* Predictable behavior
     83* Better control over urgency
     84* No rule conflicts
     85
     86---
     87
     88### 🚫 Product Exclusions
     89
     90Exclude specific products from cart clearing.
     91
     92If a cart contains an excluded product:
     93→ The cart will NOT be cleared.
     94
     95---
     96
     97### 📂 Category Exclusions
     98
     99Exclude entire categories from auto-clear.
     100
     101If any product in the cart belongs to an excluded category:
     102→ Cart clearing is skipped.
     103
     104---
     105
     106### 📥 CSV Import for Rules
     107
     108Bulk import rules using CSV.
     109
     110Supported types:
     111
     112* role
     113* category
     114* excluded_product
     115* excluded_category
     116
     117Quickly configure large stores without manual setup.
     118
     119---
     120
     121### 📤 JSON Export (Full Backup)
     122
     123Export all settings into a JSON file.
     124
     125Includes:
     126
     127* Default timeout
     128* Role rules
     129* Category rules
     130* Exclusions
     131
     132Perfect for backups and migrations.
     133
     134---
     135
     136### 🔁 JSON Import (Quick Setup)
     137
     138Import settings instantly on another site.
     139
     140Ideal for:
     141
     142* Agencies
     143* Multi-store setups
     144* Staging → production deployment
     145
     146---
     147
     148### 👥 Works for Guests & Logged-in Users
     149
     150CartFlush uses WooCommerce sessions, so it works for:
     151
     152* Guest users
     153* Logged-in customers
     154
     155No additional configuration required.
     156
     157---
     158
     159### 🎯 Lightweight & Efficient
     160
     161No unnecessary overhead. The plugin focuses only on:
     162
     163* Tracking inactivity
     164* Applying rules
     165* Clearing carts
     166
     167---
     168
     169### 🌍 Translation Ready
     170
     171Includes text domain and POT file for easy localization.
     172
     173---
     174
     175### 🧹 Clean Uninstall
     176
     177When the plugin is deleted:
     178
     179* All data and settings are removed automatically
     180
     181---
     182
     183## == How It Works ==
     184
     1851. Customer adds items to cart
     1862. Inactivity timer starts
     1873. Plugin checks:
     188
     189   * Default timeout
     190   * User role rules
     191   * Product category rules
     1924. Shortest valid timeout is applied
     1935. If excluded items exist → skip clearing
     1946. Cart is cleared after timeout
     195
     196---
     197
     198## == Supported Import Formats ==
    30199
    31200CSV headers:
    … …  
    33202`type,key,timeout_minutes`
    34203
    35 Supported CSV types:
    36 
    37 * `role`
    38 * `category`
    39 * `excluded_product`
    40 * `excluded_category`
    41 
    42 Example CSV rows:
     204### Supported types:
     205
     206* role
     207* category
     208* excluded_product
     209* excluded_category
     210
     211### Example:
    43212
    44213`role,customer,30`
    … …  
    47216`excluded_category,high-ticket,`
    48217
    49 JSON exports include:
    50 
    51 * Default timeout
    52 * Imported role rules
    53 * Imported category rules
    54 * Excluded products
    55 * Excluded categories
    56 
    57 == Installation ==
    58 
    59 1. Upload the plugin folder to `/wp-content/plugins/cartflush-autoclear-cart-for-inactive-users/`.
    60 2. Activate the plugin through the WordPress Plugins screen.
    61 3. Make sure WooCommerce is active.
    62 4. Go to `Settings > CartFlush`.
    63 5. Save your default timeout or import rule files as needed.
    64 
    65 == Frequently Asked Questions ==
    66 
    67 = Does this work for guest users and logged-in users? =
    68 
    69 Yes. CartFlush uses the WooCommerce session, so it can track inactivity for both guest and logged-in shoppers.
    70 
    71 = How is the final timeout chosen? =
    72 
    73 The plugin starts with the default timeout, then checks imported role rules and product category rules in the current cart. If more than one applies, the shortest valid timeout is used.
    74 
    75 = What happens when a cart contains an excluded product or category? =
    76 
    77 CartFlush skips auto-clearing for that cart.
    78 
    79 = Can I move my settings between sites? =
    80 
    81 Yes. Export the current configuration as JSON and import it on another site running CartFlush.
    82 
    83 = Does uninstall remove plugin data? =
    84 
    85 Yes. When the plugin is uninstalled from WordPress, CartFlush removes its saved timeout and imported rule options.
    86 
    87 == Screenshots ==
    88 
    89 1. Modern CartFlush settings screen with timeout controls and import/export actions
    90 2. CSV and JSON import tools for moving rules between stores
    91 3. Imported configuration summary showing active rules and exclusions
    92 
    93 == Changelog ==
     218---
     219
     220## == Frequently Asked Questions ==
     221
     222### Does this work for guest users and logged-in users?
     223
     224Yes. CartFlush uses WooCommerce sessions, so both are supported.
     225
     226---
     227
     228### How is the timeout calculated?
     229
     230The plugin starts with the default timeout, then checks role and category rules. The shortest valid timeout is applied.
     231
     232---
     233
     234### What if a cart contains excluded items?
     235
     236CartFlush will skip clearing the cart entirely.
     237
     238---
     239
     240### Can I migrate settings between sites?
     241
     242Yes. Export settings as JSON and import them on another site.
     243
     244---
     245
     246### Does uninstall remove all data?
     247
     248Yes. All plugin options are deleted during uninstall.
     249
     250---
     251
     252## == Screenshots ==
     253
     2541. Clean and modern CartFlush settings panel
     2552. CSV import interface for rules
     2563. JSON export/import tools
     2574. Active rules and exclusions overview
     258
     259---
     260
     261## == Changelog ==
    94262
    95263= 2.0.0 =
    96264
    97 * Added uninstall cleanup for plugin options.
    98 * Added localization scaffolding and a starter POT file.
    99 * Refactored the plugin into a multi-file WordPress-friendly structure.
    100 * Added a polished admin interface with card-based layout and custom styling.
    101 * Refreshed plugin metadata and documentation for WordPress.org distribution.
    102 * Added README.md for repository hosting and project overview.
    103 * Added JSON import/export for CartFlush settings.
    104 * Added CSV import for role rules, category rules, and exclusion lists.
    105 * Added support for excluded products and excluded categories.
    106 * Added dynamic timeout matching based on user roles and cart categories.
     265* Added JSON import/export system
     266* Added CSV rule import support
     267* Added role-based timeout rules
     268* Added category-based timeout rules
     269* Added product and category exclusions
     270* Improved admin UI with modern layout
     271* Added uninstall cleanup
     272* Added localization support
     273* Refactored plugin structure
    107274
    108275= 1.0.0 =
    109276
    110 * Initial release.
     277* Initial release
Note: See TracChangeset for help on using the changeset viewer.