fluentcart-developer 2.3.4 → 3.0.1
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/LICENSE.md +26 -26
- package/README.md +59 -59
- package/dist/cards/fluentcart/templates-native.js +1087 -1087
- package/dist/cards/fluentcart/tools.d.ts.map +1 -1
- package/dist/cards/fluentcart/tools.js +62 -17
- 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 +108 -580
- package/dist/skills/fluentcart-developer/examples/README.md +30 -30
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
- package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
- package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
- 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} +217 -197
- 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} +427 -449
- package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +440 -458
- 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} +1103 -1121
- 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} +1212 -1462
- 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} +2485 -2697
- 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} +905 -800
- 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/{rest-api-overview.md → restapi.md} +127 -131
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +66 -65
- 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-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,1079 @@
|
|
|
1
|
+
# Admin & Templates
|
|
2
|
+
|
|
3
|
+
All hooks related to plugin boot/initialization, admin UI, modules, the block/email editor, form rendering, page templating, shortcode-driven views, policy verification, and custom web routes.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Boot / Initialization
|
|
8
|
+
|
|
9
|
+
Fired during plugin startup. These are the earliest FluentCart hooks and let you tap into the container before any other logic runs.
|
|
10
|
+
|
|
11
|
+
### ` fluentcart_loaded `
|
|
12
|
+
|
|
13
|
+
`fluentcart_loaded` — Plugin application container loaded (first hook)
|
|
14
|
+
|
|
15
|
+
**When it runs:** Fires inside the `plugins_loaded` WordPress hook, immediately after the FluentCart `Application` container is constructed and the Action Scheduler is loaded. This is the very first FluentCart hook — use it to register early bindings, service providers, or listeners before anything else initialises.
|
|
16
|
+
|
|
17
|
+
**Parameters:**
|
|
18
|
+
|
|
19
|
+
- `$app` (\FluentCart\Framework\Foundation\Application): The FluentCart application container instance
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
// $app is the IoC container — you can resolve services from it:
|
|
23
|
+
$app->make(\FluentCart\App\Services\SomeService::class);
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Source:** `boot/app.php` (line 30)
|
|
27
|
+
|
|
28
|
+
**Usage:**
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
add_action('fluentcart_loaded', function ($app) {
|
|
32
|
+
// Register a custom service into the FluentCart container early
|
|
33
|
+
$app->bind('myCustomService', function () {
|
|
34
|
+
return new \MyPlugin\CustomService();
|
|
35
|
+
});
|
|
36
|
+
}, 10, 1);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### ` fluent_cart/init `
|
|
40
|
+
|
|
41
|
+
`fluent_cart/init` — FluentCart fully initialised on WP `init`
|
|
42
|
+
|
|
43
|
+
**When it runs:** Fires inside the WordPress `init` hook (which itself runs after `plugins_loaded`). By this point, all post types, taxonomies, and rewrite rules are available. Use this for logic that depends on WordPress being fully bootstrapped — custom post type queries, REST route registration, etc.
|
|
44
|
+
|
|
45
|
+
**Parameters:**
|
|
46
|
+
|
|
47
|
+
- `$app` (\FluentCart\Framework\Foundation\Application): The FluentCart application container instance
|
|
48
|
+
|
|
49
|
+
**Source:** `boot/app.php` (line 40)
|
|
50
|
+
|
|
51
|
+
**Usage:**
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
add_action('fluent_cart/init', function ($app) {
|
|
55
|
+
// Safe to query custom post types or register REST routes here
|
|
56
|
+
register_rest_route('my-plugin/v1', '/data', [
|
|
57
|
+
'methods' => 'GET',
|
|
58
|
+
'callback' => 'my_custom_handler',
|
|
59
|
+
]);
|
|
60
|
+
}, 10, 1);
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Admin
|
|
66
|
+
|
|
67
|
+
Hooks that fire during admin page rendering, menu setup, and asset enqueueing. Use these to extend the FluentCart admin panel.
|
|
68
|
+
|
|
69
|
+
### ` fluent_cart/admin_menu `
|
|
70
|
+
|
|
71
|
+
`fluent_cart/admin_menu` — Render admin navigation menu
|
|
72
|
+
|
|
73
|
+
**When it runs:** Fires in two places: inside the admin Vue SPA wrapper (`admin_app.php`) and on the product CPT taxonomy pages. It is the hook that renders the FluentCart admin navigation bar. The default handler (`MenuHandler::renderAdminMenu`) is attached to it to output the menu HTML.
|
|
74
|
+
|
|
75
|
+
**Parameters:**
|
|
76
|
+
|
|
77
|
+
None — this is a rendering hook. Callbacks should echo HTML.
|
|
78
|
+
|
|
79
|
+
**Source:** `app/CPT/FluentProducts.php` (line 359), `app/Views/admin/admin_app.php` (line 4)
|
|
80
|
+
|
|
81
|
+
**Usage:**
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
add_action('fluent_cart/admin_menu', function () {
|
|
85
|
+
// Append a custom link to the admin navigation bar
|
|
86
|
+
echo '<a href="#/my-custom-page" class="fct-nav-item">My Page</a>';
|
|
87
|
+
}, 20);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### ` fluent_cart/admin_submenu_added `
|
|
91
|
+
|
|
92
|
+
`fluent_cart/admin_submenu_added` — After all admin submenus registered
|
|
93
|
+
|
|
94
|
+
**When it runs:** Fires at the end of `MenuHandler::addAdminMenu()`, after all default submenu items (Dashboard, Orders, Customers, Products, Integrations, Reports, Settings, Coupons, Logs, and taxonomy pages) have been registered under the FluentCart admin menu.
|
|
95
|
+
|
|
96
|
+
**Parameters:**
|
|
97
|
+
|
|
98
|
+
- `$submenu` (array): The WordPress global `$submenu` array (keyed by parent slug). The `fluent-cart` key contains all FluentCart submenu items.
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
$submenu = [
|
|
102
|
+
'fluent-cart' => [
|
|
103
|
+
'dashboard' => ['Dashboard', 'manage_options', 'admin.php?page=fluent-cart#/', ...],
|
|
104
|
+
'orders' => ['Orders', 'manage_options', 'admin.php?page=fluent-cart#/orders', ...],
|
|
105
|
+
'customers' => ['Customers', ...],
|
|
106
|
+
'products' => ['Products', ...],
|
|
107
|
+
'integrations' => ['Integrations', ...],
|
|
108
|
+
'reports' => ['Reports', ...],
|
|
109
|
+
'settings' => ['Settings', ...],
|
|
110
|
+
'coupons' => ['Coupons', ...],
|
|
111
|
+
'logs' => ['Logs', ...],
|
|
112
|
+
// ... taxonomy submenus
|
|
113
|
+
],
|
|
114
|
+
];
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
**Source:** `app/Hooks/Handlers/MenuHandler.php` (line 368)
|
|
118
|
+
|
|
119
|
+
**Usage:**
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
add_action('fluent_cart/admin_submenu_added', function ($submenu) {
|
|
123
|
+
// Add a custom submenu item programmatically
|
|
124
|
+
global $submenu;
|
|
125
|
+
$submenu['fluent-cart']['my_page'] = [
|
|
126
|
+
__('My Custom Page', 'my-plugin'),
|
|
127
|
+
'manage_options',
|
|
128
|
+
'admin.php?page=fluent-cart#/my-custom',
|
|
129
|
+
];
|
|
130
|
+
}, 10, 1);
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### ` fluent_cart/loading_app `
|
|
134
|
+
|
|
135
|
+
`fluent_cart/loading_app` — Admin Vue SPA assets about to be enqueued
|
|
136
|
+
|
|
137
|
+
**When it runs:** Fires at the very beginning of `MenuHandler::enqueueAssets()`, before any admin JavaScript or CSS is registered. Use this to enqueue your own scripts or styles that need to load alongside (or before) the admin SPA.
|
|
138
|
+
|
|
139
|
+
**Parameters:**
|
|
140
|
+
|
|
141
|
+
- `$app` (\FluentCart\Framework\Foundation\Application): The FluentCart application container instance
|
|
142
|
+
|
|
143
|
+
**Source:** `app/Hooks/Handlers/MenuHandler.php` (line 440)
|
|
144
|
+
|
|
145
|
+
**Usage:**
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
add_action('fluent_cart/loading_app', function ($app) {
|
|
149
|
+
// Enqueue a custom admin stylesheet before the SPA loads
|
|
150
|
+
wp_enqueue_style('my-fct-admin-style', plugins_url('css/admin.css', __FILE__));
|
|
151
|
+
}, 10, 1);
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### ` fluent_cart/after_migrate `
|
|
155
|
+
|
|
156
|
+
`fluent_cart/after_migrate` — After pending database migrations have run
|
|
157
|
+
|
|
158
|
+
**When it runs:** Fires inside `DBMigrator` after all pending schema migrators for the current version have executed. Use this to run one-off follow-up logic (e.g. warming a cache, re-indexing) that depends on the database schema being fully up to date.
|
|
159
|
+
|
|
160
|
+
**Parameters:**
|
|
161
|
+
|
|
162
|
+
None.
|
|
163
|
+
|
|
164
|
+
**Source:** `database/DBMigrator.php:134`
|
|
165
|
+
|
|
166
|
+
**Usage:**
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
add_action('fluent_cart/after_migrate', function () {
|
|
170
|
+
// Clear any cached schema-dependent data after migrations run
|
|
171
|
+
delete_transient('my_plugin_fluentcart_schema_cache');
|
|
172
|
+
}, 10);
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### ` fluent_cart/admin_js_loaded `
|
|
176
|
+
|
|
177
|
+
`fluent_cart/admin_js_loaded` — After all admin JS enqueued and localised
|
|
178
|
+
|
|
179
|
+
**When it runs:** Fires at the end of `MenuHandler::enqueueAssets()`, after all admin scripts have been enqueued and `wp_localize_script` has injected the `fluentCartAdminApp` and `fluentCartRestVars` objects. Use this to enqueue scripts that depend on the admin SPA data being available, or to add inline script data.
|
|
180
|
+
|
|
181
|
+
**Parameters:**
|
|
182
|
+
|
|
183
|
+
- `$app` (\FluentCart\Framework\Foundation\Application): The FluentCart application container instance
|
|
184
|
+
|
|
185
|
+
**Source:** `app/Hooks/Handlers/MenuHandler.php` (line 603)
|
|
186
|
+
|
|
187
|
+
**Usage:**
|
|
188
|
+
|
|
189
|
+
```
|
|
190
|
+
add_action('fluent_cart/admin_js_loaded', function ($app) {
|
|
191
|
+
// Enqueue a script that depends on the admin app being fully loaded
|
|
192
|
+
wp_enqueue_script('my-fct-addon', plugins_url('js/addon.js', __FILE__), [], '1.0', true);
|
|
193
|
+
|
|
194
|
+
// Add inline data that references fluentCartAdminApp
|
|
195
|
+
wp_add_inline_script('my-fct-addon', 'window.myAddonConfig = { ready: true };', 'before');
|
|
196
|
+
}, 10, 1);
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## Modules
|
|
202
|
+
|
|
203
|
+
Hooks that fire when built-in FluentCart modules (e.g. stock management, subscriptions, shipping) are activated or deactivated via the admin settings panel.
|
|
204
|
+
|
|
205
|
+
### ` module/deactivated/{module_key} `
|
|
206
|
+
|
|
207
|
+
`fluent_cart/module/deactivated/{$moduleKey}` — Module deactivated (dynamic)
|
|
208
|
+
|
|
209
|
+
**When it runs:** Fires inside `ModuleSettingsController::saveSettings()` when a module's `active` status transitions from `'yes'` to `'no'`. The `{$moduleKey}` portion is replaced dynamically with the module identifier.
|
|
210
|
+
|
|
211
|
+
**Available dynamic variants:** `stock_management`, `subscriptions`, `shipping`, `tax`, `coupon`, `license`, `digital_downloads`, and any other registered module key.
|
|
212
|
+
|
|
213
|
+
**Parameters:**
|
|
214
|
+
|
|
215
|
+
- `$moduleData` (array): The newly saved settings for this module
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
$moduleData = [
|
|
219
|
+
'active' => 'no',
|
|
220
|
+
// ... other module-specific settings
|
|
221
|
+
];
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
- `$prevModuleData` (array): The previous settings for this module before the save
|
|
225
|
+
|
|
226
|
+
```
|
|
227
|
+
$prevModuleData = [
|
|
228
|
+
'active' => 'yes',
|
|
229
|
+
// ... previous module-specific settings
|
|
230
|
+
];
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
**Source:** `app/Http/Controllers/ModuleSettingsController.php` (line 55)
|
|
234
|
+
|
|
235
|
+
**Usage:**
|
|
236
|
+
|
|
237
|
+
```
|
|
238
|
+
add_action('fluent_cart/module/deactivated/stock_management', function ($moduleData, $prevModuleData) {
|
|
239
|
+
// Clean up stock-related cron jobs when stock management is turned off
|
|
240
|
+
as_unschedule_all_actions('fluent_cart/stock_check');
|
|
241
|
+
}, 10, 2);
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### ` module/activated/{module_key} `
|
|
245
|
+
|
|
246
|
+
`fluent_cart/module/activated/{$moduleKey}` — Module activated (dynamic)
|
|
247
|
+
|
|
248
|
+
**When it runs:** Fires inside `ModuleSettingsController::saveSettings()` when a module's `active` status transitions from `'no'` to `'yes'`. The `{$moduleKey}` portion is replaced dynamically with the module identifier.
|
|
249
|
+
|
|
250
|
+
**Available dynamic variants:** `stock_management`, `subscriptions`, `shipping`, `tax`, `coupon`, `license`, `digital_downloads`, and any other registered module key.
|
|
251
|
+
|
|
252
|
+
**Parameters:**
|
|
253
|
+
|
|
254
|
+
- `$moduleData` (array): The newly saved settings for this module
|
|
255
|
+
|
|
256
|
+
```
|
|
257
|
+
$moduleData = [
|
|
258
|
+
'active' => 'yes',
|
|
259
|
+
// ... other module-specific settings
|
|
260
|
+
];
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
- `$prevModuleData` (array): The previous settings for this module before the save
|
|
264
|
+
|
|
265
|
+
```
|
|
266
|
+
$prevModuleData = [
|
|
267
|
+
'active' => 'no',
|
|
268
|
+
// ... previous module-specific settings
|
|
269
|
+
];
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
**Source:** `app/Http/Controllers/ModuleSettingsController.php` (line 61)
|
|
273
|
+
|
|
274
|
+
**Usage:**
|
|
275
|
+
|
|
276
|
+
```
|
|
277
|
+
add_action('fluent_cart/module/activated/subscriptions', function ($moduleData, $prevModuleData) {
|
|
278
|
+
// Run database migrations when the subscriptions module is first activated
|
|
279
|
+
\FluentCart\Database\DBMigrator::run('subscription_tables');
|
|
280
|
+
}, 10, 2);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
## Block Editor / Email Editor
|
|
286
|
+
|
|
287
|
+
Hooks for the custom FluentCart block editor used to compose email templates. These fire during the editor page lifecycle and asset loading.
|
|
288
|
+
|
|
289
|
+
### ` fluent_cart_enqueue_block_editor_assets `
|
|
290
|
+
|
|
291
|
+
`fluent_cart_enqueue_block_editor_assets` Pro — Block editor assets being enqueued
|
|
292
|
+
|
|
293
|
+
**When it runs:** Fires at the end of `FluentCartBlockEditorHandler::enqueueEditorStyles()`, after all core WordPress block editor styles (`wp-edit-post`, `wp-block-library`, etc.) have been enqueued. WordPress's own `wp_enqueue_editor_format_library_assets` is also attached to this hook. Use it to add custom styles or scripts to the email block editor.
|
|
294
|
+
|
|
295
|
+
**Parameters:**
|
|
296
|
+
|
|
297
|
+
None.
|
|
298
|
+
|
|
299
|
+
**Source:** `app/Hooks/Handlers/FluentCartBlockEditorHandler.php` (line 445)
|
|
300
|
+
|
|
301
|
+
**Usage:**
|
|
302
|
+
|
|
303
|
+
```
|
|
304
|
+
add_action('fluent_cart_enqueue_block_editor_assets', function () {
|
|
305
|
+
// Add custom styles for the email block editor
|
|
306
|
+
wp_enqueue_style('my-email-editor-styles', plugins_url('css/email-editor.css', __FILE__));
|
|
307
|
+
}, 10);
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
### ` fluent_cart_block_editor/head `
|
|
311
|
+
|
|
312
|
+
`fluent_cart_block_editor/head` Pro — In `` of custom block editor page
|
|
313
|
+
|
|
314
|
+
**When it runs:** Fires inside the `` tag of the custom block editor HTML page. WordPress core hooks (`wp_enqueue_scripts`, `wp_print_styles`, `wp_print_head_scripts`, etc.) are pre-attached to this action so that editor stylesheets and scripts are output in the correct location. Use this to inject additional ``, ``, or `` tags into the editor page head.
|
|
315
|
+
|
|
316
|
+
**Parameters:**
|
|
317
|
+
|
|
318
|
+
None.
|
|
319
|
+
|
|
320
|
+
**Source:** `app/Hooks/Handlers/FluentCartBlockEditorHandler.php` (line 698)
|
|
321
|
+
|
|
322
|
+
**Usage:**
|
|
323
|
+
|
|
324
|
+
```
|
|
325
|
+
add_action('fluent_cart_block_editor/head', function () {
|
|
326
|
+
// Inject a custom font into the email block editor page
|
|
327
|
+
echo '<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap">';
|
|
328
|
+
}, 20);
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### ` fluent_cart/block_editor_head `
|
|
332
|
+
|
|
333
|
+
`fluent_cart/block_editor_head` Pro — Second head hook in block editor page
|
|
334
|
+
|
|
335
|
+
**When it runs:** Fires immediately after `fluent_cart_block_editor/head` inside the `` tag, right before the closing ``. This is a secondary head hook — use it for last-minute style overrides or scripts that must load after everything else in the head.
|
|
336
|
+
|
|
337
|
+
**Parameters:**
|
|
338
|
+
|
|
339
|
+
None.
|
|
340
|
+
|
|
341
|
+
**Source:** `app/Hooks/Handlers/FluentCartBlockEditorHandler.php` (line 701)
|
|
342
|
+
|
|
343
|
+
**Usage:**
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
add_action('fluent_cart/block_editor_head', function () {
|
|
347
|
+
// Override editor styles as the final head injection
|
|
348
|
+
echo '<style>.editor-styles-wrapper { font-family: "Inter", sans-serif; }</style>';
|
|
349
|
+
}, 10);
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
### ` fluent_cart/new_block_editor_footer `
|
|
353
|
+
|
|
354
|
+
`fluent_cart/new_block_editor_footer` Pro — Footer of custom block editor page (for JS)
|
|
355
|
+
|
|
356
|
+
**When it runs:** Fires inside the `` of the custom block editor page, after the editor `` and before ``. This is the recommended place to inject footer JavaScript for the email editor.
|
|
357
|
+
|
|
358
|
+
**Parameters:**
|
|
359
|
+
|
|
360
|
+
None.
|
|
361
|
+
|
|
362
|
+
**Source:** `app/Hooks/Handlers/FluentCartBlockEditorHandler.php` (line 708)
|
|
363
|
+
|
|
364
|
+
**Usage:**
|
|
365
|
+
|
|
366
|
+
```
|
|
367
|
+
add_action('fluent_cart/new_block_editor_footer', function () {
|
|
368
|
+
// Inject custom JS into the email editor page footer
|
|
369
|
+
echo '<script>console.log("FluentCart email editor loaded");</script>';
|
|
370
|
+
}, 10);
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### ` fluent_cart/block_editor/enqueue_assets `
|
|
374
|
+
|
|
375
|
+
`fluent_cart/block_editor/enqueue_assets` Pro — After email editor block assets enqueued
|
|
376
|
+
|
|
377
|
+
**When it runs:** Fires at the end of `FluentCartBlockEditorHandler::enqueueEmailEditorBlocks()`, after all FluentCart-specific email editor block scripts, styles, and global editor SCSS have been enqueued. Use this to register additional custom blocks or scripts for the email editor.
|
|
378
|
+
|
|
379
|
+
**Parameters:**
|
|
380
|
+
|
|
381
|
+
None.
|
|
382
|
+
|
|
383
|
+
**Source:** `app/Hooks/Handlers/FluentCartBlockEditorHandler.php` (line 1328)
|
|
384
|
+
|
|
385
|
+
**Usage:**
|
|
386
|
+
|
|
387
|
+
```
|
|
388
|
+
add_action('fluent_cart/block_editor/enqueue_assets', function () {
|
|
389
|
+
// Register a custom email block
|
|
390
|
+
wp_enqueue_script('my-email-block', plugins_url('js/my-email-block.js', __FILE__), ['wp-blocks'], '1.0', true);
|
|
391
|
+
}, 10);
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### ` fluent_cart/block_editor/render_block `
|
|
395
|
+
|
|
396
|
+
`fluent_cart/block_editor/render_block` Pro — Render unknown block types in email parser
|
|
397
|
+
|
|
398
|
+
**When it runs:** Fires inside `FluentBlockParser` when processing a block whose name is not recognised by any built-in handler and is not a standard email editor block. The hook runs inside `ob_start()` — any output you `echo` will be captured and used as the block's rendered HTML in the email. If nothing is output, the parser falls back to raw `innerHTML`.
|
|
399
|
+
|
|
400
|
+
**Parameters:**
|
|
401
|
+
|
|
402
|
+
- `$data` (array): Block rendering context
|
|
403
|
+
|
|
404
|
+
```
|
|
405
|
+
$data = [
|
|
406
|
+
'block' => [...], // Full block array (name, attrs, innerBlocks, innerHTML, etc.)
|
|
407
|
+
'block_name' => 'my/custom', // The block type name string
|
|
408
|
+
'attributes' => [...], // Block attributes array
|
|
409
|
+
];
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
**Source:** `app/Services/Email/FluentBlockParser.php` (line 278)
|
|
413
|
+
|
|
414
|
+
**Usage:**
|
|
415
|
+
|
|
416
|
+
```
|
|
417
|
+
add_action('fluent_cart/block_editor/render_block', function ($data) {
|
|
418
|
+
if ($data['block_name'] === 'my-plugin/promo-banner') {
|
|
419
|
+
$heading = $data['attributes']['heading'] ?? 'Special Offer';
|
|
420
|
+
echo '<div style="background: #f0f0f0; padding: 20px; text-align: center;">';
|
|
421
|
+
echo '<h2>' . esc_html($heading) . '</h2>';
|
|
422
|
+
echo '</div>';
|
|
423
|
+
}
|
|
424
|
+
}, 10, 1);
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
---
|
|
428
|
+
|
|
429
|
+
## Form Rendering
|
|
430
|
+
|
|
431
|
+
Hooks for extending the checkout form field renderer with custom field types.
|
|
432
|
+
|
|
433
|
+
### ` fluent_cart/render_custom_form_field `
|
|
434
|
+
|
|
435
|
+
`fluent_cart/render_custom_form_field` — Unrecognised form field type fallback
|
|
436
|
+
|
|
437
|
+
**When it runs:** Fires inside the `default` case of `FormFieldRenderer::renderField()` when the field `type` does not match any built-in type (`section`, `sub_section`, `text`, `email`, `tel`, `number`, `textarea`, `checkbox`, `select`, `address_select`). Use this to render custom field types in the checkout or registration forms.
|
|
438
|
+
|
|
439
|
+
**Parameters:**
|
|
440
|
+
|
|
441
|
+
- `$fieldData` (array): The field configuration array
|
|
442
|
+
|
|
443
|
+
```
|
|
444
|
+
$fieldData = [
|
|
445
|
+
'type' => 'my_custom_type', // The unrecognised field type
|
|
446
|
+
'label' => 'Custom Field', // Field label
|
|
447
|
+
'id' => 'my_field', // Field HTML ID
|
|
448
|
+
'name' => 'my_field', // Field name attribute
|
|
449
|
+
'required' => true, // Whether the field is required
|
|
450
|
+
'wrapper_class' => '', // CSS class for the wrapper
|
|
451
|
+
'options' => [], // Options (if applicable)
|
|
452
|
+
// ... other field-specific keys
|
|
453
|
+
];
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
**Source:** `app/Services/Renderer/FormFieldRenderer.php` (line 58)
|
|
457
|
+
|
|
458
|
+
**Usage:**
|
|
459
|
+
|
|
460
|
+
```
|
|
461
|
+
add_action('fluent_cart/render_custom_form_field', function ($fieldData) {
|
|
462
|
+
if ($fieldData['type'] === 'date_picker') {
|
|
463
|
+
$id = esc_attr($fieldData['id'] ?? '');
|
|
464
|
+
$name = esc_attr($fieldData['name'] ?? '');
|
|
465
|
+
$label = esc_html($fieldData['label'] ?? '');
|
|
466
|
+
$required = !empty($fieldData['required']) ? 'required' : '';
|
|
467
|
+
echo "<div class='fct_form_field'>";
|
|
468
|
+
echo "<label for='{$id}'>{$label}</label>";
|
|
469
|
+
echo "<input type='date' id='{$id}' name='{$name}' {$required} />";
|
|
470
|
+
echo "</div>";
|
|
471
|
+
}
|
|
472
|
+
}, 10, 1);
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
---
|
|
476
|
+
|
|
477
|
+
## Templating
|
|
478
|
+
|
|
479
|
+
Hooks for the generic fallback template used on product archive pages and other FluentCart template-driven pages. They fire in sequence from top to bottom of the page layout.
|
|
480
|
+
|
|
481
|
+
### ` fluent_cart/generic_template/rendering `
|
|
482
|
+
|
|
483
|
+
`fluent_cart/generic_template/rendering` — Start of generic fallback template
|
|
484
|
+
|
|
485
|
+
**When it runs:** Fires at the very top of `fallback-generic-template.php`, before `get_header()` is called. Use this to set up global variables, enqueue assets, or modify the page state before any template output begins.
|
|
486
|
+
|
|
487
|
+
**Parameters:**
|
|
488
|
+
|
|
489
|
+
None.
|
|
490
|
+
|
|
491
|
+
**Source:** `app/Modules/Templating/fallback-generic-template.php` (line 7)
|
|
492
|
+
|
|
493
|
+
**Usage:**
|
|
494
|
+
|
|
495
|
+
```
|
|
496
|
+
add_action('fluent_cart/generic_template/rendering', function () {
|
|
497
|
+
// Enqueue custom styles for the product archive template
|
|
498
|
+
wp_enqueue_style('my-archive-styles', plugins_url('css/archive.css', __FILE__));
|
|
499
|
+
}, 10);
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
### ` fluent_cart/generic_template/before_content `
|
|
503
|
+
|
|
504
|
+
`fluent_cart/generic_template/before_content` — After `get_header()`, before main wrapper
|
|
505
|
+
|
|
506
|
+
**When it runs:** Fires after the WordPress header has been rendered by `get_header()` and before the main content wrapper `` opens. Use this for banners, breadcrumbs, or other full-width elements above the content area.
|
|
507
|
+
|
|
508
|
+
**Parameters:**
|
|
509
|
+
|
|
510
|
+
None.
|
|
511
|
+
|
|
512
|
+
**Source:** `app/Modules/Templating/fallback-generic-template.php` (line 10)
|
|
513
|
+
|
|
514
|
+
**Usage:**
|
|
515
|
+
|
|
516
|
+
```
|
|
517
|
+
add_action('fluent_cart/generic_template/before_content', function () {
|
|
518
|
+
// Add a breadcrumb trail above the product archive
|
|
519
|
+
echo '<nav class="fct-breadcrumb">Home » Shop</nav>';
|
|
520
|
+
}, 10);
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
### ` fluent_cart/template/before_content `
|
|
524
|
+
|
|
525
|
+
`fluent_cart/template/before_content` — Inside main wrapper, before content
|
|
526
|
+
|
|
527
|
+
**When it runs:** Fires inside the `` site-main wrapper, before the main content hook. Use this for content-width elements like filter bars or category headers that sit above the product grid.
|
|
528
|
+
|
|
529
|
+
**Parameters:**
|
|
530
|
+
|
|
531
|
+
None.
|
|
532
|
+
|
|
533
|
+
**Source:** `app/Modules/Templating/fallback-generic-template.php` (line 13)
|
|
534
|
+
|
|
535
|
+
**Usage:**
|
|
536
|
+
|
|
537
|
+
```
|
|
538
|
+
add_action('fluent_cart/template/before_content', function () {
|
|
539
|
+
// Show a category filter bar above the product grid
|
|
540
|
+
echo '<div class="fct-filter-bar">Filter by category...</div>';
|
|
541
|
+
}, 10);
|
|
542
|
+
```
|
|
543
|
+
|
|
544
|
+
### ` fluent_cart/template/main_content `
|
|
545
|
+
|
|
546
|
+
`fluent_cart/template/main_content` — Main content area
|
|
547
|
+
|
|
548
|
+
**When it runs:** Fires inside the `` wrapper between the `before_content` and `after_content` hooks. This is where the primary page content (product grid, archive loop, etc.) is rendered. FluentCart's templating module hooks its archive rendering here.
|
|
549
|
+
|
|
550
|
+
**Parameters:**
|
|
551
|
+
|
|
552
|
+
None.
|
|
553
|
+
|
|
554
|
+
**Source:** `app/Modules/Templating/fallback-generic-template.php` (line 14)
|
|
555
|
+
|
|
556
|
+
**Usage:**
|
|
557
|
+
|
|
558
|
+
```
|
|
559
|
+
add_action('fluent_cart/template/main_content', function () {
|
|
560
|
+
// Replace or supplement the default archive content
|
|
561
|
+
echo '<div class="my-custom-product-grid">Custom grid here</div>';
|
|
562
|
+
}, 10);
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### ` fluent_cart/template/after_content `
|
|
566
|
+
|
|
567
|
+
`fluent_cart/template/after_content` — After main content
|
|
568
|
+
|
|
569
|
+
**When it runs:** Fires inside the `` wrapper after the main content has been rendered. Use this for pagination, call-to-action blocks, or related products sections that sit below the product grid.
|
|
570
|
+
|
|
571
|
+
**Parameters:**
|
|
572
|
+
|
|
573
|
+
None.
|
|
574
|
+
|
|
575
|
+
**Source:** `app/Modules/Templating/fallback-generic-template.php` (line 15)
|
|
576
|
+
|
|
577
|
+
**Usage:**
|
|
578
|
+
|
|
579
|
+
```
|
|
580
|
+
add_action('fluent_cart/template/after_content', function () {
|
|
581
|
+
// Add pagination below the product grid
|
|
582
|
+
echo '<div class="fct-pagination"><!-- pagination links --></div>';
|
|
583
|
+
}, 10);
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
### ` fluent_cart/generic_template/after_content `
|
|
587
|
+
|
|
588
|
+
`fluent_cart/generic_template/after_content` — After main wrapper, before `get_footer()`
|
|
589
|
+
|
|
590
|
+
**When it runs:** Fires after the main content wrapper `` closes and before `get_footer()` renders the site footer. Use this for full-width elements below the content area like newsletter signups or related content.
|
|
591
|
+
|
|
592
|
+
**Parameters:**
|
|
593
|
+
|
|
594
|
+
None.
|
|
595
|
+
|
|
596
|
+
**Source:** `app/Modules/Templating/fallback-generic-template.php` (line 18)
|
|
597
|
+
|
|
598
|
+
**Usage:**
|
|
599
|
+
|
|
600
|
+
```
|
|
601
|
+
add_action('fluent_cart/generic_template/after_content', function () {
|
|
602
|
+
// Add a full-width newsletter signup section
|
|
603
|
+
echo '<section class="fct-newsletter">Subscribe to our newsletter</section>';
|
|
604
|
+
}, 10);
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
---
|
|
608
|
+
|
|
609
|
+
## Views (Shortcode-Driven Rendering)
|
|
610
|
+
|
|
611
|
+
Hooks that render specific view partials on the checkout page, receipt emails, and customer-facing forms. These fire inside `ob_start()` / `ob_get_clean()` blocks — your callbacks should `echo` HTML output.
|
|
612
|
+
|
|
613
|
+
### ` views/checkout_page_cart_item_list `
|
|
614
|
+
|
|
615
|
+
`fluent_cart/views/checkout_page_cart_item_list` — Render cart item list on checkout
|
|
616
|
+
|
|
617
|
+
**When it runs:** Fires inside `CheckoutController::getCheckoutSummary()` to render the cart item list partial on the checkout page. The output is captured via `ob_start()` and returned as part of the checkout summary AJAX response.
|
|
618
|
+
|
|
619
|
+
**Parameters:**
|
|
620
|
+
|
|
621
|
+
- `$data` (array): Checkout context
|
|
622
|
+
|
|
623
|
+
```
|
|
624
|
+
$data = [
|
|
625
|
+
'checkout' => $checkOutHelper, // \FluentCart\App\Helpers\CartCheckoutHelper instance
|
|
626
|
+
'items' => [...], // Array of cart items from $checkOutHelper->getItems()
|
|
627
|
+
];
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
**Source:** `app/Http/Controllers/CheckoutController.php` (line 39)
|
|
631
|
+
|
|
632
|
+
**Usage:**
|
|
633
|
+
|
|
634
|
+
```
|
|
635
|
+
add_action('fluent_cart/views/checkout_page_cart_item_list', function ($data) {
|
|
636
|
+
$items = $data['items'];
|
|
637
|
+
echo '<div class="fct-cart-items">';
|
|
638
|
+
foreach ($items as $item) {
|
|
639
|
+
echo '<div class="fct-cart-item">' . esc_html($item['title'] ?? '') . '</div>';
|
|
640
|
+
}
|
|
641
|
+
echo '</div>';
|
|
642
|
+
}, 10, 1);
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
### ` views/checkout_page_registration_form `
|
|
646
|
+
|
|
647
|
+
`fluent_cart/views/checkout_page_registration_form` — Render registration form on checkout
|
|
648
|
+
|
|
649
|
+
**When it runs:** Fires inside `CustomerRegistrationHandler::render()` to output the guest registration form on the checkout page. The output is captured via `ob_start()` and returned as the rendered form HTML.
|
|
650
|
+
|
|
651
|
+
**Parameters:**
|
|
652
|
+
|
|
653
|
+
- `$viewData` (array): View context
|
|
654
|
+
|
|
655
|
+
```
|
|
656
|
+
$viewData = [
|
|
657
|
+
'checkout' => $checkOutHelper, // \FluentCart\App\Helpers\CartCheckoutHelper instance
|
|
658
|
+
];
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
**Source:** `app/Hooks/Handlers/ShortCodes/CustomerRegistrationHandler.php` (line 79)
|
|
662
|
+
|
|
663
|
+
**Usage:**
|
|
664
|
+
|
|
665
|
+
```
|
|
666
|
+
add_action('fluent_cart/views/checkout_page_registration_form', function ($viewData) {
|
|
667
|
+
$checkout = $viewData['checkout'];
|
|
668
|
+
echo '<div class="fct-registration-form">';
|
|
669
|
+
echo '<h3>Create an Account</h3>';
|
|
670
|
+
// Render custom registration fields
|
|
671
|
+
echo '<input type="text" name="full_name" placeholder="Full Name" />';
|
|
672
|
+
echo '<input type="email" name="email" placeholder="Email" />';
|
|
673
|
+
echo '<input type="password" name="password" placeholder="Password" />';
|
|
674
|
+
echo '</div>';
|
|
675
|
+
}, 10, 1);
|
|
676
|
+
```
|
|
677
|
+
|
|
678
|
+
### ` views/checkout_page_login_form `
|
|
679
|
+
|
|
680
|
+
`fluent_cart/views/checkout_page_login_form` — Render login form on checkout
|
|
681
|
+
|
|
682
|
+
**When it runs:** Fires inside `CustomerLoginHandler::render()` to output the login form on the checkout page for returning customers. The output is captured via `ob_start()` and returned as the rendered form HTML.
|
|
683
|
+
|
|
684
|
+
**Parameters:**
|
|
685
|
+
|
|
686
|
+
- `$viewData` (array): View context
|
|
687
|
+
|
|
688
|
+
```
|
|
689
|
+
$viewData = [
|
|
690
|
+
'checkout' => $checkOutHelper, // \FluentCart\App\Helpers\CartCheckoutHelper instance
|
|
691
|
+
];
|
|
692
|
+
```
|
|
693
|
+
|
|
694
|
+
**Source:** `app/Hooks/Handlers/ShortCodes/CustomerLoginHandler.php` (line 81)
|
|
695
|
+
|
|
696
|
+
**Usage:**
|
|
697
|
+
|
|
698
|
+
```
|
|
699
|
+
add_action('fluent_cart/views/checkout_page_login_form', function ($viewData) {
|
|
700
|
+
echo '<div class="fct-login-form">';
|
|
701
|
+
echo '<h3>Returning Customer? Log In</h3>';
|
|
702
|
+
echo '<input type="email" name="email" placeholder="Email" />';
|
|
703
|
+
echo '<input type="password" name="password" placeholder="Password" />';
|
|
704
|
+
echo '<button type="submit">Log In</button>';
|
|
705
|
+
echo '</div>';
|
|
706
|
+
}, 10, 1);
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
### ` views/checkout_order_summary `
|
|
710
|
+
|
|
711
|
+
`fluent_cart/views/checkout_order_summary` — Render order summary (email shortcodes)
|
|
712
|
+
|
|
713
|
+
**When it runs:** Fires inside `ShortcodeParser::getSummary()` when the `{{order_summary}}` shortcode is parsed in email templates. The output is captured via `ob_start()` and inserted into the email body as the order summary block. Receives the [Order](/database/models/order.md) model instance.
|
|
714
|
+
|
|
715
|
+
**Parameters:**
|
|
716
|
+
|
|
717
|
+
- `$data` (array): Order summary context
|
|
718
|
+
|
|
719
|
+
```
|
|
720
|
+
$data = [
|
|
721
|
+
'order' => $order, // \FluentCart\App\Models\Order instance
|
|
722
|
+
'paymentReceipt' => $paymentReceipt, // \FluentCart\App\Services\PaymentReceipt instance
|
|
723
|
+
];
|
|
724
|
+
```
|
|
725
|
+
|
|
726
|
+
**Source:** `app/Services/ShortCodeParser/ShortcodeParser.php` (line 248)
|
|
727
|
+
|
|
728
|
+
**Usage:**
|
|
729
|
+
|
|
730
|
+
```
|
|
731
|
+
add_action('fluent_cart/views/checkout_order_summary', function ($data) {
|
|
732
|
+
$order = $data['order'];
|
|
733
|
+
$receipt = $data['paymentReceipt'];
|
|
734
|
+
echo '<table class="fct-order-summary">';
|
|
735
|
+
echo '<tr><th>Order #' . esc_html($order->id) . '</th></tr>';
|
|
736
|
+
// Render line items, totals, etc.
|
|
737
|
+
echo '</table>';
|
|
738
|
+
}, 10, 1);
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### ` views/checkout_order_receipt `
|
|
742
|
+
|
|
743
|
+
`fluent_cart/views/checkout_order_receipt` — Render full order receipt (email shortcodes)
|
|
744
|
+
|
|
745
|
+
**When it runs:** Fires inside `ShortcodeParser::getReceipt()` when the `{{order_receipt}}` shortcode is parsed in email templates. The output is captured via `ob_start()` and inserted into the email body as the complete [Order](/database/models/order.md) receipt.
|
|
746
|
+
|
|
747
|
+
**Parameters:**
|
|
748
|
+
|
|
749
|
+
- `$data` (array): Order receipt context
|
|
750
|
+
|
|
751
|
+
```
|
|
752
|
+
$data = [
|
|
753
|
+
'order' => $order, // \FluentCart\App\Models\Order instance
|
|
754
|
+
'paymentReceipt' => $paymentReceipt, // \FluentCart\App\Services\PaymentReceipt instance
|
|
755
|
+
];
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
**Source:** `app/Services/ShortCodeParser/ShortcodeParser.php` (line 256)
|
|
759
|
+
|
|
760
|
+
**Usage:**
|
|
761
|
+
|
|
762
|
+
```
|
|
763
|
+
add_action('fluent_cart/views/checkout_order_receipt', function ($data) {
|
|
764
|
+
$order = $data['order'];
|
|
765
|
+
$receipt = $data['paymentReceipt'];
|
|
766
|
+
echo '<div class="fct-receipt">';
|
|
767
|
+
echo '<h2>Receipt for Order #' . esc_html($order->id) . '</h2>';
|
|
768
|
+
// Render full receipt with items, addresses, payment info, etc.
|
|
769
|
+
echo '</div>';
|
|
770
|
+
}, 10, 1);
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
### ` views/checkout_page_shipping_method_list `
|
|
774
|
+
|
|
775
|
+
`fluent_cart/views/checkout_page_shipping_method_list` — Render shipping method list
|
|
776
|
+
|
|
777
|
+
**When it runs:** Fires inside `ShippingFrontendController::getShippingMethodsListView()` to render the list of available [ShippingMethod](/database/models/shipping-method.md) instances on the checkout page. The output is captured via `ob_start()` and returned as part of the shipping methods AJAX response.
|
|
778
|
+
|
|
779
|
+
**Parameters:**
|
|
780
|
+
|
|
781
|
+
- `$data` (array): Shipping methods context
|
|
782
|
+
|
|
783
|
+
```
|
|
784
|
+
$data = [
|
|
785
|
+
'shipping_methods' => [
|
|
786
|
+
// Array of available \FluentCart\App\Models\ShippingMethod instances
|
|
787
|
+
// filtered by the customer's country/address
|
|
788
|
+
],
|
|
789
|
+
];
|
|
790
|
+
```
|
|
791
|
+
|
|
792
|
+
**Source:** `app/Modules/Shipping/Http/Controllers/Frontend/ShippingFrontendController.php` (line 111)
|
|
793
|
+
|
|
794
|
+
**Usage:**
|
|
795
|
+
|
|
796
|
+
```
|
|
797
|
+
add_action('fluent_cart/views/checkout_page_shipping_method_list', function ($data) {
|
|
798
|
+
$methods = $data['shipping_methods'];
|
|
799
|
+
echo '<div class="fct-shipping-methods">';
|
|
800
|
+
foreach ($methods as $method) {
|
|
801
|
+
echo '<label>';
|
|
802
|
+
echo '<input type="radio" name="shipping_method" value="' . esc_attr($method->id) . '" />';
|
|
803
|
+
echo esc_html($method->title);
|
|
804
|
+
echo '</label>';
|
|
805
|
+
}
|
|
806
|
+
echo '</div>';
|
|
807
|
+
}, 10, 1);
|
|
808
|
+
```
|
|
809
|
+
|
|
810
|
+
### ` views/checkout_page_form_address_info_wrapper `
|
|
811
|
+
|
|
812
|
+
`fluent_cart/views/checkout_page_form_address_info_wrapper` — Render address info card
|
|
813
|
+
|
|
814
|
+
**When it runs:** Fires inside `CustomerController` when rendering the address information card on the checkout page after a customer selects or submits their address. The output is captured via `ob_start()` and returned in the AJAX response.
|
|
815
|
+
|
|
816
|
+
**Parameters:**
|
|
817
|
+
|
|
818
|
+
- `$data` (array): Address display data
|
|
819
|
+
|
|
820
|
+
```
|
|
821
|
+
$data = [
|
|
822
|
+
'name' => 'John Doe', // Customer name
|
|
823
|
+
'phone' => '+1234567890', // Customer phone number
|
|
824
|
+
'label' => 'Home', // Address label
|
|
825
|
+
'address' => '123 Main St, City, State, Country', // Formatted address string
|
|
826
|
+
];
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
**Source:** `app/Http/Controllers/FrontendControllers/CustomerController.php` (line 159)
|
|
830
|
+
|
|
831
|
+
**Usage:**
|
|
832
|
+
|
|
833
|
+
```
|
|
834
|
+
add_action('fluent_cart/views/checkout_page_form_address_info_wrapper', function ($data) {
|
|
835
|
+
echo '<div class="fct-address-card">';
|
|
836
|
+
echo '<strong>' . esc_html($data['name']) . '</strong>';
|
|
837
|
+
if (!empty($data['phone'])) {
|
|
838
|
+
echo '<br />' . esc_html($data['phone']);
|
|
839
|
+
}
|
|
840
|
+
echo '<br />' . esc_html($data['address']);
|
|
841
|
+
echo '</div>';
|
|
842
|
+
}, 10, 1);
|
|
843
|
+
```
|
|
844
|
+
|
|
845
|
+
---
|
|
846
|
+
|
|
847
|
+
## Bricks Builder Integration
|
|
848
|
+
|
|
849
|
+
Hooks for the Bricks page-builder template integration.
|
|
850
|
+
|
|
851
|
+
### ` fluent_cart/bricks/rendering_ajax_collection `
|
|
852
|
+
|
|
853
|
+
`fluent_cart/bricks/rendering_ajax_collection` — Before a Bricks AJAX product collection loop renders
|
|
854
|
+
|
|
855
|
+
**When it runs:** Fires inside `BricksLoader` right before the product loop is rendered for a Bricks "load more" / AJAX collection request, before output buffering for the loop begins.
|
|
856
|
+
|
|
857
|
+
**Parameters:**
|
|
858
|
+
|
|
859
|
+
None.
|
|
860
|
+
|
|
861
|
+
**Source:** `app/Modules/Templating/Bricks/BricksLoader.php:187`
|
|
862
|
+
|
|
863
|
+
**Usage:**
|
|
864
|
+
|
|
865
|
+
```
|
|
866
|
+
add_action('fluent_cart/bricks/rendering_ajax_collection', function () {
|
|
867
|
+
// Set up state needed before the Bricks product loop renders
|
|
868
|
+
my_plugin_prime_bricks_loop_context();
|
|
869
|
+
}, 10);
|
|
870
|
+
```
|
|
871
|
+
|
|
872
|
+
---
|
|
873
|
+
|
|
874
|
+
## Data Backfills
|
|
875
|
+
|
|
876
|
+
Hooks fired by the one-off data backfill routines that run in the background after a schema/data change ships (see `database/DataBackfills.php`).
|
|
877
|
+
|
|
878
|
+
### ` fluent_cart/data_backfills/chunk_selected `
|
|
879
|
+
|
|
880
|
+
`fluent_cart/data_backfills/chunk_selected` — A chunk of rows has been selected for a backfill, before the write
|
|
881
|
+
|
|
882
|
+
**When it runs:** Fires between row selection and the write for the `completed_next_billing_date` backfill, after a chunk of subscription IDs has been selected but before the UPDATE runs. A selected row can legitimately change state in this window (reactivation, gateway resync) — the subsequent UPDATE re-checks status so it never clobbers a row that changed mid-backfill.
|
|
883
|
+
|
|
884
|
+
**Parameters:**
|
|
885
|
+
|
|
886
|
+
- `$data` (array): The selected chunk
|
|
887
|
+
|
|
888
|
+
```
|
|
889
|
+
$data = [
|
|
890
|
+
'slug' => 'completed_next_billing_date', // string — which backfill routine
|
|
891
|
+
'ids' => $ids, // array<int> — subscription IDs selected for this chunk
|
|
892
|
+
];
|
|
893
|
+
```
|
|
894
|
+
|
|
895
|
+
**Source:** `database/DataBackfills.php:569`
|
|
896
|
+
|
|
897
|
+
**Usage:**
|
|
898
|
+
|
|
899
|
+
```
|
|
900
|
+
add_action('fluent_cart/data_backfills/chunk_selected', function ($data) {
|
|
901
|
+
fluent_cart_add_log(
|
|
902
|
+
'Backfill Chunk Selected',
|
|
903
|
+
sprintf('%s: %d rows selected', $data['slug'], count($data['ids'])),
|
|
904
|
+
'info'
|
|
905
|
+
);
|
|
906
|
+
}, 10, 1);
|
|
907
|
+
```
|
|
908
|
+
|
|
909
|
+
---
|
|
910
|
+
|
|
911
|
+
## Email Notifications & Digest
|
|
912
|
+
|
|
913
|
+
### ` fluent_cart/email_notification_updated `
|
|
914
|
+
|
|
915
|
+
`fluent_cart/email_notification_updated` — After an email notification's settings are saved
|
|
916
|
+
|
|
917
|
+
**When it runs:** Fires inside `EmailNotificationController::update()` after a notification's settings have been successfully persisted. Core does not persist custom fields (`settings.extra`) itself — this hook exists so an add-on can store its own custom-field data in its own storage after the core save succeeds.
|
|
918
|
+
|
|
919
|
+
**Parameters:**
|
|
920
|
+
|
|
921
|
+
- `$notification` (array): The notification's identifying data (e.g. `event`, `name`)
|
|
922
|
+
- `$settings` (array): The full settings payload that was just saved
|
|
923
|
+
|
|
924
|
+
**Source:** `app/Http/Controllers/EmailNotificationController.php:95`
|
|
925
|
+
|
|
926
|
+
**Usage:**
|
|
927
|
+
|
|
928
|
+
```
|
|
929
|
+
add_action('fluent_cart/email_notification_updated', function ($notification, $settings) {
|
|
930
|
+
// Persist a custom field that core doesn't store
|
|
931
|
+
if (isset($settings['extra']['my_custom_field'])) {
|
|
932
|
+
update_option('my_notification_extra_' . $notification['name'], $settings['extra']['my_custom_field']);
|
|
933
|
+
}
|
|
934
|
+
}, 10, 2);
|
|
935
|
+
```
|
|
936
|
+
|
|
937
|
+
### ` fluent_cart/store_digest/send `
|
|
938
|
+
|
|
939
|
+
`fluent_cart/store_digest/send` — Trigger the store performance digest email to be sent
|
|
940
|
+
|
|
941
|
+
**When it runs:** This is an **inbound** hook — FluentCart *listens* on it, and nothing in core fires it. `HourlyScheduler::register()` attaches a handler that calls `StoreDigestService::sendDigest($frequency)`, so firing this action yourself sends a digest on demand (from WP-CLI or a debugging script).
|
|
942
|
+
|
|
943
|
+
It does not observe scheduled digests
|
|
944
|
+
|
|
945
|
+
Scheduled digests do **not** pass through this hook. `HourlyScheduler::handle()` calls `StoreDigestService::runDueDigests()` directly, bypassing it. A callback added here will therefore fire only for digests *you* trigger, never for the automatic daily/weekly/monthly sends. To observe every digest, filter [`fluent_cart/store_digest/data`](./../filters/settings-and-configuration.md) or [`fluent_cart/store_digest/recipients`](./../filters/settings-and-configuration.md) instead, both of which run on the scheduled path.
|
|
946
|
+
|
|
947
|
+
**Parameters:**
|
|
948
|
+
|
|
949
|
+
- `$frequency` (string): The digest period to send — `'daily'`, `'weekly'` or `'monthly'`
|
|
950
|
+
|
|
951
|
+
**Source:** `app/Hooks/Scheduler/AutoSchedules/HourlyScheduler.php:19` (the listener FluentCart registers)
|
|
952
|
+
|
|
953
|
+
**Usage:**
|
|
954
|
+
|
|
955
|
+
```
|
|
956
|
+
// Force-send today's daily digest on demand (e.g. from wp eval-file)
|
|
957
|
+
do_action('fluent_cart/store_digest/send', 'daily');
|
|
958
|
+
```
|
|
959
|
+
|
|
960
|
+
---
|
|
961
|
+
|
|
962
|
+
## Policies / Security
|
|
963
|
+
|
|
964
|
+
Hooks that fire during REST API policy verification. These allow you to add custom security checks, rate limiting, or audit logging before the standard permission check runs.
|
|
965
|
+
|
|
966
|
+
### ` policy/store_sensitive_request `
|
|
967
|
+
|
|
968
|
+
`fluent_cart/policy/store_sensitive_request` — Store-sensitive API request verification
|
|
969
|
+
|
|
970
|
+
**When it runs:** Fires at the beginning of `StoreSensitivePolicy::verifyRequest()`, before the `store/sensitive` capability check is performed. This policy protects sensitive store operations (e.g. payment gateway configuration, API key management). Use this to add additional security measures like IP whitelisting or two-factor verification.
|
|
971
|
+
|
|
972
|
+
**Parameters:**
|
|
973
|
+
|
|
974
|
+
- `$data` (array): Request context
|
|
975
|
+
|
|
976
|
+
```
|
|
977
|
+
$data = [
|
|
978
|
+
'request' => $request, // \FluentCart\Framework\Http\Request\Request instance
|
|
979
|
+
];
|
|
980
|
+
```
|
|
981
|
+
|
|
982
|
+
**Source:** `app/Http/Policies/StoreSensitivePolicy.php` (line 11)
|
|
983
|
+
|
|
984
|
+
**Usage:**
|
|
985
|
+
|
|
986
|
+
```
|
|
987
|
+
add_action('fluent_cart/policy/store_sensitive_request', function ($data) {
|
|
988
|
+
$request = $data['request'];
|
|
989
|
+
$ip = $request->server('REMOTE_ADDR');
|
|
990
|
+
|
|
991
|
+
// Log sensitive API access attempts
|
|
992
|
+
fluent_cart_add_log(
|
|
993
|
+
'Sensitive API Access',
|
|
994
|
+
sprintf('IP: %s, Endpoint: %s', $ip, $request->url()),
|
|
995
|
+
'info'
|
|
996
|
+
);
|
|
997
|
+
}, 10, 1);
|
|
998
|
+
```
|
|
999
|
+
|
|
1000
|
+
### ` policy/store_settings_request `
|
|
1001
|
+
|
|
1002
|
+
`fluent_cart/policy/store_settings_request` — Store-settings API request verification
|
|
1003
|
+
|
|
1004
|
+
**When it runs:** Fires at the beginning of `StoreSettingsPolicy::verifyRequest()`, before the route-meta permission check (`hasRoutePermissions()`) is performed. This policy protects store settings endpoints (e.g. general settings, email templates, checkout configuration). Use this for additional validation or logging.
|
|
1005
|
+
|
|
1006
|
+
**Parameters:**
|
|
1007
|
+
|
|
1008
|
+
- `$data` (array): Request context
|
|
1009
|
+
|
|
1010
|
+
```
|
|
1011
|
+
$data = [
|
|
1012
|
+
'request' => $request, // \FluentCart\Framework\Http\Request\Request instance
|
|
1013
|
+
];
|
|
1014
|
+
```
|
|
1015
|
+
|
|
1016
|
+
**Source:** `app/Http/Policies/StoreSettingsPolicy.php` (line 11)
|
|
1017
|
+
|
|
1018
|
+
**Usage:**
|
|
1019
|
+
|
|
1020
|
+
```
|
|
1021
|
+
add_action('fluent_cart/policy/store_settings_request', function ($data) {
|
|
1022
|
+
$request = $data['request'];
|
|
1023
|
+
|
|
1024
|
+
// Restrict settings changes to specific admin users
|
|
1025
|
+
$allowedUserIds = [1, 2, 3];
|
|
1026
|
+
if (!in_array(get_current_user_id(), $allowedUserIds)) {
|
|
1027
|
+
wp_die('You are not allowed to modify store settings.', 403);
|
|
1028
|
+
}
|
|
1029
|
+
}, 10, 1);
|
|
1030
|
+
```
|
|
1031
|
+
|
|
1032
|
+
---
|
|
1033
|
+
|
|
1034
|
+
## Web Routes
|
|
1035
|
+
|
|
1036
|
+
Dynamic hooks for custom web route endpoints. Used primarily by payment gateways for IPN (Instant Payment Notification) callbacks, webhook handlers, and other server-to-server endpoints.
|
|
1037
|
+
|
|
1038
|
+
### ` fluent_cart_action_{page} `
|
|
1039
|
+
|
|
1040
|
+
`fluent_cart_action_{$page}` — Custom web route action handler (dynamic)
|
|
1041
|
+
|
|
1042
|
+
**When it runs:** Fires inside `WebRoutes` when the current FluentCart web route `$page` slug matches a registered action. After the action fires, `die()` is called immediately — your callback must handle the full response (headers, body, exit). This is typically used by payment gateway modules to register IPN/webhook listeners (e.g. `fluent_cart_action_stripe_ipn`).
|
|
1043
|
+
|
|
1044
|
+
**Parameters:**
|
|
1045
|
+
|
|
1046
|
+
- `$requestData` (array): All request parameters from `App::request()->all()`, which includes merged GET and POST data.
|
|
1047
|
+
|
|
1048
|
+
```
|
|
1049
|
+
$requestData = [
|
|
1050
|
+
// All query string and POST body parameters, e.g.:
|
|
1051
|
+
'webhook_id' => 'evt_123abc',
|
|
1052
|
+
'payment_type' => 'subscription',
|
|
1053
|
+
// ... any other request params
|
|
1054
|
+
];
|
|
1055
|
+
```
|
|
1056
|
+
|
|
1057
|
+
**Source:** `app/Http/Routes/WebRoutes.php` (line 234)
|
|
1058
|
+
|
|
1059
|
+
**Usage:**
|
|
1060
|
+
|
|
1061
|
+
```
|
|
1062
|
+
add_action('fluent_cart_action_my_gateway_ipn', function ($requestData) {
|
|
1063
|
+
// Verify the webhook signature
|
|
1064
|
+
$payload = file_get_contents('php://input');
|
|
1065
|
+
$signature = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'] ?? '';
|
|
1066
|
+
|
|
1067
|
+
if (!verify_webhook_signature($payload, $signature)) {
|
|
1068
|
+
status_header(403);
|
|
1069
|
+
echo 'Invalid signature';
|
|
1070
|
+
return; // die() is called by WebRoutes after the action
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
// Process the payment notification
|
|
1074
|
+
process_ipn_notification($requestData);
|
|
1075
|
+
|
|
1076
|
+
status_header(200);
|
|
1077
|
+
echo 'OK';
|
|
1078
|
+
}, 10, 1);
|
|
1079
|
+
```
|