Feature/daniele/checkout custom parameters by DanieleAlessandra · Pull Request #819 · Freemius/wordpress-sdk

DanieleAlessandra · 2025-08-25T18:07:08Z

This PR introduces support for additional checkout configuration properties in the SDK initializer.

What’s new

The following properties are now recognized during initialization:

// currency
'currency'                      => 'string',
'default_currency'              => 'string',
// cart
'always_show_renewals_amount'   => 'bool',
'annual_discount'               => 'bool',
'billing_cycle'                 => ['string', 'int'],
'bundle_discount'               => 'float',
'maximize_discounts'            => 'bool',
'multisite_discount'            => ['bool', 'string'], // string expected to be "auto"
'show_inline_currency_selector' => 'bool',
'show_monthly'                  => 'bool',
// appearance
'form_position'                 => 'string',
'is_bundle_collapsed'           => 'bool',
'layout'                        => 'string',
'refund_policy_position'        => 'string',
'show_refund_badge'             => 'bool',
'show_reviews'                  => 'bool',
'show_upsells'                  => 'bool',
'title'                         => 'string',

Behavior
• If these properties exist in the initialization config, they are validated and stored.
• When opening the checkout (both iframe and redirect modes), the provided values are automatically passed along to the checkout context.

This allows developers to customize the checkout flow appearance and cart behavior more flexibly directly from the SDK initialization.

fajardoleo · 2025-10-03T08:05:04Z

includes/class-freemius.php

+        protected $_checkout_config = [];
+
+        /**
+


@DanieleAlessandra An extra line.

fajardoleo · 2025-10-03T08:06:11Z

includes/class-freemius.php

+         *
+         * @return array
+         */
+        protected function validate_checkout_config($config)


@DanieleAlessandra Missing spaces around $config.

fajardoleo · 2025-10-03T08:07:31Z

includes/class-freemius.php

+
+            $result = array();
+
+            foreach ($schema as $key => $expected_type)


@DanieleAlessandra Please check the spaces.

fajardoleo · 2025-10-03T08:07:46Z

includes/class-freemius.php

+
+            foreach ($schema as $key => $expected_type)
+            {
+                if (array_key_exists($key, $config))


@DanieleAlessandra Spaces

fajardoleo · 2025-10-03T08:08:08Z

includes/class-freemius.php

+                        switch ($type)
+                        {
+                            case 'bool':
+                                if (is_bool($value))


@DanieleAlessandra Curly braces

fajardoleo · 2025-10-03T08:08:21Z

includes/class-freemius.php

+         * @return array
+         */
+        public function get_checkout_config()
+        {


@DanieleAlessandra Curly braces :)

fajardoleo · 2025-10-03T08:11:39Z

includes/class-freemius.php

+                // cart
+                'always_show_renewals_amount'   => 'bool',
+                'annual_discount'               => 'bool',
+                'billing_cycle'                 => ['string', 'int'],


@DanieleAlessandra Please check this out:
https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#declaring-arrays

Long array syntax.

# Conflicts: # start.php

Introduce a namespaced filter to let developers add/modify query params sent to Freemius Checkout. • Add fs_apply_filter( $fs->get_unique_affix(), 'checkout_query_params', ... )

Introduced the private $_allowed_custom_params property to define all supported custom query parameters for the checkout. After applying `fs_apply_filter()`, the function now filters `$filtered_params` using `array_intersect_key()` to remove any unsupported keys before merging. This prevents external filters from injecting unexpected parameters into the checkout query.

swashata

@DanieleAlessandra this is a very good approach, please see the small tweaks I suggested.

includes/managers/class-fs-checkout-manager.php

swashata · 2025-11-10T09:17:44Z

includes/managers/class-fs-checkout-manager.php

 			);

-			return array_merge( $context_params, $_GET, array(
+            /**


Remove this doc block please. See that it is already stale. Instead

See the start.php and see we have list of Freemius filters collection, just add the filter there.

Later we will update our docs https://freemius.com/help/documentation/wordpress-sdk/filters-actions-hooks/

swashata · 2025-11-10T09:18:09Z

includes/managers/class-fs-checkout-manager.php

+             * @param int|mixed $plan_id       The selected plan ID (if any).
+             * @param int|mixed $licenses      The requested number of licenses (if provided).
+             */
+            $filtered_params = fs_apply_filter(


Why not

$filtered_params = $fs->apply_filters('checkout_query_params', $context_params);

@DanieleAlessandra let's call the filter

checkout/configuration

Following we already have this https://freemius.com/help/documentation/wordpress-sdk/filters-actions-hooks/#checkoutpurchasedcompleted

swashata · 2025-11-10T09:26:51Z

includes/managers/class-fs-checkout-manager.php

+            'show_refund_badge'             => 'bool',
+            'show_reviews'                  => 'bool',
+            'show_upsells'                  => 'bool',
+            'title'                         => 'string',


@DanieleAlessandra let's add the billing_cycle_selector in the list as well.

swashata

Nicely done 👏

DanieleAlessandra requested a review from fajardoleo August 25, 2025 18:07

DanieleAlessandra force-pushed the feature/daniele/checkout-custom-parameters branch from 6ab27a1 to b394995 Compare September 15, 2025 16:13

fajardoleo reviewed Oct 3, 2025

View reviewed changes

includes/class-freemius.php Outdated

protected $_checkout_config = [];

/**

Copy link

Contributor

fajardoleo Oct 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DanieleAlessandra An extra line.

fajardoleo reviewed Oct 3, 2025

View reviewed changes

includes/class-freemius.php Outdated

switch ($type)

{

case 'bool':

if (is_bool($value))

Copy link

Contributor

fajardoleo Oct 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DanieleAlessandra Curly braces

fajardoleo reviewed Oct 3, 2025

View reviewed changes

DanieleFreemius added 2 commits November 6, 2025 14:18

Added checkout customization parameters

f786566

# Conflicts: # start.php

Flat checkout properties

f97701f

DanieleAlessandra force-pushed the feature/daniele/checkout-custom-parameters branch 2 times, most recently from e760ad5 to 0ee6bea Compare November 6, 2025 13:22

feat(checkout): allow customizing checkout query params via filter

c96efc6

Introduce a namespaced filter to let developers add/modify query params sent to Freemius Checkout. • Add fs_apply_filter( $fs->get_unique_affix(), 'checkout_query_params', ... )

DanieleAlessandra force-pushed the feature/daniele/checkout-custom-parameters branch from 0ee6bea to c96efc6 Compare November 6, 2025 13:28

swashata requested changes Nov 10, 2025

View reviewed changes

swashata reviewed Nov 10, 2025

View reviewed changes

Changed filter name to checkout/parameters, code clean and small fixes

7c6d825

swashata approved these changes Nov 10, 2025

View reviewed changes

swashata merged commit 680d9cf into develop Nov 10, 2025
5 checks passed

swashata deleted the feature/daniele/checkout-custom-parameters branch November 10, 2025 10:52


		$result = array();

		foreach ($schema as $key => $expected_type)

Conversation

DanieleAlessandra commented Aug 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swashata left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swashata left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants