fluentcart-developer 2.3.3 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cards/fluentcart/tools.d.ts.map +1 -1
- package/dist/cards/fluentcart/tools.js +2368 -2323
- package/dist/cards/fluentcart/tools.js.map +1 -1
- package/dist/paths.d.ts +1 -1
- package/dist/paths.d.ts.map +1 -1
- package/dist/paths.js +1 -1
- package/dist/paths.js.map +1 -1
- package/dist/reference-reader.d.ts +32 -1
- package/dist/reference-reader.d.ts.map +1 -1
- package/dist/reference-reader.js +111 -22
- package/dist/reference-reader.js.map +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +8 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/fluentcart-developer/SKILL.md +66 -538
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
- package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +57 -37
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
- package/dist/skills/fluentcart-developer/references/index.md +625 -0
- package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +38 -60
- package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +71 -89
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +406 -424
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +146 -396
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +354 -566
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +243 -138
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
- package/dist/skills/fluentcart-developer/.mcp.json +0 -11
- package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
- package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
- package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
- package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
- package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
- package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
- package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
- package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
- package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
- package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
- package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
- package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
- package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
- package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
- package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
- package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
- package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
- package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
- package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
- package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
- package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
- package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
- package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
- package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
- package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
- package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
- package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
- package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
- package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
- package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
- package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
- package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
- package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
- package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
- package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
- package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
- package/dist/skills/fluentcart-developer/references/rest-api-overview.md +0 -131
- package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
- package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
- package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
- package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
- package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
- package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
- package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
- package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
- package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
- package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
|
@@ -0,0 +1,1785 @@
|
|
|
1
|
+
# Products & Pricing
|
|
2
|
+
|
|
3
|
+
All filters related to [Product](/database/models/product.md) display, catalog management, pricing, stock, URLs, and [Coupon](/database/models/coupon.md)s.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Product Display & Layout
|
|
8
|
+
|
|
9
|
+
### ` products_list `
|
|
10
|
+
|
|
11
|
+
`fluent_cart/products_list` — Filter the admin products list
|
|
12
|
+
|
|
13
|
+
**When it runs:** This filter is applied after fetching the paginated products collection in the admin products list view.
|
|
14
|
+
|
|
15
|
+
**Parameters:**
|
|
16
|
+
|
|
17
|
+
- `$products` (LengthAwarePaginator): The paginated products collection with appended `view_url` and `edit_url` attributes
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
- `$products` (LengthAwarePaginator): The modified paginated collection
|
|
22
|
+
|
|
23
|
+
**Source:** `app/Http/Controllers/ProductController.php:59`
|
|
24
|
+
|
|
25
|
+
**Usage:**
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
add_filter('fluent_cart/products_list', function($products) {
|
|
29
|
+
// Modify the products collection before it is returned to the admin
|
|
30
|
+
$products->getCollection()->transform(function ($product) {
|
|
31
|
+
$product->custom_badge = 'Featured';
|
|
32
|
+
return $product;
|
|
33
|
+
});
|
|
34
|
+
return $products;
|
|
35
|
+
}, 10, 1);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### ` shop_query `
|
|
39
|
+
|
|
40
|
+
`fluent_cart/shop_query` — Filter the shop product query builder
|
|
41
|
+
|
|
42
|
+
**When it runs:** This filter is applied when building the query for the public-facing shop product listing, before search, status, and sorting clauses are added.
|
|
43
|
+
|
|
44
|
+
**Parameters:**
|
|
45
|
+
|
|
46
|
+
- `$query` (Builder): The Eloquent query builder instance with `select` and `with` already applied
|
|
47
|
+
- `$params` (array): The query parameters array
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
$params = [
|
|
51
|
+
'select' => '*',
|
|
52
|
+
'with' => [],
|
|
53
|
+
'admin_all_statuses' => [],
|
|
54
|
+
'selected_status' => '',
|
|
55
|
+
// ...additional request parameters
|
|
56
|
+
];
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Returns:**
|
|
60
|
+
|
|
61
|
+
- `$query` (Builder): The modified query builder
|
|
62
|
+
|
|
63
|
+
**Source:** `api/Resource/ShopResource.php:100`
|
|
64
|
+
|
|
65
|
+
**Usage:**
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
add_filter('fluent_cart/shop_query', function($query, $params) {
|
|
69
|
+
// Only show products from a specific category
|
|
70
|
+
$query->whereHas('taxonomies', function ($q) {
|
|
71
|
+
$q->where('taxonomy', 'product-category')
|
|
72
|
+
->where('term_id', 5);
|
|
73
|
+
});
|
|
74
|
+
return $query;
|
|
75
|
+
}, 10, 2);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### ` single_product/variation_view_type `
|
|
79
|
+
|
|
80
|
+
`fluent_cart/single_product/variation_view_type` — Filter the variation display type on single product pages
|
|
81
|
+
|
|
82
|
+
**When it runs:** This filter is applied when initializing the product renderer to determine how variations are visually presented on the single product page.
|
|
83
|
+
|
|
84
|
+
**Parameters:**
|
|
85
|
+
|
|
86
|
+
- `$viewType` (string): The variation view type. Possible values: `'image'`, `'text'`, `'both'`
|
|
87
|
+
- `$data` (array): Context data
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
$data = [
|
|
91
|
+
'product' => $product, // Product model
|
|
92
|
+
'variants' => $variants, // Collection of variants
|
|
93
|
+
'defaultVariationId' => $defaultVariationId // Default selected variation ID
|
|
94
|
+
];
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Returns:**
|
|
98
|
+
|
|
99
|
+
- `$viewType` (string): The modified view type
|
|
100
|
+
|
|
101
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:67`
|
|
102
|
+
|
|
103
|
+
**Usage:**
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
add_filter('fluent_cart/single_product/variation_view_type', function($viewType, $data) {
|
|
107
|
+
// Always show both image and text for variations
|
|
108
|
+
return 'both';
|
|
109
|
+
}, 10, 2);
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### ` single_product/variation_column_type `
|
|
113
|
+
|
|
114
|
+
`fluent_cart/single_product/variation_column_type` — Filter the variation column layout on single product pages
|
|
115
|
+
|
|
116
|
+
**When it runs:** This filter is applied when initializing the product renderer to determine the column layout for product variations.
|
|
117
|
+
|
|
118
|
+
**Parameters:**
|
|
119
|
+
|
|
120
|
+
- `$columnType` (string): The column layout type. Possible values: `'one'`, `'two'`, `'three'`, `'four'`, `'masonry'`
|
|
121
|
+
- `$data` (array): Context data
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
$data = [
|
|
125
|
+
'product' => $product, // Product model
|
|
126
|
+
'variants' => $variants, // Collection of variants
|
|
127
|
+
'defaultVariationId' => $defaultVariationId // Default selected variation ID
|
|
128
|
+
];
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
**Returns:**
|
|
132
|
+
|
|
133
|
+
- `$columnType` (string): The modified column type
|
|
134
|
+
|
|
135
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:74`
|
|
136
|
+
|
|
137
|
+
**Usage:**
|
|
138
|
+
|
|
139
|
+
```
|
|
140
|
+
add_filter('fluent_cart/single_product/variation_column_type', function($columnType, $data) {
|
|
141
|
+
$product = $data['product'];
|
|
142
|
+
// Use two-column layout for products with many variations
|
|
143
|
+
if (count($data['variants']) > 6) {
|
|
144
|
+
return 'two';
|
|
145
|
+
}
|
|
146
|
+
return $columnType;
|
|
147
|
+
}, 10, 2);
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### ` single_product/variation_price `
|
|
151
|
+
|
|
152
|
+
`fluent_cart/single_product/variation_price` — Filter the variation price text displayed on single product pages
|
|
153
|
+
|
|
154
|
+
**When it runs:** This filter is applied when rendering the price text for each product variation. For one-time products the price is the formatted decimal amount; for subscriptions it includes the billing terms text.
|
|
155
|
+
|
|
156
|
+
**Parameters:**
|
|
157
|
+
|
|
158
|
+
- `$priceText` (string): The formatted price text (escaped HTML)
|
|
159
|
+
- `$data` (array): Context data
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
$data = [
|
|
163
|
+
'product' => $product, // Product model
|
|
164
|
+
'variant' => $variant, // ProductVariant model
|
|
165
|
+
'scope' => 'product_variant_price'
|
|
166
|
+
];
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
**Returns:**
|
|
170
|
+
|
|
171
|
+
- `$priceText` (string): The modified price text (HTML allowed via `wp_kses_post`)
|
|
172
|
+
|
|
173
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:1213`
|
|
174
|
+
|
|
175
|
+
**Usage:**
|
|
176
|
+
|
|
177
|
+
```
|
|
178
|
+
add_filter('fluent_cart/single_product/variation_price', function($priceText, $data) {
|
|
179
|
+
$variant = $data['variant'];
|
|
180
|
+
// Append a "per month" label for subscription variants
|
|
181
|
+
if ($variant->payment_type === 'subscription') {
|
|
182
|
+
return $priceText . ' <small>/month</small>';
|
|
183
|
+
}
|
|
184
|
+
return $priceText;
|
|
185
|
+
}, 10, 2);
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### ` shop_app_product_query_taxonomy_filters `
|
|
189
|
+
|
|
190
|
+
`fluent_cart/shop_app_product_query_taxonomy_filters` — Filter taxonomy filters for the Shop block product query
|
|
191
|
+
|
|
192
|
+
**When it runs:** This filter is applied in the Shop App Gutenberg block when merging URL-based taxonomy filters with default block filters, before the product query is executed.
|
|
193
|
+
|
|
194
|
+
**Parameters:**
|
|
195
|
+
|
|
196
|
+
- `$mergedTerms` (array): Merged taxonomy term IDs keyed by taxonomy name
|
|
197
|
+
|
|
198
|
+
```
|
|
199
|
+
$mergedTerms = [
|
|
200
|
+
'product-category' => [1, 5, 12],
|
|
201
|
+
'product-tag' => [3, 7]
|
|
202
|
+
];
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
- `$data` (array): Context data
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
$data = [
|
|
209
|
+
'default_terms' => $defaultTerms, // Terms from block settings
|
|
210
|
+
'url_terms' => $urlTerms, // Terms from URL query parameters
|
|
211
|
+
'url_filters' => $urlFilters, // Raw URL filter parameters
|
|
212
|
+
'default_filters' => $defaultFilters, // Raw block default filters
|
|
213
|
+
'block' => $block, // Block instance
|
|
214
|
+
'is_main_query' => true|false // Whether this is the main query
|
|
215
|
+
];
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
**Returns:**
|
|
219
|
+
|
|
220
|
+
- `$mergedTerms` (array): The modified taxonomy term IDs array
|
|
221
|
+
|
|
222
|
+
**Source:** `app/Hooks/Handlers/BlockEditors/ShopApp/InnerBlocks/InnerBlocks.php:1379`
|
|
223
|
+
|
|
224
|
+
**Usage:**
|
|
225
|
+
|
|
226
|
+
```
|
|
227
|
+
add_filter('fluent_cart/shop_app_product_query_taxonomy_filters', function($mergedTerms, $data) {
|
|
228
|
+
// Always exclude a specific category from shop listings
|
|
229
|
+
if (isset($mergedTerms['product-category'])) {
|
|
230
|
+
$mergedTerms['product-category'] = array_diff($mergedTerms['product-category'], [99]);
|
|
231
|
+
}
|
|
232
|
+
return $mergedTerms;
|
|
233
|
+
}, 10, 2);
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### ` products_views/preload_collection_{$provider} `
|
|
237
|
+
|
|
238
|
+
`fluent_cart/products_views/preload_collection_{$provider}` — Preload product view collection for a template provider
|
|
239
|
+
|
|
240
|
+
**When it runs:** This dynamic filter is applied when the shop controller loads products via AJAX for a specific template provider (e.g., `bricks`). The `{$provider}` portion is replaced with the template provider name from the request.
|
|
241
|
+
|
|
242
|
+
**Parameters:**
|
|
243
|
+
|
|
244
|
+
- `$html` (string): Default empty string. Return rendered HTML to use the preloaded view instead of JSON
|
|
245
|
+
- `$data` (array): Context data
|
|
246
|
+
|
|
247
|
+
```
|
|
248
|
+
$data = [
|
|
249
|
+
'client_id' => $clientId, // Client identifier from the request
|
|
250
|
+
'products' => $products, // Array of product data
|
|
251
|
+
'total' => $total, // Total number of products
|
|
252
|
+
'requestData' => $requestData // Full request parameters
|
|
253
|
+
];
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
**Returns:**
|
|
257
|
+
|
|
258
|
+
- `$html` (string): Rendered HTML string, or empty string to fall back to default JSON response
|
|
259
|
+
|
|
260
|
+
**Source:** `app/Http/Controllers/ShopController.php:133`
|
|
261
|
+
|
|
262
|
+
**Usage:**
|
|
263
|
+
|
|
264
|
+
```
|
|
265
|
+
add_filter('fluent_cart/products_views/preload_collection_bricks', function($html, $data) {
|
|
266
|
+
// Return custom rendered HTML for Bricks page builder
|
|
267
|
+
ob_start();
|
|
268
|
+
foreach ($data['products'] as $product) {
|
|
269
|
+
echo '<div class="custom-product-card">' . esc_html($product['title']) . '</div>';
|
|
270
|
+
}
|
|
271
|
+
return ob_get_clean();
|
|
272
|
+
}, 10, 2);
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### ` product/card_classes `
|
|
276
|
+
|
|
277
|
+
`fluent_cart/product/card_classes` — Filter the CSS classes on a product card wrapper
|
|
278
|
+
|
|
279
|
+
**When it runs:** This filter is applied by `RenderGate::cardClasses()` whenever a product card is rendered (shop listing, related products, carousel, etc.), just before the class list is imploded into the `class` attribute on the card `` element.
|
|
280
|
+
|
|
281
|
+
**Parameters:**
|
|
282
|
+
|
|
283
|
+
- `$classes` (array): The CSS class strings for the card wrapper
|
|
284
|
+
- `$context` (array): Render context, decorated by `RenderContext::decorate()`
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
$context = [
|
|
288
|
+
'product' => $product, // Product model, or null
|
|
289
|
+
'scope' => 'card', // RenderGate::SCOPE_CARD
|
|
290
|
+
// ...additional keys added by RenderContext::decorate()
|
|
291
|
+
];
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
**Returns:**
|
|
295
|
+
|
|
296
|
+
- `$classes` (array): The modified array of CSS class strings. A non-array return is treated as an empty class list.
|
|
297
|
+
|
|
298
|
+
**Source:** `app/Services/Renderer/RenderGate.php:142`
|
|
299
|
+
|
|
300
|
+
**Usage:**
|
|
301
|
+
|
|
302
|
+
```
|
|
303
|
+
add_filter('fluent_cart/product/card_classes', function($classes, $context) {
|
|
304
|
+
$product = $context['product'] ?? null;
|
|
305
|
+
if ($product && $product->detail->variation_type === 'advanced_variations') {
|
|
306
|
+
$classes[] = 'fct-has-advanced-variations';
|
|
307
|
+
}
|
|
308
|
+
return $classes;
|
|
309
|
+
}, 10, 2);
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### ` product/display_price `
|
|
313
|
+
|
|
314
|
+
`fluent_cart/product/display_price` — Filter the price shown on a product card or single product page
|
|
315
|
+
|
|
316
|
+
**When it runs:** This filter is applied after the renderer resolves the lowest/default variation price to display — on the shop/related product card (`ProductCardRender`) and on the single product page (`ProductRenderer`). Amounts are in cents; the caller casts the filtered result back to `int`.
|
|
317
|
+
|
|
318
|
+
**Parameters:**
|
|
319
|
+
|
|
320
|
+
- `$price` (int): The resolved display price, in cents
|
|
321
|
+
- `$data` (array): Context data
|
|
322
|
+
|
|
323
|
+
```
|
|
324
|
+
$data = [
|
|
325
|
+
'product' => $product, // Product model
|
|
326
|
+
'variation' => $variation, // ProductVariation model (the matched/first variant)
|
|
327
|
+
];
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
**Returns:**
|
|
331
|
+
|
|
332
|
+
- `$price` (int): The modified price, in cents
|
|
333
|
+
|
|
334
|
+
**Source:** `app/Services/Renderer/ProductCardRender.php:272`, `app/Services/Renderer/ProductRenderer.php:992`
|
|
335
|
+
|
|
336
|
+
**Usage:**
|
|
337
|
+
|
|
338
|
+
```
|
|
339
|
+
add_filter('fluent_cart/product/display_price', function($price, $data) {
|
|
340
|
+
// Show a 10% "member price" preview for logged-in customers
|
|
341
|
+
if (is_user_logged_in()) {
|
|
342
|
+
return (int) round($price * 0.9);
|
|
343
|
+
}
|
|
344
|
+
return $price;
|
|
345
|
+
}, 10, 2);
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### ` product/gallery_variation_data `
|
|
349
|
+
|
|
350
|
+
`fluent_cart/product/gallery_variation_data` — Filter the variant-to-gallery-image mapping for advanced-variation products
|
|
351
|
+
|
|
352
|
+
**When it runs:** This filter is applied only for products using the advanced-variation type (`Helper::PRODUCT_TYPE_ADVANCE_VARIATION`), while the product renderer builds its image gallery. It lets an integrator (Pro's advanced-variation module) supply the maps that associate each variant term / variant combination with specific gallery media.
|
|
353
|
+
|
|
354
|
+
**Parameters:**
|
|
355
|
+
|
|
356
|
+
- `$data` (array): Default empty maps
|
|
357
|
+
|
|
358
|
+
```
|
|
359
|
+
$data = [
|
|
360
|
+
'variant_term_map' => [], // term_id => [media info] or similar mapping
|
|
361
|
+
'variant_first_media_map' => [], // variation_id => first media item for that variant
|
|
362
|
+
];
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
- `$product` ([Product](/database/models/product.md)): The product being rendered
|
|
366
|
+
|
|
367
|
+
**Returns:**
|
|
368
|
+
|
|
369
|
+
- `$data` (array): The modified `variant_term_map` / `variant_first_media_map` maps. Read back as `$this->variantTermMap` and `$variantFirstMediaMap` by the renderer.
|
|
370
|
+
|
|
371
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:467`
|
|
372
|
+
|
|
373
|
+
**Usage:**
|
|
374
|
+
|
|
375
|
+
```
|
|
376
|
+
add_filter('fluent_cart/product/gallery_variation_data', function($data, $product) {
|
|
377
|
+
// Populate a custom first-media map built from variant meta
|
|
378
|
+
foreach ($product->variants as $variant) {
|
|
379
|
+
if (!empty($variant->other_info['gallery_image_id'])) {
|
|
380
|
+
$data['variant_first_media_map'][$variant->id] = $variant->other_info['gallery_image_id'];
|
|
381
|
+
}
|
|
382
|
+
}
|
|
383
|
+
return $data;
|
|
384
|
+
}, 10, 2);
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
### ` product/get_response_data `
|
|
388
|
+
|
|
389
|
+
`fluent_cart/product/get_response_data` — Filter the admin product editor's "get product" API response payload
|
|
390
|
+
|
|
391
|
+
**When it runs:** This filter is applied in the admin product controller right before the single-product edit response is sent to the Vue admin app, after the product model has been converted to an array.
|
|
392
|
+
|
|
393
|
+
**Parameters:**
|
|
394
|
+
|
|
395
|
+
- `$payload` (array): The response payload
|
|
396
|
+
|
|
397
|
+
```
|
|
398
|
+
$payload = [
|
|
399
|
+
'product' => $productData, // array, from $product->toArray() plus 'featured_image_id'
|
|
400
|
+
'product_id' => 123, // int
|
|
401
|
+
'request' => $request, // \FluentCart\Framework\Http\Request\Request instance
|
|
402
|
+
];
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
**Returns:**
|
|
406
|
+
|
|
407
|
+
- `$payload` (array): The modified payload. Only `$payload['product']` is read back by the caller (via `Arr::get($payload, 'product', $productData)`); other keys are for the listener's own use.
|
|
408
|
+
|
|
409
|
+
**Source:** `app/Http/Controllers/ProductController.php:799`
|
|
410
|
+
|
|
411
|
+
**Usage:**
|
|
412
|
+
|
|
413
|
+
```
|
|
414
|
+
add_filter('fluent_cart/product/get_response_data', function($payload) {
|
|
415
|
+
// Attach a computed field the admin UI can render
|
|
416
|
+
$payload['product']['review_count'] = get_review_count_for_product($payload['product_id']);
|
|
417
|
+
return $payload;
|
|
418
|
+
}, 10, 1);
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### ` product/price_suffix_context `
|
|
422
|
+
|
|
423
|
+
`fluent_cart/product/price_suffix_context` — Filter the context passed to the price suffix renderer
|
|
424
|
+
|
|
425
|
+
**When it runs:** This filter is applied at the start of `RenderHelper::renderPriceSuffix()`, before the context is handed to `fluent_cart/product/price_suffix_atts` (the filter that actually returns the suffix text, e.g. the Tax module's "incl. tax" label).
|
|
426
|
+
|
|
427
|
+
**Parameters:**
|
|
428
|
+
|
|
429
|
+
- `$context` (array): The suffix render context
|
|
430
|
+
|
|
431
|
+
```
|
|
432
|
+
$context = [
|
|
433
|
+
'product' => $product, // Product model
|
|
434
|
+
'variant' => $variant, // ProductVariant model
|
|
435
|
+
'scope' => $scope, // e.g. 'variant_item'
|
|
436
|
+
];
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
**Returns:**
|
|
440
|
+
|
|
441
|
+
- `$context` (array): The modified context array, passed straight through to `fluent_cart/product/price_suffix_atts`
|
|
442
|
+
|
|
443
|
+
**Source:** `app/Services/Renderer/RenderHelper.php:20`
|
|
444
|
+
|
|
445
|
+
**Usage:**
|
|
446
|
+
|
|
447
|
+
```
|
|
448
|
+
add_filter('fluent_cart/product/price_suffix_context', function($context) {
|
|
449
|
+
// Flag wholesale variants so a listener on price_suffix_atts can react
|
|
450
|
+
$context['is_wholesale'] = !empty($context['variant']->other_info['wholesale']);
|
|
451
|
+
return $context;
|
|
452
|
+
}, 10, 1);
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
### ` product/render_advanced_variation `
|
|
456
|
+
|
|
457
|
+
`fluent_cart/product/render_advanced_variation` — Let an add-on render the variation selector for advanced-variation products
|
|
458
|
+
|
|
459
|
+
**When it runs:** This filter is applied by the single-product renderer, but only when the product's variation type is the advanced-variation type. It is the hand-off point that lets FluentCart Pro's advanced-variation selector replace the core's simple-variation markup entirely.
|
|
460
|
+
|
|
461
|
+
**Parameters:**
|
|
462
|
+
|
|
463
|
+
- `$result` (array): Render request/result
|
|
464
|
+
|
|
465
|
+
```
|
|
466
|
+
$result = [
|
|
467
|
+
'product' => $this->product, // Product model
|
|
468
|
+
'selector_style' => 'auto', // from render atts, default 'auto'
|
|
469
|
+
'rendered' => false, // set true to signal the listener rendered the selector
|
|
470
|
+
];
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
**Returns:**
|
|
474
|
+
|
|
475
|
+
- `$result` (array): The same shape back. **The core renderer only skips its own simple-variation output when `$result['rendered']` is truthy** — a listener that filters other keys but leaves `rendered` at `false` is a no-op and the default selector still renders.
|
|
476
|
+
|
|
477
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:350`
|
|
478
|
+
|
|
479
|
+
**Usage:**
|
|
480
|
+
|
|
481
|
+
```
|
|
482
|
+
add_filter('fluent_cart/product/render_advanced_variation', function($result) {
|
|
483
|
+
// Echo a custom selector and take over rendering
|
|
484
|
+
echo '<div class="my-advanced-variation-selector" data-product-id="' . esc_attr($result['product']->ID) . '"></div>';
|
|
485
|
+
$result['rendered'] = true;
|
|
486
|
+
return $result;
|
|
487
|
+
}, 10, 1);
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
### ` product/render_source `
|
|
491
|
+
|
|
492
|
+
`fluent_cart/product/render_source` — Filter which render source/provider is currently active
|
|
493
|
+
|
|
494
|
+
**When it runs:** This filter is applied by `RenderContext` whenever code needs to know which template provider is currently rendering product markup (e.g. the classic PHP renderer vs. a page-builder integration like Bricks). It has no natural default source of truth, so it always starts from an "unknown" fallback and relies entirely on a listener to identify itself.
|
|
495
|
+
|
|
496
|
+
**Parameters:**
|
|
497
|
+
|
|
498
|
+
- `$fallback` (array): The default value
|
|
499
|
+
|
|
500
|
+
```
|
|
501
|
+
$fallback = [
|
|
502
|
+
'source' => 'unknown', // RenderContext::SOURCE_UNKNOWN
|
|
503
|
+
'name' => '',
|
|
504
|
+
];
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
**Returns:**
|
|
508
|
+
|
|
509
|
+
- `array` — Must include a non-empty `'source'` key to be accepted; otherwise the `$fallback` is used. `'name'` is cast to string.
|
|
510
|
+
|
|
511
|
+
**Source:** `app/Services/Renderer/RenderContext.php:89`
|
|
512
|
+
|
|
513
|
+
**Usage:**
|
|
514
|
+
|
|
515
|
+
```
|
|
516
|
+
add_filter('fluent_cart/product/render_source', function($fallback) {
|
|
517
|
+
if (defined('BRICKS_VERSION') && bricks_is_builder()) {
|
|
518
|
+
return ['source' => 'bricks', 'name' => 'Bricks Builder'];
|
|
519
|
+
}
|
|
520
|
+
return $fallback;
|
|
521
|
+
}, 10, 1);
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### ` product/show_section `
|
|
525
|
+
|
|
526
|
+
`fluent_cart/product/show_section` — Generic filter for whether any product render section should be shown
|
|
527
|
+
|
|
528
|
+
**When it runs:** This filter is applied by `RenderGate::shouldRender()` immediately after the section-specific `fluent_cart/product/show_{$section}` filter (see below) has run, receiving that filter's result. Use this one when you want to gate visibility across *every* section from a single callback instead of hooking each section name individually.
|
|
529
|
+
|
|
530
|
+
**Parameters:**
|
|
531
|
+
|
|
532
|
+
- `$show` (bool): The visibility decision from the section-specific filter
|
|
533
|
+
- `$context` (array): Render context (decorated via `RenderContext::decorate()`), includes the product, scope, and the section being gated
|
|
534
|
+
|
|
535
|
+
**Returns:**
|
|
536
|
+
|
|
537
|
+
- `bool` — Whether the section should render
|
|
538
|
+
|
|
539
|
+
**Source:** `app/Services/Renderer/RenderGate.php:109`
|
|
540
|
+
|
|
541
|
+
**Usage:**
|
|
542
|
+
|
|
543
|
+
```
|
|
544
|
+
add_filter('fluent_cart/product/show_section', function($show, $context) {
|
|
545
|
+
// Hide every card section for products tagged "coming-soon"
|
|
546
|
+
$product = $context['product'] ?? null;
|
|
547
|
+
if ($product && $product->hasTerm('coming-soon', 'product-tag')) {
|
|
548
|
+
return false;
|
|
549
|
+
}
|
|
550
|
+
return $show;
|
|
551
|
+
}, 10, 2);
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
### ` product/show_{$section} `
|
|
555
|
+
|
|
556
|
+
`fluent_cart/product/show_{$section}` — Filter whether a specific product render section should be shown
|
|
557
|
+
|
|
558
|
+
**When it runs:** This dynamic filter is applied first inside `RenderGate::shouldRender()`, before the generic `fluent_cart/product/show_section` filter above wraps its result. The `{$section}` portion is the section name being gated.
|
|
559
|
+
|
|
560
|
+
**`{$section}` values:** `RenderGate::SECTIONS` is a fixed set of 9 — `image`, `title`, `excerpt`, `price`, `quantity`, `actions`, `add_to_cart_button`, `buy_now_button`, `buy_section`. That gives the concrete hook names `fluent_cart/product/show_image`, `show_title`, `show_excerpt`, `show_price`, `show_quantity`, `show_actions`, `show_add_to_cart_button`, `show_buy_now_button`, `show_buy_section`.
|
|
561
|
+
|
|
562
|
+
Note: `actions` gates the whole purchase-actions row, and `shouldRenderPurchaseButton()` requires that row to be visible before `add_to_cart_button` or `buy_now_button` can render individually — hiding `actions` hides the buttons too, even if their own gates return `true`.
|
|
563
|
+
|
|
564
|
+
**Parameters:**
|
|
565
|
+
|
|
566
|
+
- `$show` (bool): Whether the section should render. Default: `true`
|
|
567
|
+
- `$context` (array): Render context (decorated via `RenderContext::decorate()`), includes the product and scope
|
|
568
|
+
|
|
569
|
+
**Returns:**
|
|
570
|
+
|
|
571
|
+
- `bool` — Whether this section should render
|
|
572
|
+
|
|
573
|
+
**Source:** `app/Services/Renderer/RenderGate.php:107`
|
|
574
|
+
|
|
575
|
+
**Usage:**
|
|
576
|
+
|
|
577
|
+
```
|
|
578
|
+
add_filter('fluent_cart/product/show_title', function($show, $context) {
|
|
579
|
+
// Hide the title block on the card, but keep it on the single page
|
|
580
|
+
if (($context['scope'] ?? '') === 'card') {
|
|
581
|
+
return false;
|
|
582
|
+
}
|
|
583
|
+
return $show;
|
|
584
|
+
}, 10, 2);
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
---
|
|
588
|
+
|
|
589
|
+
## Product Reviews
|
|
590
|
+
|
|
591
|
+
### ` reviews/star_svg `
|
|
592
|
+
|
|
593
|
+
`fluent_cart/reviews/star_svg` — Replace the SVG star used for every server-rendered rating
|
|
594
|
+
|
|
595
|
+
**When it runs:** This filter runs inside `ReviewThreadMarkup::starSvg()`. Every storefront star the server renders comes from that method:
|
|
596
|
+
|
|
597
|
+
- the reviews summary, each review, the rating bars and the star filter chips on the single product page
|
|
598
|
+
- the star picker in the review form
|
|
599
|
+
- the star row on product cards ("show rating in shop") and in the Product Rating block, including half stars
|
|
600
|
+
- the review list blocks and the AJAX `stars_html` response
|
|
601
|
+
|
|
602
|
+
The default markup is read from `app/Views/icons/review-star.svg` and kept in a static cache for the request. The filter still runs on **every call**, so a listener can return different markup for each render.
|
|
603
|
+
|
|
604
|
+
Server-rendered stars only
|
|
605
|
+
|
|
606
|
+
The admin Reviews screen, the block editor previews and the customer portal's My Reviews page import the star shape in the browser, from the same `review-star.svg` file. This filter does not reach them.
|
|
607
|
+
|
|
608
|
+
Review emails do not use it either. They still print the text characters `★` / `☆`, because Gmail and Outlook strip inline SVG.
|
|
609
|
+
|
|
610
|
+
**Parameters:**
|
|
611
|
+
|
|
612
|
+
- `$svg` (string): The full `` markup for a single star.
|
|
613
|
+
|
|
614
|
+
```
|
|
615
|
+
$svg = '<svg class="fct-star-svg" width="1em" height="1em" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false"><path d="M11.16 3.47Q12 1.65 ..."/></svg>';
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
**Returns:**
|
|
619
|
+
|
|
620
|
+
- `string` — The SVG markup to render for each star.
|
|
621
|
+
|
|
622
|
+
Keep the class, fill and size
|
|
623
|
+
|
|
624
|
+
The star CSS depends on three things in the default markup: the `fct-star-svg` class, `fill="currentColor"`, and `width`/`height` of `1em`. Filled, empty and half-star colors are applied through `currentColor`. A half star clips a 50%-wide wrapper around the SVG. Keep all three in your replacement, or the colors, sizing and half-star clipping will break.
|
|
625
|
+
|
|
626
|
+
Output is not escaped
|
|
627
|
+
|
|
628
|
+
The filtered value is echoed as-is, the same way the built-in star is. Return only trusted, static SVG markup and never pass user input through this filter.
|
|
629
|
+
|
|
630
|
+
**Source:** `app/Services/Renderer/ReviewThreadMarkup.php:455`
|
|
631
|
+
|
|
632
|
+
**Usage:**
|
|
633
|
+
|
|
634
|
+
```
|
|
635
|
+
// Draw ratings as dots instead of stars
|
|
636
|
+
add_filter('fluent_cart/reviews/star_svg', function ($svg) {
|
|
637
|
+
return '<svg class="fct-star-svg" width="1em" height="1em" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false"><circle cx="12" cy="12" r="9"/></svg>';
|
|
638
|
+
});
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
```
|
|
642
|
+
// Keep the default star but add a class to it for custom styling
|
|
643
|
+
add_filter('fluent_cart/reviews/star_svg', function ($svg) {
|
|
644
|
+
return str_replace('class="fct-star-svg"', 'class="fct-star-svg my-theme-star"', $svg);
|
|
645
|
+
});
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
---
|
|
649
|
+
|
|
650
|
+
## Product Buttons & Text
|
|
651
|
+
|
|
652
|
+
### ` product/buy_now_button_text `
|
|
653
|
+
|
|
654
|
+
`fluent_cart/product/buy_now_button_text` — Filter the Buy Now button text
|
|
655
|
+
|
|
656
|
+
**When it runs:** This filter is applied when rendering the "Buy Now" button on single product pages. It runs in both the PHP product renderer and when localizing JavaScript variables for the frontend.
|
|
657
|
+
|
|
658
|
+
**Parameters:**
|
|
659
|
+
|
|
660
|
+
- `$text` (string): The button text. Default: `'Buy Now'` (translated)
|
|
661
|
+
- `$data` (array): Context data
|
|
662
|
+
|
|
663
|
+
```
|
|
664
|
+
$data = [
|
|
665
|
+
'product' => $product // Product model (when rendered server-side)
|
|
666
|
+
];
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
**Returns:**
|
|
670
|
+
|
|
671
|
+
- `$text` (string): The modified button text
|
|
672
|
+
|
|
673
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:1500,1606`, `app/Modules/Templating/AssetLoader.php:87,261`
|
|
674
|
+
|
|
675
|
+
**Usage:**
|
|
676
|
+
|
|
677
|
+
```
|
|
678
|
+
add_filter('fluent_cart/product/buy_now_button_text', function($text, $data) {
|
|
679
|
+
// Customize Buy Now text for specific products
|
|
680
|
+
if (!empty($data['product']) && $data['product']->product_type === 'digital') {
|
|
681
|
+
return 'Download Now';
|
|
682
|
+
}
|
|
683
|
+
return $text;
|
|
684
|
+
}, 10, 2);
|
|
685
|
+
```
|
|
686
|
+
|
|
687
|
+
### ` product/add_to_cart_text `
|
|
688
|
+
|
|
689
|
+
`fluent_cart/product/add_to_cart_text` — Filter the Add to Cart button text
|
|
690
|
+
|
|
691
|
+
**When it runs:** This filter is applied when rendering the "Add to Cart" button text across multiple contexts: single product pages, shop blocks, product carousels, shortcodes, and localized JavaScript variables.
|
|
692
|
+
|
|
693
|
+
**Parameters:**
|
|
694
|
+
|
|
695
|
+
- `$text` (string): The button text. Default: `'Add To Cart'` (translated)
|
|
696
|
+
- `$data` (array): Context data
|
|
697
|
+
|
|
698
|
+
```
|
|
699
|
+
$data = [
|
|
700
|
+
'product' => $product // Product model (when rendered server-side)
|
|
701
|
+
];
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
**Returns:**
|
|
705
|
+
|
|
706
|
+
- `$text` (string): The modified button text
|
|
707
|
+
|
|
708
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:1659,1775`, `app/Hooks/Handlers/ShortCodes/SingleProductShortCode.php:81`, `app/Hooks/Handlers/BlockEditors/ShopApp/InnerBlocks/InnerBlocks.php:1025,1104`, `app/Modules/Templating/AssetLoader.php:83,258`, `app/Hooks/Handlers/BlockEditors/ProductCarousel/InnerBlocks/InnerBlocks.php:493`
|
|
709
|
+
|
|
710
|
+
**Usage:**
|
|
711
|
+
|
|
712
|
+
```
|
|
713
|
+
add_filter('fluent_cart/product/add_to_cart_text', function($text, $data) {
|
|
714
|
+
// Change to a different label
|
|
715
|
+
return 'Add to Basket';
|
|
716
|
+
}, 10, 2);
|
|
717
|
+
```
|
|
718
|
+
|
|
719
|
+
### ` product/out_of_stock_text `
|
|
720
|
+
|
|
721
|
+
`fluent_cart/product/out_of_stock_text` — Filter the out-of-stock button text
|
|
722
|
+
|
|
723
|
+
**When it runs:** This filter is applied when rendering the button text for products that are out of stock. It is used across shortcodes, shop blocks, product carousels, and localized JavaScript variables.
|
|
724
|
+
|
|
725
|
+
**Parameters:**
|
|
726
|
+
|
|
727
|
+
- `$text` (string): The out-of-stock text. Default: `'Not Available'` (translated)
|
|
728
|
+
- `$data` (array): Context data (empty array)
|
|
729
|
+
|
|
730
|
+
**Returns:**
|
|
731
|
+
|
|
732
|
+
- `$text` (string): The modified out-of-stock text
|
|
733
|
+
|
|
734
|
+
**Source:** `app/Hooks/Handlers/ShortCodes/SingleProductShortCode.php:91`, `app/Hooks/Handlers/BlockEditors/ShopApp/InnerBlocks/InnerBlocks.php:1027,1106`, `app/Modules/Templating/AssetLoader.php:85`, `app/Hooks/Handlers/BlockEditors/ProductCarousel/InnerBlocks/InnerBlocks.php:495`
|
|
735
|
+
|
|
736
|
+
**Usage:**
|
|
737
|
+
|
|
738
|
+
```
|
|
739
|
+
add_filter('fluent_cart/product/out_of_stock_text', function($text) {
|
|
740
|
+
return 'Sold Out';
|
|
741
|
+
}, 10, 1);
|
|
742
|
+
```
|
|
743
|
+
|
|
744
|
+
### ` product/out_of_stock_button_text `
|
|
745
|
+
|
|
746
|
+
`fluent_cart/product/out_of_stock_button_text` — Filter the out-of-stock button text (block editor variant)
|
|
747
|
+
|
|
748
|
+
**When it runs:** This filter is applied in the block editor asset loader when localizing the out-of-stock button text for JavaScript-rendered product pages. It serves the same purpose as `out_of_stock_text` but is used in a different rendering context.
|
|
749
|
+
|
|
750
|
+
**Parameters:**
|
|
751
|
+
|
|
752
|
+
- `$text` (string): The out-of-stock text. Default: `'Not Available'` (translated)
|
|
753
|
+
- `$data` (array): Context data (empty array)
|
|
754
|
+
|
|
755
|
+
**Returns:**
|
|
756
|
+
|
|
757
|
+
- `$text` (string): The modified out-of-stock button text
|
|
758
|
+
|
|
759
|
+
**Source:** `app/Modules/Templating/AssetLoader.php:314`
|
|
760
|
+
|
|
761
|
+
**Usage:**
|
|
762
|
+
|
|
763
|
+
```
|
|
764
|
+
add_filter('fluent_cart/product/out_of_stock_button_text', function($text) {
|
|
765
|
+
return 'Currently Unavailable';
|
|
766
|
+
}, 10, 1);
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
### ` product/price_suffix_atts `
|
|
770
|
+
|
|
771
|
+
`fluent_cart/product/price_suffix_atts` — Filter the price suffix for product variations
|
|
772
|
+
|
|
773
|
+
**When it runs:** This filter is applied when rendering each variation item in the variation selector. The Tax module hooks into this filter to append a price suffix (e.g., "incl. tax") configured in tax settings.
|
|
774
|
+
|
|
775
|
+
**Parameters:**
|
|
776
|
+
|
|
777
|
+
- `$suffix` (string): The price suffix text. Default: `''` (empty string)
|
|
778
|
+
- `$data` (array): Context data
|
|
779
|
+
|
|
780
|
+
```
|
|
781
|
+
$data = [
|
|
782
|
+
'product' => $product, // Product model
|
|
783
|
+
'variant' => $variant, // ProductVariant model
|
|
784
|
+
'scope' => 'variant_item'
|
|
785
|
+
];
|
|
786
|
+
```
|
|
787
|
+
|
|
788
|
+
**Returns:**
|
|
789
|
+
|
|
790
|
+
- `$suffix` (string): The modified price suffix text
|
|
791
|
+
|
|
792
|
+
**Source:** `app/Services/Renderer/ProductRenderer.php:1408`
|
|
793
|
+
|
|
794
|
+
**Usage:**
|
|
795
|
+
|
|
796
|
+
```
|
|
797
|
+
add_filter('fluent_cart/product/price_suffix_atts', function($suffix, $data) {
|
|
798
|
+
// Add a custom price suffix
|
|
799
|
+
return ' incl. VAT';
|
|
800
|
+
}, 10, 2);
|
|
801
|
+
```
|
|
802
|
+
|
|
803
|
+
### ` product_short_description `
|
|
804
|
+
|
|
805
|
+
`fluent_cart/product_short_description` — Filter the product short description
|
|
806
|
+
|
|
807
|
+
**When it runs:** This filter is applied when rendering the short description section on the single product page, using the post excerpt as the default value.
|
|
808
|
+
|
|
809
|
+
**Parameters:**
|
|
810
|
+
|
|
811
|
+
- `$shortDescription` (string): The product short description (from `$post->post_excerpt`)
|
|
812
|
+
- `$data` (array): Context data (empty array)
|
|
813
|
+
|
|
814
|
+
**Returns:**
|
|
815
|
+
|
|
816
|
+
- `$shortDescription` (string): The modified short description (output via `wp_kses_post`)
|
|
817
|
+
|
|
818
|
+
**Source:** `app/Hooks/Handlers/TemplateLoader.php:26`
|
|
819
|
+
|
|
820
|
+
**Usage:**
|
|
821
|
+
|
|
822
|
+
```
|
|
823
|
+
add_filter('fluent_cart/product_short_description', function($shortDescription) {
|
|
824
|
+
// Append a disclaimer to all product short descriptions
|
|
825
|
+
return $shortDescription . '<p class="disclaimer">Prices subject to change.</p>';
|
|
826
|
+
}, 10, 1);
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
---
|
|
830
|
+
|
|
831
|
+
## Stock & Availability
|
|
832
|
+
|
|
833
|
+
### ` product_stock_availability `
|
|
834
|
+
|
|
835
|
+
`fluent_cart/product_stock_availability` — Filter product stock availability information
|
|
836
|
+
|
|
837
|
+
**When it runs:** This filter is applied when retrieving the stock availability data for a product from the `ProductDetail` model. It runs after the default availability is determined based on stock management settings and current stock levels.
|
|
838
|
+
|
|
839
|
+
**Parameters:**
|
|
840
|
+
|
|
841
|
+
- `$availability` (array): The stock availability data
|
|
842
|
+
|
|
843
|
+
```
|
|
844
|
+
// When stock is not managed:
|
|
845
|
+
$availability = [
|
|
846
|
+
'manage_stock' => false,
|
|
847
|
+
'availability' => 'In Stock',
|
|
848
|
+
'class' => 'in-stock',
|
|
849
|
+
'available_quantity' => null
|
|
850
|
+
];
|
|
851
|
+
|
|
852
|
+
// When stock is managed and available:
|
|
853
|
+
$availability = [
|
|
854
|
+
'manage_stock' => true,
|
|
855
|
+
'availability' => 'In Stock',
|
|
856
|
+
'class' => 'in-stock',
|
|
857
|
+
'available_quantity' => 25 // actual stock count
|
|
858
|
+
];
|
|
859
|
+
|
|
860
|
+
// When stock is managed and depleted:
|
|
861
|
+
$availability = [
|
|
862
|
+
'manage_stock' => true,
|
|
863
|
+
'availability' => 'Out of Stock',
|
|
864
|
+
'class' => 'out-of-stock',
|
|
865
|
+
'available_quantity' => 0
|
|
866
|
+
];
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
- `$data` (array): Context data
|
|
870
|
+
|
|
871
|
+
```
|
|
872
|
+
$data = [
|
|
873
|
+
'detail' => $productDetail, // ProductDetail model instance
|
|
874
|
+
'variation_id' => $variationId // Variation ID or null
|
|
875
|
+
];
|
|
876
|
+
```
|
|
877
|
+
|
|
878
|
+
**Returns:**
|
|
879
|
+
|
|
880
|
+
- `$availability` (array): The modified availability data
|
|
881
|
+
|
|
882
|
+
**Source:** `app/Models/ProductDetail.php:183`
|
|
883
|
+
|
|
884
|
+
**Usage:**
|
|
885
|
+
|
|
886
|
+
```
|
|
887
|
+
add_filter('fluent_cart/product_stock_availability', function($availability, $data) {
|
|
888
|
+
// Show "Low Stock" warning when fewer than 5 items remain
|
|
889
|
+
if ($availability['manage_stock'] && $availability['available_quantity'] > 0 && $availability['available_quantity'] < 5) {
|
|
890
|
+
$availability['availability'] = 'Only ' . $availability['available_quantity'] . ' left in stock!';
|
|
891
|
+
$availability['class'] = 'low-stock';
|
|
892
|
+
}
|
|
893
|
+
return $availability;
|
|
894
|
+
}, 10, 2);
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
---
|
|
898
|
+
|
|
899
|
+
## Product URLs & Templates
|
|
900
|
+
|
|
901
|
+
### ` price_class `
|
|
902
|
+
|
|
903
|
+
`fluent_cart/price_class` — Filter the price element CSS class
|
|
904
|
+
|
|
905
|
+
**When it runs:** This filter is applied when rendering the price paragraph element on the single product page template.
|
|
906
|
+
|
|
907
|
+
**Parameters:**
|
|
908
|
+
|
|
909
|
+
- `$class` (string): The CSS class for the price element. Default: `'price'`
|
|
910
|
+
|
|
911
|
+
**Returns:**
|
|
912
|
+
|
|
913
|
+
- `$class` (string): The modified CSS class string
|
|
914
|
+
|
|
915
|
+
**Source:** `app/Hooks/Handlers/TemplateLoader.php:40`
|
|
916
|
+
|
|
917
|
+
**Usage:**
|
|
918
|
+
|
|
919
|
+
```
|
|
920
|
+
add_filter('fluent_cart/price_class', function($class) {
|
|
921
|
+
// Add additional CSS classes to the price element
|
|
922
|
+
return 'price fct-custom-price';
|
|
923
|
+
}, 10, 1);
|
|
924
|
+
```
|
|
925
|
+
|
|
926
|
+
### ` front_url_slug `
|
|
927
|
+
|
|
928
|
+
`fluent_cart/front_url_slug` — Filter the product URL slug
|
|
929
|
+
|
|
930
|
+
**When it runs:** This filter is applied when registering the `fluent-products` custom post type, allowing you to change the URL slug used for product permalinks.
|
|
931
|
+
|
|
932
|
+
**Parameters:**
|
|
933
|
+
|
|
934
|
+
- `$slug` (string): The product URL slug. Default comes from store settings, typically `'item'`
|
|
935
|
+
- `$data` (array): Context data (empty array)
|
|
936
|
+
|
|
937
|
+
**Returns:**
|
|
938
|
+
|
|
939
|
+
- `$slug` (string): The modified URL slug
|
|
940
|
+
|
|
941
|
+
**Source:** `app/CPT/FluentProducts.php:171`
|
|
942
|
+
|
|
943
|
+
**Note:** After changing the slug, you must flush rewrite rules (visit Settings > Permalinks in WP admin) for the change to take effect.
|
|
944
|
+
|
|
945
|
+
**Usage:**
|
|
946
|
+
|
|
947
|
+
```
|
|
948
|
+
add_filter('fluent_cart/front_url_slug', function($slug) {
|
|
949
|
+
// Change product URLs from /item/product-name to /shop/product-name
|
|
950
|
+
return 'shop';
|
|
951
|
+
}, 10, 1);
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
### ` product_url_with_front `
|
|
955
|
+
|
|
956
|
+
`fluent_cart/product_url_with_front` — Filter whether the product URL includes the front base
|
|
957
|
+
|
|
958
|
+
**When it runs:** This filter is applied when registering the `fluent-products` custom post type, immediately after `fluent_cart/front_url_slug` resolves the slug. The value is passed as the `with_front` argument to WordPress's `rewrite` option, controlling whether the site's permalink front base (e.g. `/blog/`) is prepended to product URLs.
|
|
959
|
+
|
|
960
|
+
**Parameters:**
|
|
961
|
+
|
|
962
|
+
- `$withFront` (bool): Whether to prepend the permalink front base. Default: `true`
|
|
963
|
+
- `$data` (array): Context data
|
|
964
|
+
|
|
965
|
+
```
|
|
966
|
+
$data = [
|
|
967
|
+
'slug' => $urlSlug // The resolved product URL slug
|
|
968
|
+
];
|
|
969
|
+
```
|
|
970
|
+
|
|
971
|
+
**Returns:**
|
|
972
|
+
|
|
973
|
+
- `$withFront` (bool): The modified value
|
|
974
|
+
|
|
975
|
+
**Source:** `app/CPT/FluentProducts.php:172`
|
|
976
|
+
|
|
977
|
+
**Note:** After changing this value, flush rewrite rules by visiting Settings > Permalinks in the WordPress admin.
|
|
978
|
+
|
|
979
|
+
**Usage:**
|
|
980
|
+
|
|
981
|
+
```
|
|
982
|
+
add_filter('fluent_cart/product_url_with_front', function($withFront, $data) {
|
|
983
|
+
// Remove the permalink front base from product URLs
|
|
984
|
+
// e.g. /blog/products/my-item → /products/my-item
|
|
985
|
+
return false;
|
|
986
|
+
}, 10, 2);
|
|
987
|
+
```
|
|
988
|
+
|
|
989
|
+
### ` show_standalone_product_menu `
|
|
990
|
+
|
|
991
|
+
`fluent_cart/show_standalone_product_menu` — Filter whether to show a standalone Products menu in the WordPress admin
|
|
992
|
+
|
|
993
|
+
**When it runs:** This filter is applied during the `init` action when FluentCart registers the product custom post type. When enabled, a separate "Products" menu item appears in the WordPress admin sidebar.
|
|
994
|
+
|
|
995
|
+
**Parameters:**
|
|
996
|
+
|
|
997
|
+
- `$show` (bool): Whether to show the standalone menu. Default: `false`
|
|
998
|
+
|
|
999
|
+
**Returns:**
|
|
1000
|
+
|
|
1001
|
+
- `$show` (bool): The modified boolean value
|
|
1002
|
+
|
|
1003
|
+
**Source:** `app/CPT/FluentProducts.php:37`
|
|
1004
|
+
|
|
1005
|
+
**Usage:**
|
|
1006
|
+
|
|
1007
|
+
```
|
|
1008
|
+
add_filter('fluent_cart/show_standalone_product_menu', function($show) {
|
|
1009
|
+
// Show the standalone Products menu in WP admin
|
|
1010
|
+
return true;
|
|
1011
|
+
}, 10, 1);
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
### ` single_product_page/show_relevant_products `
|
|
1015
|
+
|
|
1016
|
+
`fluent_cart/single_product_page/show_relevant_products` — Filter whether to show related products on the single product page
|
|
1017
|
+
|
|
1018
|
+
**When it runs:** This filter is applied when rendering the single product page content, after checking the store setting `show_relevant_product_in_single_page`. When enabled, similar products are displayed below the main product content.
|
|
1019
|
+
|
|
1020
|
+
**Parameters:**
|
|
1021
|
+
|
|
1022
|
+
- `$show` (bool): Whether to show related products. Default comes from store settings
|
|
1023
|
+
- `$postId` (int): The current product post ID
|
|
1024
|
+
|
|
1025
|
+
**Returns:**
|
|
1026
|
+
|
|
1027
|
+
- `$show` (bool): The modified boolean value
|
|
1028
|
+
|
|
1029
|
+
**Source:** `app/Modules/Templating/TemplateActions.php:277`
|
|
1030
|
+
|
|
1031
|
+
**Usage:**
|
|
1032
|
+
|
|
1033
|
+
```
|
|
1034
|
+
add_filter('fluent_cart/single_product_page/show_relevant_products', function($show, $postId) {
|
|
1035
|
+
// Disable related products for specific product IDs
|
|
1036
|
+
$excludedIds = [100, 200, 300];
|
|
1037
|
+
if (in_array($postId, $excludedIds)) {
|
|
1038
|
+
return false;
|
|
1039
|
+
}
|
|
1040
|
+
return $show;
|
|
1041
|
+
}, 10, 2);
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1044
|
+
### ` related_products/query_args `
|
|
1045
|
+
|
|
1046
|
+
`fluent_cart/related_products/query_args` — Filter the `WP_Query` arguments used to build the related products list
|
|
1047
|
+
|
|
1048
|
+
**When it runs:** Applied inside `ShopResource::getSimilarProducts()`, after the default query arguments are assembled and the ordering (`orderby`/`order`, or the price-ordering `posts_clauses` filter) is resolved, but immediately before `new WP_Query($args)` runs. One code path backs all related-products surfaces, so this filter covers each of them: the `[fluent_cart_related_products]` shortcode, the related products block auto-appended to the single product page, the Related Product Gutenberg block, and the product REST endpoint's similar-products response.
|
|
1049
|
+
|
|
1050
|
+
Runs after price ordering is applied
|
|
1051
|
+
|
|
1052
|
+
When `config['order_by']` is a price sort, `applyPriceOrdering()` has already attached a `posts_clauses` filter by the time this filter runs. Setting `$args['orderby']`/`$args['order']` in that case will not override price ordering — that custom SQL still wins. This is a known limitation, not a bug.
|
|
1053
|
+
|
|
1054
|
+
**Parameters:**
|
|
1055
|
+
|
|
1056
|
+
- `$args` (array): The `WP_Query` arguments about to be used.
|
|
1057
|
+
|
|
1058
|
+
```
|
|
1059
|
+
$args = [
|
|
1060
|
+
'post_type' => $post->post_type,
|
|
1061
|
+
'post_status' => 'publish',
|
|
1062
|
+
'posts_per_page' => 6, // clamped 1-24, from $config['posts_per_page']
|
|
1063
|
+
'post__not_in' => [$id], // excludes the current product
|
|
1064
|
+
'tax_query' => $taxQuery,
|
|
1065
|
+
'fields' => 'ids',
|
|
1066
|
+
// 'orderby' / 'order' are present unless price ordering is active
|
|
1067
|
+
];
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
- `$context` (array): Read-only context, not applied to the query directly.
|
|
1071
|
+
|
|
1072
|
+
```
|
|
1073
|
+
$context = [
|
|
1074
|
+
'product_id' => $id, // int
|
|
1075
|
+
'post' => $post, // WP_Post
|
|
1076
|
+
'config' => $config, // array passed to getSimilarProducts()
|
|
1077
|
+
];
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
**Returns:**
|
|
1081
|
+
|
|
1082
|
+
- `$args` (array): The modified `WP_Query` arguments.
|
|
1083
|
+
|
|
1084
|
+
**Source:** `api/Resource/ShopResource.php:346-356`
|
|
1085
|
+
|
|
1086
|
+
**Usage:**
|
|
1087
|
+
|
|
1088
|
+
```
|
|
1089
|
+
// Exclude a specific product from every related-products surface
|
|
1090
|
+
add_filter('fluent_cart/related_products/query_args', function ($args, $context) {
|
|
1091
|
+
$args['post__not_in'][] = 1722;
|
|
1092
|
+
return $args;
|
|
1093
|
+
}, 10, 2);
|
|
1094
|
+
```
|
|
1095
|
+
|
|
1096
|
+
```
|
|
1097
|
+
// Exclude multiple products
|
|
1098
|
+
add_filter('fluent_cart/related_products/query_args', function ($args) {
|
|
1099
|
+
$args['post__not_in'] = array_merge($args['post__not_in'], [1722, 1692]);
|
|
1100
|
+
return $args;
|
|
1101
|
+
}, 10, 2);
|
|
1102
|
+
```
|
|
1103
|
+
|
|
1104
|
+
Related
|
|
1105
|
+
|
|
1106
|
+
See [`single_product_page/show_relevant_products`](#single-product-page-show-relevant-products) to toggle related products on/off instead of changing the query.
|
|
1107
|
+
|
|
1108
|
+
### ` disable_auto_single_product_page `
|
|
1109
|
+
|
|
1110
|
+
`fluent_cart/disable_auto_single_product_page` — Disable automatic single product page rendering
|
|
1111
|
+
|
|
1112
|
+
**When it runs:** This filter is applied in two places: when filtering the post title and when filtering the post content for single product pages. When it returns `true`, FluentCart will not automatically inject product rendering into the default product page, allowing you to build the product page entirely with custom templates or page builders.
|
|
1113
|
+
|
|
1114
|
+
**Parameters:**
|
|
1115
|
+
|
|
1116
|
+
- `$disable` (bool): Whether to disable automatic rendering. Default: `false`
|
|
1117
|
+
|
|
1118
|
+
**Returns:**
|
|
1119
|
+
|
|
1120
|
+
- `$disable` (bool): The modified boolean value
|
|
1121
|
+
|
|
1122
|
+
**Source:** `app/Modules/Templating/TemplateActions.php:191,215`
|
|
1123
|
+
|
|
1124
|
+
**Usage:**
|
|
1125
|
+
|
|
1126
|
+
```
|
|
1127
|
+
add_filter('fluent_cart/disable_auto_single_product_page', function($disable) {
|
|
1128
|
+
// Disable auto-rendering when using a custom page builder
|
|
1129
|
+
if (class_exists('Elementor\Plugin')) {
|
|
1130
|
+
return true;
|
|
1131
|
+
}
|
|
1132
|
+
return $disable;
|
|
1133
|
+
}, 10, 1);
|
|
1134
|
+
```
|
|
1135
|
+
|
|
1136
|
+
---
|
|
1137
|
+
|
|
1138
|
+
## Coupons
|
|
1139
|
+
|
|
1140
|
+
### ` coupon/validating_coupon `
|
|
1141
|
+
|
|
1142
|
+
`fluent_cart/coupon/validating_coupon` — Filter the coupon code during validation
|
|
1143
|
+
|
|
1144
|
+
**When it runs:** This filter is applied at the very beginning of coupon validation, before the coupon is looked up in the database. You can modify the coupon code string or return a `WP_Error` to reject it early.
|
|
1145
|
+
|
|
1146
|
+
**Parameters:**
|
|
1147
|
+
|
|
1148
|
+
- `$couponCode` (string): The coupon code being validated
|
|
1149
|
+
- `$data` (array): Context data
|
|
1150
|
+
|
|
1151
|
+
```
|
|
1152
|
+
$data = [
|
|
1153
|
+
'coupon_code' => $couponCode, // Original coupon code
|
|
1154
|
+
'line_items' => $lineItems, // Cart line items
|
|
1155
|
+
'couponService' => $couponService // CouponService instance
|
|
1156
|
+
];
|
|
1157
|
+
```
|
|
1158
|
+
|
|
1159
|
+
**Returns:**
|
|
1160
|
+
|
|
1161
|
+
- `$couponCode` (string|WP_Error): The modified coupon code, or a `WP_Error` to reject
|
|
1162
|
+
|
|
1163
|
+
**Source:** `app/Services/Coupon/Concerns/CanValidateCoupon.php:21`
|
|
1164
|
+
|
|
1165
|
+
**Usage:**
|
|
1166
|
+
|
|
1167
|
+
```
|
|
1168
|
+
add_filter('fluent_cart/coupon/validating_coupon', function($couponCode, $data) {
|
|
1169
|
+
// Normalize coupon codes to uppercase
|
|
1170
|
+
$couponCode = strtoupper(trim($couponCode));
|
|
1171
|
+
|
|
1172
|
+
// Block specific coupon codes
|
|
1173
|
+
$blockedCodes = ['EXPIRED2024', 'TESTONLY'];
|
|
1174
|
+
if (in_array($couponCode, $blockedCodes)) {
|
|
1175
|
+
return new \WP_Error('coupon_blocked', __('This coupon code is no longer valid.', 'fluent-cart'));
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
return $couponCode;
|
|
1179
|
+
}, 10, 2);
|
|
1180
|
+
```
|
|
1181
|
+
|
|
1182
|
+
### ` coupon/can_use_coupon `
|
|
1183
|
+
|
|
1184
|
+
`fluent_cart/coupon/can_use_coupon` — Filter whether a coupon can be used
|
|
1185
|
+
|
|
1186
|
+
**When it runs:** This filter is applied after the coupon has been validated and found in the database, but before the discount is calculated. It allows you to add custom eligibility checks.
|
|
1187
|
+
|
|
1188
|
+
**Parameters:**
|
|
1189
|
+
|
|
1190
|
+
- `$canUse` (bool): Whether the coupon can be used. Default: `true`
|
|
1191
|
+
- `$data` (array): Context data
|
|
1192
|
+
|
|
1193
|
+
```
|
|
1194
|
+
$data = [
|
|
1195
|
+
'coupon' => $coupon, // Coupon model instance
|
|
1196
|
+
'cart' => $cart, // Cart model instance
|
|
1197
|
+
'cart_items' => $cartItems // Array of cart item data
|
|
1198
|
+
];
|
|
1199
|
+
```
|
|
1200
|
+
|
|
1201
|
+
**Returns:**
|
|
1202
|
+
|
|
1203
|
+
- `$canUse` (bool|WP_Error): `true` to allow, `false` or `WP_Error` to reject. When a `WP_Error` is returned, its message is shown to the customer
|
|
1204
|
+
|
|
1205
|
+
**Source:** `app/Services/Coupon/DiscountService.php:299`
|
|
1206
|
+
|
|
1207
|
+
**Usage:**
|
|
1208
|
+
|
|
1209
|
+
```
|
|
1210
|
+
add_filter('fluent_cart/coupon/can_use_coupon', function($canUse, $data) {
|
|
1211
|
+
$coupon = $data['coupon'];
|
|
1212
|
+
$cart = $data['cart'];
|
|
1213
|
+
|
|
1214
|
+
// Require a minimum cart subtotal of $50 (5000 cents)
|
|
1215
|
+
if ($cart->sub_total < 5000) {
|
|
1216
|
+
return new \WP_Error(
|
|
1217
|
+
'coupon_min_total',
|
|
1218
|
+
__('This coupon requires a minimum order of $50.', 'fluent-cart')
|
|
1219
|
+
);
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
return $canUse;
|
|
1223
|
+
}, 10, 2);
|
|
1224
|
+
```
|
|
1225
|
+
|
|
1226
|
+
### ` coupon/will_skip_item `
|
|
1227
|
+
|
|
1228
|
+
`fluent_cart/coupon/will_skip_item` — Filter whether an item should be skipped from coupon discount
|
|
1229
|
+
|
|
1230
|
+
**When it runs:** This filter is applied for each cart item when filtering applicable items for a coupon discount. Returning `true` excludes the item from the coupon discount calculation.
|
|
1231
|
+
|
|
1232
|
+
**Parameters:**
|
|
1233
|
+
|
|
1234
|
+
- `$willSkip` (bool): Whether to skip this item. Default: `false`
|
|
1235
|
+
- `$data` (array): Context data
|
|
1236
|
+
|
|
1237
|
+
```
|
|
1238
|
+
$data = [
|
|
1239
|
+
'item' => $item, // Cart item array data
|
|
1240
|
+
'coupon' => $coupon, // Coupon model instance
|
|
1241
|
+
'cart' => $cart // Cart model instance
|
|
1242
|
+
];
|
|
1243
|
+
```
|
|
1244
|
+
|
|
1245
|
+
**Returns:**
|
|
1246
|
+
|
|
1247
|
+
- `$willSkip` (bool): `true` to exclude the item from the coupon, `false` to include it
|
|
1248
|
+
|
|
1249
|
+
**Source:** `app/Services/Coupon/DiscountService.php:321`
|
|
1250
|
+
|
|
1251
|
+
**Usage:**
|
|
1252
|
+
|
|
1253
|
+
```
|
|
1254
|
+
add_filter('fluent_cart/coupon/will_skip_item', function($willSkip, $data) {
|
|
1255
|
+
$item = $data['item'];
|
|
1256
|
+
|
|
1257
|
+
// Never apply coupons to gift card items
|
|
1258
|
+
if (!empty($item['product_type']) && $item['product_type'] === 'gift_card') {
|
|
1259
|
+
return true;
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
return $willSkip;
|
|
1263
|
+
}, 10, 2);
|
|
1264
|
+
```
|
|
1265
|
+
|
|
1266
|
+
### ` coupon/per_customer_usage_query `
|
|
1267
|
+
|
|
1268
|
+
`fluent_cart/coupon/per_customer_usage_query` — Filter the per-customer coupon usage query
|
|
1269
|
+
|
|
1270
|
+
**When it runs:** This filter is applied when checking if a customer has exceeded the per-customer usage limit for a coupon. It allows you to modify the query that counts previous uses.
|
|
1271
|
+
|
|
1272
|
+
**Parameters:**
|
|
1273
|
+
|
|
1274
|
+
- `$usageQuery` (Builder): The Eloquent query builder for [`AppliedCoupon`](/database/models/applied-coupon.md) records, already filtered by coupon ID and customer ID
|
|
1275
|
+
- `$data` (array): Context data
|
|
1276
|
+
|
|
1277
|
+
```
|
|
1278
|
+
$data = [
|
|
1279
|
+
'coupon' => $coupon, // Coupon model instance
|
|
1280
|
+
'customer' => $customer, // Customer model instance
|
|
1281
|
+
'cart' => $cart // Cart model instance
|
|
1282
|
+
];
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
**Returns:**
|
|
1286
|
+
|
|
1287
|
+
- `$usageQuery` (Builder): The modified query builder
|
|
1288
|
+
|
|
1289
|
+
**Source:** `app/Services/Coupon/DiscountService.php:729`
|
|
1290
|
+
|
|
1291
|
+
**Usage:**
|
|
1292
|
+
|
|
1293
|
+
```
|
|
1294
|
+
add_filter('fluent_cart/coupon/per_customer_usage_query', function($usageQuery, $data) {
|
|
1295
|
+
// Only count usage from the last 30 days (rolling usage limit)
|
|
1296
|
+
$usageQuery->where('created_at', '>=', gmdate('Y-m-d H:i:s', strtotime('-30 days')));
|
|
1297
|
+
return $usageQuery;
|
|
1298
|
+
}, 10, 2);
|
|
1299
|
+
```
|
|
1300
|
+
|
|
1301
|
+
### ` coupon/resolve_coupons `
|
|
1302
|
+
|
|
1303
|
+
`fluent_cart/coupon/resolve_coupons` — Filter the coupons resolved for a cart or order
|
|
1304
|
+
|
|
1305
|
+
**When it runs:** This filter is applied everywhere FluentCart resolves the [Coupon](/database/models/coupon.md) records that back a cart's or order's applied discount codes — on `Cart`, in `CheckoutProcessor` (when rebuilding an order from stored `coupon_codes`), and in `DiscountService::apply()`. It receives the coupons already found in the database plus the originally requested codes, and may append additional, unsaved `Coupon` model instances (e.g. representing a dynamic-pricing discount) so they appear in the cart/order's discount summary like any real coupon.
|
|
1306
|
+
|
|
1307
|
+
**Parameters:**
|
|
1308
|
+
|
|
1309
|
+
- `$coupons` (Collection): The DB-found [Coupon](/database/models/coupon.md) models
|
|
1310
|
+
- `$codes` (array): The originally requested coupon code strings
|
|
1311
|
+
- `$context` (array): Context data — the key differs by call site
|
|
1312
|
+
|
|
1313
|
+
```
|
|
1314
|
+
// From Cart::getAppliedCoupons() / DiscountService::apply()
|
|
1315
|
+
$context = ['cart' => $cart];
|
|
1316
|
+
|
|
1317
|
+
// From CheckoutProcessor (rebuilding an order)
|
|
1318
|
+
$context = ['order' => $orderModel];
|
|
1319
|
+
```
|
|
1320
|
+
|
|
1321
|
+
**Returns:**
|
|
1322
|
+
|
|
1323
|
+
- `Collection` — The modified collection of Coupon models (DB-found coupons plus any synthetic ones appended by a listener)
|
|
1324
|
+
|
|
1325
|
+
**Source:** `app/Services/Coupon/DiscountService.php:96`, `app/Models/Cart.php:767`, `app/Helpers/CheckoutProcessor.php:572`
|
|
1326
|
+
|
|
1327
|
+
**Usage:**
|
|
1328
|
+
|
|
1329
|
+
```
|
|
1330
|
+
add_filter('fluent_cart/coupon/resolve_coupons', function($coupons, $codes, $context) {
|
|
1331
|
+
// Surface a computed loyalty discount as a synthetic, unsaved coupon
|
|
1332
|
+
if (in_array('LOYALTY10', $codes, true)) {
|
|
1333
|
+
$loyaltyCoupon = new \FluentCart\App\Models\Coupon([
|
|
1334
|
+
'code' => 'LOYALTY10',
|
|
1335
|
+
'discount_type' => 'percent',
|
|
1336
|
+
'amount' => 10,
|
|
1337
|
+
]);
|
|
1338
|
+
$coupons->push($loyaltyCoupon);
|
|
1339
|
+
}
|
|
1340
|
+
return $coupons;
|
|
1341
|
+
}, 10, 3);
|
|
1342
|
+
```
|
|
1343
|
+
|
|
1344
|
+
### ` discount/pre_apply `
|
|
1345
|
+
|
|
1346
|
+
`fluent_cart/discount/pre_apply` — Filter the cart items before a coupon discount is applied
|
|
1347
|
+
|
|
1348
|
+
**When it runs:** This filter is applied at the start of `DiscountService::apply()`, before checking whether the coupon can be used and before the discount is calculated. It lets you adjust which items (and their data) the coupon will be evaluated and applied against.
|
|
1349
|
+
|
|
1350
|
+
**Parameters:**
|
|
1351
|
+
|
|
1352
|
+
- `$cartItems` (array): The cart line items
|
|
1353
|
+
- `$data` (array): Context data
|
|
1354
|
+
|
|
1355
|
+
```
|
|
1356
|
+
$data = [
|
|
1357
|
+
'coupon' => $coupon, // Coupon model instance being applied
|
|
1358
|
+
'cart' => $cart, // Cart model instance
|
|
1359
|
+
];
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
**Returns:**
|
|
1363
|
+
|
|
1364
|
+
- `$cartItems` (array): The modified cart items array
|
|
1365
|
+
|
|
1366
|
+
**Source:** `app/Services/Coupon/DiscountService.php:227`
|
|
1367
|
+
|
|
1368
|
+
**Usage:**
|
|
1369
|
+
|
|
1370
|
+
```
|
|
1371
|
+
add_filter('fluent_cart/discount/pre_apply', function($cartItems, $data) {
|
|
1372
|
+
// Exclude gift-card items from ever being eligible for a coupon
|
|
1373
|
+
return array_filter($cartItems, function ($item) {
|
|
1374
|
+
return ($item['product_type'] ?? '') !== 'gift_card';
|
|
1375
|
+
});
|
|
1376
|
+
}, 10, 2);
|
|
1377
|
+
```
|
|
1378
|
+
|
|
1379
|
+
### ` coupon_statuses `
|
|
1380
|
+
|
|
1381
|
+
`fluent_cart/coupon_statuses` — Filter the available coupon statuses
|
|
1382
|
+
|
|
1383
|
+
**When it runs:** Applied by `Helper::getCouponStatuses()` to the default coupon status map, and returns its result.
|
|
1384
|
+
|
|
1385
|
+
**Parameters:**
|
|
1386
|
+
|
|
1387
|
+
- `$statuses` (array): Array of coupon statuses (key => label)
|
|
1388
|
+
|
|
1389
|
+
```
|
|
1390
|
+
$statuses = [
|
|
1391
|
+
'active' => 'Active',
|
|
1392
|
+
'expired' => 'Expired',
|
|
1393
|
+
'disabled' => 'Disabled',
|
|
1394
|
+
];
|
|
1395
|
+
```
|
|
1396
|
+
|
|
1397
|
+
- `$data` (array): Context data (empty array)
|
|
1398
|
+
|
|
1399
|
+
**Returns:**
|
|
1400
|
+
|
|
1401
|
+
- `$statuses` (array): The modified coupon statuses array
|
|
1402
|
+
|
|
1403
|
+
**Source:** `app/Helpers/Helper.php:1014`
|
|
1404
|
+
|
|
1405
|
+
**Usage:**
|
|
1406
|
+
|
|
1407
|
+
```
|
|
1408
|
+
add_filter('fluent_cart/coupon_statuses', function($statuses) {
|
|
1409
|
+
$statuses['scheduled'] = __('Scheduled', 'fluent-cart');
|
|
1410
|
+
return $statuses;
|
|
1411
|
+
}, 10, 1);
|
|
1412
|
+
```
|
|
1413
|
+
|
|
1414
|
+
---
|
|
1415
|
+
|
|
1416
|
+
## Variant Options & Attributes
|
|
1417
|
+
|
|
1418
|
+
### ` attribute_groups/max_reorder `
|
|
1419
|
+
|
|
1420
|
+
`fluent_cart/attribute_groups/max_reorder` — Filter the maximum number of attribute groups allowed in one reorder request
|
|
1421
|
+
|
|
1422
|
+
**When it runs:** This filter is applied in the attribute groups reorder endpoint, before checking the submitted ID list against the cap. The attribute-group library is a small, admin-managed set, so the cap bounds a `whereIn` ownership lookup rather than reflecting a realistic catalog size.
|
|
1423
|
+
|
|
1424
|
+
**Parameters:**
|
|
1425
|
+
|
|
1426
|
+
- `$maxGroups` (int): The maximum reorder batch size. Default: `500`
|
|
1427
|
+
|
|
1428
|
+
**Returns:**
|
|
1429
|
+
|
|
1430
|
+
- `int` — The modified maximum
|
|
1431
|
+
|
|
1432
|
+
**Source:** `app/Http/Controllers/AttributesController.php:205`
|
|
1433
|
+
|
|
1434
|
+
**Usage:**
|
|
1435
|
+
|
|
1436
|
+
```
|
|
1437
|
+
add_filter('fluent_cart/attribute_groups/max_reorder', function($maxGroups) {
|
|
1438
|
+
// Raise the cap for a store with an unusually large attribute library
|
|
1439
|
+
return 2000;
|
|
1440
|
+
}, 10, 1);
|
|
1441
|
+
```
|
|
1442
|
+
|
|
1443
|
+
### ` item_attributes `
|
|
1444
|
+
|
|
1445
|
+
`fluent_cart/item_attributes` — Filter the resolved attribute rows for a product variation
|
|
1446
|
+
|
|
1447
|
+
**When it runs:** This filter is applied by `AttributeHelper::getProductItemAttributes()` after resolving a variation's system attributes, letting a third-party plugin append its own attribute entries. A batched sibling call resolves attributes for many variations at once with a single query and applies the same filter per variation.
|
|
1448
|
+
|
|
1449
|
+
**Parameters:**
|
|
1450
|
+
|
|
1451
|
+
- `$atts` (array): The resolved attribute rows, keyed by attribute slug
|
|
1452
|
+
- `$data` (array): Context data
|
|
1453
|
+
|
|
1454
|
+
```
|
|
1455
|
+
$data = [
|
|
1456
|
+
'variation_id' => 42, // int
|
|
1457
|
+
'product_id' => 10, // int
|
|
1458
|
+
];
|
|
1459
|
+
```
|
|
1460
|
+
|
|
1461
|
+
**Returns:**
|
|
1462
|
+
|
|
1463
|
+
- `$atts` (array): The modified attribute rows. Third-party attributes are conventionally appended without FluentCart's `pa_` system-attribute prefix, keyed by the provider's own group slug.
|
|
1464
|
+
|
|
1465
|
+
**Source:** `app/Helpers/AttributeHelper.php:138,191`
|
|
1466
|
+
|
|
1467
|
+
**Usage:**
|
|
1468
|
+
|
|
1469
|
+
```
|
|
1470
|
+
add_filter('fluent_cart/item_attributes', function($atts, $data) {
|
|
1471
|
+
$atts['warranty'] = [
|
|
1472
|
+
'slug' => 'warranty',
|
|
1473
|
+
'value' => '2-Year Extended Warranty',
|
|
1474
|
+
];
|
|
1475
|
+
return $atts;
|
|
1476
|
+
}, 10, 2);
|
|
1477
|
+
```
|
|
1478
|
+
|
|
1479
|
+
### ` item_display_attr `
|
|
1480
|
+
|
|
1481
|
+
`fluent_cart/item_display_attr` — Filter the display-ready attribute rows for a line item
|
|
1482
|
+
|
|
1483
|
+
**When it runs:** This filter is applied after building the display rows for an item's attributes (cart line item, order item, etc.), before rows with an empty `display_value` are stripped out.
|
|
1484
|
+
|
|
1485
|
+
**Parameters:**
|
|
1486
|
+
|
|
1487
|
+
- `$displayAtts` (array): Display attribute rows, each shaped like:
|
|
1488
|
+
|
|
1489
|
+
```
|
|
1490
|
+
$displayAtts = [
|
|
1491
|
+
'color' => [
|
|
1492
|
+
'display_title' => 'Color',
|
|
1493
|
+
'attr_key' => 'color',
|
|
1494
|
+
'slug' => 'red',
|
|
1495
|
+
'display_value' => 'Red',
|
|
1496
|
+
'is_system' => true,
|
|
1497
|
+
],
|
|
1498
|
+
// ...
|
|
1499
|
+
];
|
|
1500
|
+
```
|
|
1501
|
+
|
|
1502
|
+
- `$data` (array): Context data
|
|
1503
|
+
|
|
1504
|
+
```
|
|
1505
|
+
$data = [
|
|
1506
|
+
'item' => $item, // the item array being described
|
|
1507
|
+
'scope' => $scope, // where this is being rendered (e.g. cart, order)
|
|
1508
|
+
];
|
|
1509
|
+
```
|
|
1510
|
+
|
|
1511
|
+
**Returns:**
|
|
1512
|
+
|
|
1513
|
+
- `$displayAtts` (array): The modified rows. A row that resolves to an empty `display_value` is dropped afterward, so a listener can opt an attribute out by clearing that key.
|
|
1514
|
+
|
|
1515
|
+
**Source:** `app/Helpers/AttributeHelper.php:346`
|
|
1516
|
+
|
|
1517
|
+
**Usage:**
|
|
1518
|
+
|
|
1519
|
+
```
|
|
1520
|
+
add_filter('fluent_cart/item_display_attr', function($displayAtts, $data) {
|
|
1521
|
+
// Suppress an internal-only attribute from customer-facing display
|
|
1522
|
+
unset($displayAtts['internal_sku']);
|
|
1523
|
+
return $displayAtts;
|
|
1524
|
+
}, 10, 2);
|
|
1525
|
+
```
|
|
1526
|
+
|
|
1527
|
+
### ` item_display_attr_string `
|
|
1528
|
+
|
|
1529
|
+
`fluent_cart/item_display_attr_string` — Filter the combined attribute display string for a line item
|
|
1530
|
+
|
|
1531
|
+
**When it runs:** This filter is applied after building the default comma/separator-joined attribute string (e.g. `"Color: Red, Size: L"`) for an item, letting an integrator rebuild the combination text in a custom format using the resolved rows it also receives.
|
|
1532
|
+
|
|
1533
|
+
**Parameters:**
|
|
1534
|
+
|
|
1535
|
+
- `$displayTitleString` (string): The default joined attribute string
|
|
1536
|
+
- `$data` (array): Context data
|
|
1537
|
+
|
|
1538
|
+
```
|
|
1539
|
+
$data = [
|
|
1540
|
+
'display_atts' => $displayAtts, // the resolved display rows (see fluent_cart/item_display_attr)
|
|
1541
|
+
'item' => $item,
|
|
1542
|
+
'scope' => $scope,
|
|
1543
|
+
'separator' => $separator, // the default separator string
|
|
1544
|
+
];
|
|
1545
|
+
```
|
|
1546
|
+
|
|
1547
|
+
**Returns:**
|
|
1548
|
+
|
|
1549
|
+
- `$displayTitleString` (string): The modified string
|
|
1550
|
+
|
|
1551
|
+
**Source:** `app/Helpers/AttributeHelper.php:418`
|
|
1552
|
+
|
|
1553
|
+
**Usage:**
|
|
1554
|
+
|
|
1555
|
+
```
|
|
1556
|
+
add_filter('fluent_cart/item_display_attr_string', function($displayTitleString, $data) {
|
|
1557
|
+
// Render each attribute on its own line instead of comma-separated
|
|
1558
|
+
return implode("\n", array_map(function ($attr) {
|
|
1559
|
+
return $attr['display_title'] . ': ' . $attr['display_value'];
|
|
1560
|
+
}, $data['display_atts']));
|
|
1561
|
+
}, 10, 2);
|
|
1562
|
+
```
|
|
1563
|
+
|
|
1564
|
+
### ` item_display_attr_{$key} `
|
|
1565
|
+
|
|
1566
|
+
`fluent_cart/item_display_attr_{$key}` — Filter one third-party attribute's display row
|
|
1567
|
+
|
|
1568
|
+
**When it runs:** This dynamic filter is applied once per non-system (third-party) attribute found on an item, right before it's added into the `$displayAtts` array consumed by `fluent_cart/item_display_attr`. The `{$key}` portion is the attribute's array key (its slug), letting a provider shape only the row(s) it owns.
|
|
1569
|
+
|
|
1570
|
+
**Parameters:**
|
|
1571
|
+
|
|
1572
|
+
- `$row` (array): The default display row for this attribute
|
|
1573
|
+
|
|
1574
|
+
```
|
|
1575
|
+
$row = [
|
|
1576
|
+
'display_title' => $key, // defaults to the raw key
|
|
1577
|
+
'attr_key' => $key,
|
|
1578
|
+
'slug' => $value['slug'] ?? $key,
|
|
1579
|
+
'display_value' => $value['value'] ?? '',
|
|
1580
|
+
'is_system' => false,
|
|
1581
|
+
];
|
|
1582
|
+
```
|
|
1583
|
+
|
|
1584
|
+
- `$data` (array): Context data
|
|
1585
|
+
|
|
1586
|
+
```
|
|
1587
|
+
$data = [
|
|
1588
|
+
'attr' => $value, // the raw attribute value array for this key
|
|
1589
|
+
'item' => $item,
|
|
1590
|
+
'scope' => $scope,
|
|
1591
|
+
];
|
|
1592
|
+
```
|
|
1593
|
+
|
|
1594
|
+
**Returns:**
|
|
1595
|
+
|
|
1596
|
+
- `$row` (array): The modified display row. Return an empty `display_value` to have the row dropped by `fluent_cart/item_display_attr`.
|
|
1597
|
+
|
|
1598
|
+
**Source:** `app/Helpers/AttributeHelper.php:333`
|
|
1599
|
+
|
|
1600
|
+
**Usage:**
|
|
1601
|
+
|
|
1602
|
+
```
|
|
1603
|
+
add_filter('fluent_cart/item_display_attr_warranty', function($row, $data) {
|
|
1604
|
+
$row['display_title'] = __('Warranty', 'my-addon');
|
|
1605
|
+
return $row;
|
|
1606
|
+
}, 10, 2);
|
|
1607
|
+
```
|
|
1608
|
+
|
|
1609
|
+
### ` product/variant_option_payload `
|
|
1610
|
+
|
|
1611
|
+
`fluent_cart/product/variant_option_payload` — Filter/pre-process the variant-option sync payload
|
|
1612
|
+
|
|
1613
|
+
**When it runs:** This filter is applied at the start of `ProductResource::syncVariantOption()`, before the submitted variant-option data is written. It lets an integrator transform the incoming payload before core processing runs.
|
|
1614
|
+
|
|
1615
|
+
**Parameters:**
|
|
1616
|
+
|
|
1617
|
+
- `$payload` (array): The sync request
|
|
1618
|
+
|
|
1619
|
+
```
|
|
1620
|
+
$payload = [
|
|
1621
|
+
'product_id' => 10, // int
|
|
1622
|
+
'data' => $data, // array, the raw submitted variant-option data
|
|
1623
|
+
];
|
|
1624
|
+
```
|
|
1625
|
+
|
|
1626
|
+
**Returns:**
|
|
1627
|
+
|
|
1628
|
+
- `$payload` (array): Must include a `'data'` key to be accepted; if the returned value is not an array or has no `'data'` key, the original `$productId`/`$data` are used instead
|
|
1629
|
+
|
|
1630
|
+
**Source:** `api/Resource/ProductResource.php:569`
|
|
1631
|
+
|
|
1632
|
+
**Usage:**
|
|
1633
|
+
|
|
1634
|
+
```
|
|
1635
|
+
add_filter('fluent_cart/product/variant_option_payload', function($payload) {
|
|
1636
|
+
// Normalize option labels to title case before they're synced
|
|
1637
|
+
if (!empty($payload['data']['label'])) {
|
|
1638
|
+
$payload['data']['label'] = ucwords($payload['data']['label']);
|
|
1639
|
+
}
|
|
1640
|
+
return $payload;
|
|
1641
|
+
}, 10, 1);
|
|
1642
|
+
```
|
|
1643
|
+
|
|
1644
|
+
### ` product/variant_option_sync `
|
|
1645
|
+
|
|
1646
|
+
`fluent_cart/product/variant_option_sync` — Let an add-on take over a variant-option sync request
|
|
1647
|
+
|
|
1648
|
+
**When it runs:** This filter is applied in `ProductResource::syncVariantOption()`, immediately after `fluent_cart/product/variant_option_payload` has pre-processed the payload. It's a short-circuit hook: if a listener marks the result `handled`, FluentCart's own sync logic never runs and the listener's `response` is returned as-is.
|
|
1649
|
+
|
|
1650
|
+
**Parameters:**
|
|
1651
|
+
|
|
1652
|
+
- `$result` (array): Sync state
|
|
1653
|
+
|
|
1654
|
+
```
|
|
1655
|
+
$result = [
|
|
1656
|
+
'product_id' => 10, // int
|
|
1657
|
+
'data' => $data, // array, the (possibly pre-processed) payload
|
|
1658
|
+
'handled' => false, // set true to short-circuit core handling
|
|
1659
|
+
'response' => null, // the value returned to the caller when handled
|
|
1660
|
+
];
|
|
1661
|
+
```
|
|
1662
|
+
|
|
1663
|
+
**Returns:**
|
|
1664
|
+
|
|
1665
|
+
- `$result` (array): The same shape back
|
|
1666
|
+
|
|
1667
|
+
**Source:** `api/Resource/ProductResource.php:578`
|
|
1668
|
+
|
|
1669
|
+
**Usage:**
|
|
1670
|
+
|
|
1671
|
+
```
|
|
1672
|
+
add_filter('fluent_cart/product/variant_option_sync', function($result) {
|
|
1673
|
+
if (($result['data']['type'] ?? null) === 'my_custom_option_type') {
|
|
1674
|
+
$result['response'] = my_addon_sync_option($result['product_id'], $result['data']);
|
|
1675
|
+
$result['handled'] = true;
|
|
1676
|
+
}
|
|
1677
|
+
return $result;
|
|
1678
|
+
}, 10, 1);
|
|
1679
|
+
```
|
|
1680
|
+
|
|
1681
|
+
### ` product/variant_save_data `
|
|
1682
|
+
|
|
1683
|
+
`fluent_cart/product/variant_save_data` — Filter a single variant's data before a batch save
|
|
1684
|
+
|
|
1685
|
+
**When it runs:** This filter is applied once per variant while building the batch-update payload for a product's variants, immediately before the batch write runs inside a transaction.
|
|
1686
|
+
|
|
1687
|
+
**Parameters:**
|
|
1688
|
+
|
|
1689
|
+
- `$variant` (array): The variant's field data about to be saved
|
|
1690
|
+
- `$postId` (int): The product's post ID
|
|
1691
|
+
|
|
1692
|
+
**Returns:**
|
|
1693
|
+
|
|
1694
|
+
- `$variant` (array): The modified variant data
|
|
1695
|
+
|
|
1696
|
+
**Source:** `api/Resource/ProductResource.php:281`
|
|
1697
|
+
|
|
1698
|
+
**Usage:**
|
|
1699
|
+
|
|
1700
|
+
```
|
|
1701
|
+
add_filter('fluent_cart/product/variant_save_data', function($variant, $postId) {
|
|
1702
|
+
// Ensure a minimum price of $1.00 (100 cents) on every variant save
|
|
1703
|
+
if (isset($variant['item_price']) && $variant['item_price'] < 100) {
|
|
1704
|
+
$variant['item_price'] = 100;
|
|
1705
|
+
}
|
|
1706
|
+
return $variant;
|
|
1707
|
+
}, 10, 2);
|
|
1708
|
+
```
|
|
1709
|
+
|
|
1710
|
+
---
|
|
1711
|
+
|
|
1712
|
+
## Statuses & Types
|
|
1713
|
+
|
|
1714
|
+
### ` product_statuses `
|
|
1715
|
+
|
|
1716
|
+
`fluent_cart/product_statuses` — Filter the available product statuses
|
|
1717
|
+
|
|
1718
|
+
**When it runs:** This filter is applied in `Status::getProductStatuses()`. **Note:** in the current source, the `apply_filters()` call is inside a `return` statement that executes before the method's `$withLabel` check, so the filtered, label-keyed array is always returned — the `$withLabel = false` code path below it is currently unreachable.
|
|
1719
|
+
|
|
1720
|
+
**Parameters:**
|
|
1721
|
+
|
|
1722
|
+
- `$statuses` (array): The product statuses, keyed by status constant
|
|
1723
|
+
|
|
1724
|
+
```
|
|
1725
|
+
$statuses = [
|
|
1726
|
+
'publish' => __('Publish', 'fluent-cart'), // Status::PRODUCT_PUBLISH
|
|
1727
|
+
'draft' => __('Draft', 'fluent-cart'), // Status::PRODUCT_DRAFT
|
|
1728
|
+
'private' => __('Private', 'fluent-cart'), // Status::PRODUCT_PRIVATE
|
|
1729
|
+
'future' => __('Scheduled', 'fluent-cart'), // Status::PRODUCT_FUTURE
|
|
1730
|
+
'trash' => __('Trashed', 'fluent-cart'), // Status::PRODUCT_TRASH
|
|
1731
|
+
];
|
|
1732
|
+
```
|
|
1733
|
+
|
|
1734
|
+
- `$data` (array): Context data (empty array)
|
|
1735
|
+
|
|
1736
|
+
**Returns:**
|
|
1737
|
+
|
|
1738
|
+
- `$statuses` (array): The modified statuses array
|
|
1739
|
+
|
|
1740
|
+
**Source:** `app/Helpers/Status.php:115`
|
|
1741
|
+
|
|
1742
|
+
**Usage:**
|
|
1743
|
+
|
|
1744
|
+
```
|
|
1745
|
+
add_filter('fluent_cart/product_statuses', function($statuses) {
|
|
1746
|
+
// Add a custom "archived" status label
|
|
1747
|
+
$statuses['archived'] = __('Archived', 'fluent-cart');
|
|
1748
|
+
return $statuses;
|
|
1749
|
+
}, 10, 1);
|
|
1750
|
+
```
|
|
1751
|
+
|
|
1752
|
+
### ` variation_types `
|
|
1753
|
+
|
|
1754
|
+
`fluent_cart/variation_types` — Filter the available product variation types
|
|
1755
|
+
|
|
1756
|
+
**When it runs:** This filter is applied after the default variation type list is built, and before it's returned (as the full label-keyed array, or as just the keys when `$withLabel` is false).
|
|
1757
|
+
|
|
1758
|
+
**Parameters:**
|
|
1759
|
+
|
|
1760
|
+
- `$types` (array): The variation types, keyed by type slug. The default list includes at least:
|
|
1761
|
+
|
|
1762
|
+
```
|
|
1763
|
+
$types = [
|
|
1764
|
+
// ...other type entries defined above this call in the source...
|
|
1765
|
+
'advanced_variations' => __('Advanced Variations', 'fluent-cart'),
|
|
1766
|
+
];
|
|
1767
|
+
```
|
|
1768
|
+
|
|
1769
|
+
**Returns:**
|
|
1770
|
+
|
|
1771
|
+
- `$types` (array): The modified types array
|
|
1772
|
+
|
|
1773
|
+
**Source:** `app/Helpers/Helper.php:788`
|
|
1774
|
+
|
|
1775
|
+
**Usage:**
|
|
1776
|
+
|
|
1777
|
+
```
|
|
1778
|
+
add_filter('fluent_cart/variation_types', function($types) {
|
|
1779
|
+
// Register a custom variation type for a third-party module
|
|
1780
|
+
$types['my_matrix_variations'] = __('Matrix Variations', 'my-addon');
|
|
1781
|
+
return $types;
|
|
1782
|
+
}, 10, 1);
|
|
1783
|
+
```
|
|
1784
|
+
|
|
1785
|
+
---
|