Skip to content
ms3Favorites
ms3Favorites
Wishlists for MiniShop3 and other resources — browser storage, DB sync
  1. Extras
  2. ms3Favorites
  3. System settings

System settings

All settings use the ms3favorites. prefix and live in the ms3favorites namespace.

Where to edit: Settings → System settings — filter by namespace ms3favorites.

Settings table

SettingDescriptionDefaultNotes
ms3favorites.max_itemsMaximum items in the Favorites block (localStorage/cookie and output)2020–50 for most sites; max 100. Enforced in JS when ms3fLexiconScript is loaded.
ms3favorites.storage_typeFavorites storage typelocalStoragelocalStorage — data in browser until cleared; cookie — shared across subdomains, 30-day expiry.
ms3favorites.guest_db_enabledSave guest list in DBtrueEnable for server-side counter, correct tab counts on /wishlist/, and guest sync. Identified by session_id.
ms3favorites.guest_ttl_daysGuest record retention (days)300 — do not delete. Used by auto-cleanup (cron).
ms3favorites.share_ttl_daysShare link validity (days)900 — no expiry.
ms3favorites.max_listsMaximum lists per user10Limit for named lists (default, gifts, plans, etc.). Max 20.
ms3favorites.comments_enabledEnable notes on itemstrueShow textarea for notes in cards. When off, update_comment is rejected.
ms3favorites.check_resource_availabilityCheck resource availability before addingfalseWhen on, only published and non-deleted resources are added (sync, copy_share).
ms3favorites.list_pageList page URL (for ms3FavoritesLists)wishlist/Relative path for list links.

Area in the MODX manager

In the transport package every key uses the default area (one group in System Settings). Logical grouping:

GroupKeys
Limits & storagemax_items, storage_type, max_lists
Guests & DBguest_db_enabled, guest_ttl_days
Sharingshare_ttl_days
Behaviourcomments_enabled, check_resource_availability, list_page

Recommendations

  • max_items: 20–50 for most sites; enforced in JS when ms3fLexiconScript is loaded.
  • storage_type: cookie — if you need a shared list across subdomains (cookie expiry 30 days).
  • guest_db_enabled: enable for server counter and tab counts on /wishlist/ for guests (and DB sync).
  • guest_ttl_days: for periodic cleanup add cli/cleanup_guests.php to cron.
  • share_ttl_days: 0 — link never expires; otherwise automatic expiry.

Guest record cleanup (cron)

bash
0 3 * * * php /path/to/site/core/components/ms3favorites/cli/cleanup_guests.php

When guest_ttl_days = 0, cleanup is not run.