From 6d797787aa045f645dcf02853db1f554629173ff Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 22:37:39 -0700 Subject: [PATCH 01/32] Move tracking opt-in to general settings and onboarding wizard --- inc/class-settings.php | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/inc/class-settings.php b/inc/class-settings.php index f6e111cf..be022253 100644 --- a/inc/class-settings.php +++ b/inc/class-settings.php @@ -708,6 +708,22 @@ public function default_sections(): void { 120 ); + $this->add_field( + 'general', + 'enable_error_reporting', + [ + 'title' => __('Help Improve Ultimate Multisite', 'ultimate-multisite'), + 'desc' => sprintf( + /* translators: %s is a link to the privacy policy */ + __('Allow Ultimate Multisite to collect anonymous usage data and error reports to help us improve the plugin. We collect: PHP version, WordPress version, plugin version, network type (subdomain/subdirectory), aggregate counts (sites, memberships), active gateways, and error logs. We never collect personal data, customer information, or domain names. Learn more.', 'ultimate-multisite'), + 'https://ultimatemultisite.com/privacy-policy/' + ), + 'type' => 'toggle', + 'default' => 0, + ], + 130 + ); + /* * Login & Registration * This section holds the Login & Registration settings of the Ultimate Multisite Plugin. @@ -1730,21 +1746,6 @@ public function default_sections(): void { ] ); - $this->add_field( - 'other', - 'enable_error_reporting', - [ - 'title' => __('Help Improve Ultimate Multisite', 'ultimate-multisite'), - 'desc' => sprintf( - /* translators: %s is a link to the privacy policy */ - __('Allow Ultimate Multisite to collect anonymous usage data and error reports to help us improve the plugin. We collect: PHP version, WordPress version, plugin version, network type (subdomain/subdirectory), aggregate counts (sites, memberships), active gateways, and error logs. We never collect personal data, customer information, or domain names. Learn more.', 'ultimate-multisite'), - 'https://ultimatemultisite.com/privacy-policy/' - ), - 'type' => 'toggle', - 'default' => 0, - ] - ); - $this->add_field( 'other', 'advanced_header', From c101dc4d70084303e48f5ada25a4c56a203dd16a Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 22:44:02 -0700 Subject: [PATCH 02/32] better error logging and handling of user accounts unable to connect to addon store --- inc/class-addon-repository.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/inc/class-addon-repository.php b/inc/class-addon-repository.php index 8bcb0550..ca02fd5d 100644 --- a/inc/class-addon-repository.php +++ b/inc/class-addon-repository.php @@ -1,7 +1,12 @@ get_error_message()), (int) $request->get_error_code()); + wu_log_add('api-calls', $request->get_error_message(), LogLevel::ERROR); + $this->delete_tokens(); } if (200 === absint($code) && 'OK' === $message) { $user = json_decode($body, true); From 0f94b89318317d961c8e6a5abe7f787c8143b22b Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 22:46:39 -0700 Subject: [PATCH 03/32] add recommended html attr --- inc/ui/class-login-form-element.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/inc/ui/class-login-form-element.php b/inc/ui/class-login-form-element.php index 1374379b..137b5e29 100644 --- a/inc/ui/class-login-form-element.php +++ b/inc/ui/class-login-form-element.php @@ -771,12 +771,18 @@ public function output($atts, $content = null): void { 'title' => $atts['label_username'], 'placeholder' => $atts['placeholder_username'], 'tooltip' => '', + 'html_attr' => [ + 'autocomplete' => 'username', + ], ], 'pwd' => [ 'type' => 'password', 'title' => $atts['label_password'], 'placeholder' => $atts['placeholder_password'], 'tooltip' => '', + 'html_attr' => [ + 'autocomplete' => 'current-password', + ], ], ]; From a1df46f71f836139cdf32428ef37214b9cacc5f9 Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 22:47:01 -0700 Subject: [PATCH 04/32] allow kses to be extended --- inc/functions/helper.php | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/inc/functions/helper.php b/inc/functions/helper.php index ae1729c0..409686d7 100644 --- a/inc/functions/helper.php +++ b/inc/functions/helper.php @@ -105,7 +105,7 @@ function wu_slugify($term) { */ function wu_path($dir): string { - return WP_ULTIMO_PLUGIN_DIR . $dir; // @phpstan-ignore-line + return WP_ULTIMO_PLUGIN_DIR . $dir; } /** @@ -117,7 +117,7 @@ function wu_path($dir): string { */ function wu_url($dir) { - return apply_filters('wp_ultimo_url', WP_ULTIMO_PLUGIN_URL . $dir); // @phpstan-ignore-line + return apply_filters('wp_ultimo_url', WP_ULTIMO_PLUGIN_URL . $dir); } /** @@ -294,8 +294,7 @@ function wu_ignore_errors($func, $log = false) { // phpcs:ignore Generic.CodeAna try { call_user_func($func); - } catch (\Throwable $exception) { - + } catch (\Throwable $exception) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch // Ignore it or log it. } } @@ -496,7 +495,7 @@ function wu_kses_allowed_html(): array { 'template' => true, ]; - return [ + $allowed_tags = [ 'svg' => $svg_attributes + [ 'width' => true, 'height' => true, @@ -613,4 +612,15 @@ function wu_kses_allowed_html(): array { 'height' => true, ], ] + array_merge_recursive($allowed_html, array_fill_keys(array_keys($allowed_html) + ['div', 'span', 'p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'strong', 'em', 'b', 'i', 'ul', 'ol', 'li', 'a', 'img', 'input', 'textarea'], $vue_and_data_attributes)); + + /** + * Filters the allowed HTML tags and attributes. + * + * Allows addons to extend the allowed HTML elements for wp_kses sanitization. + * + * @since 2.5.0 + * + * @param array $allowed_tags The allowed HTML tags and attributes. + */ + return apply_filters('wu_kses_allowed_html', $allowed_tags); } From d0bc5952f455dedc87e18d0211168847b66140d2 Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 22:47:34 -0700 Subject: [PATCH 05/32] add settings api --- inc/apis/class-settings-endpoint.php | 439 +++++++++++++++++++++++++++ inc/class-wp-ultimo.php | 5 + 2 files changed, 444 insertions(+) create mode 100644 inc/apis/class-settings-endpoint.php diff --git a/inc/apis/class-settings-endpoint.php b/inc/apis/class-settings-endpoint.php new file mode 100644 index 00000000..2ab6476c --- /dev/null +++ b/inc/apis/class-settings-endpoint.php @@ -0,0 +1,439 @@ +get_namespace(); + + // GET /settings - Retrieve all settings + register_rest_route( + $namespace, + '/settings', + [ + 'methods' => \WP_REST_Server::READABLE, + 'callback' => [$this, 'get_settings'], + 'permission_callback' => \Closure::fromCallable([$api, 'check_authorization']), + ] + ); + + // GET /settings/{setting_key} - Retrieve a specific setting + register_rest_route( + $namespace, + '/settings/(?P[a-zA-Z0-9_-]+)', + [ + 'methods' => \WP_REST_Server::READABLE, + 'callback' => [$this, 'get_setting'], + 'permission_callback' => \Closure::fromCallable([$api, 'check_authorization']), + 'args' => [ + 'setting_key' => [ + 'description' => __('The setting key to retrieve.', 'ultimate-multisite'), + 'type' => 'string', + 'required' => true, + 'sanitize_callback' => 'sanitize_key', + ], + ], + ] + ); + + // POST /settings - Update multiple settings + register_rest_route( + $namespace, + '/settings', + [ + 'methods' => \WP_REST_Server::CREATABLE, + 'callback' => [$this, 'update_settings'], + 'permission_callback' => \Closure::fromCallable([$api, 'check_authorization']), + 'args' => $this->get_update_args(), + ] + ); + + // PUT/PATCH /settings/{setting_key} - Update a specific setting + register_rest_route( + $namespace, + '/settings/(?P[a-zA-Z0-9_-]+)', + [ + 'methods' => \WP_REST_Server::EDITABLE, + 'callback' => [$this, 'update_setting'], + 'permission_callback' => \Closure::fromCallable([$api, 'check_authorization']), + 'args' => [ + 'setting_key' => [ + 'description' => __('The setting key to update.', 'ultimate-multisite'), + 'type' => 'string', + 'required' => true, + 'sanitize_callback' => 'sanitize_key', + ], + 'value' => [ + 'description' => __('The new value for the setting.', 'ultimate-multisite'), + 'required' => true, + ], + ], + ] + ); + } + + /** + * Get all settings. + * + * @since 2.4.0 + * + * @param \WP_REST_Request $request WP Request Object. + * @return \WP_REST_Response + */ + public function get_settings($request) { + + $this->maybe_log_api_call($request); + + $settings = wu_get_all_settings(); + + // Remove sensitive settings from the response + $settings = $this->filter_sensitive_settings($settings); + + return rest_ensure_response( + [ + 'success' => true, + 'settings' => $settings, + ] + ); + } + + /** + * Get a specific setting. + * + * @since 2.4.0 + * + * @param \WP_REST_Request $request WP Request Object. + * @return \WP_REST_Response|\WP_Error + */ + public function get_setting($request) { + + $this->maybe_log_api_call($request); + + $setting_key = $request->get_param('setting_key'); + + // Check if this is a sensitive setting + if ($this->is_sensitive_setting($setting_key)) { + return new \WP_Error( + 'setting_protected', + __('This setting is protected and cannot be retrieved via the API.', 'ultimate-multisite'), + ['status' => 403] + ); + } + + $value = wu_get_setting($setting_key, null); + + if (null === $value) { + // Check if setting exists (even with null/false value) vs doesn't exist + $all_settings = wu_get_all_settings(); + + if (! array_key_exists($setting_key, $all_settings)) { + return new \WP_Error( + 'setting_not_found', + sprintf( + /* translators: %s is the setting key */ + __('Setting "%s" not found.', 'ultimate-multisite'), + $setting_key + ), + ['status' => 404] + ); + } + } + + return rest_ensure_response( + [ + 'success' => true, + 'setting_key' => $setting_key, + 'value' => $value, + ] + ); + } + + /** + * Update multiple settings. + * + * @since 2.4.0 + * + * @param \WP_REST_Request $request WP Request Object. + * @return \WP_REST_Response|\WP_Error + */ + public function update_settings($request) { + + $this->maybe_log_api_call($request); + + $params = $request->get_json_params(); + + if (empty($params) || ! is_array($params)) { + $params = $request->get_body_params(); + } + + $settings_to_update = wu_get_isset($params, 'settings', $params); + + if (empty($settings_to_update) || ! is_array($settings_to_update)) { + return new \WP_Error( + 'invalid_settings', + __('No valid settings provided. Please provide a "settings" object with key-value pairs.', 'ultimate-multisite'), + ['status' => 400] + ); + } + + // Validate and filter out sensitive settings + $errors = []; + $filtered_settings = []; + + foreach ($settings_to_update as $key => $value) { + if ($this->is_sensitive_setting($key)) { + $errors[] = sprintf( + /* translators: %s is the setting key */ + __('Setting "%s" is protected and cannot be modified via the API.', 'ultimate-multisite'), + $key + ); + continue; + } + + // Validate setting key format + $sanitized_key = sanitize_key($key); + if ($sanitized_key !== $key) { + $errors[] = sprintf( + /* translators: %s is the setting key */ + __('Invalid setting key format: "%s".', 'ultimate-multisite'), + $key + ); + continue; + } + + $filtered_settings[ $key ] = $value; + } + + if (empty($filtered_settings)) { + return new \WP_Error( + 'no_valid_settings', + __('No valid settings to update after filtering.', 'ultimate-multisite'), + [ + 'status' => 400, + 'errors' => $errors, + ] + ); + } + + // Save each setting + $updated = []; + $failed = []; + + foreach ($filtered_settings as $key => $value) { + $result = wu_save_setting($key, $value); + + if ($result) { + $updated[] = $key; + } else { + $failed[] = $key; + } + } + + $response_data = [ + 'success' => ! empty($updated), + 'updated' => $updated, + ]; + + if (! empty($failed)) { + $response_data['failed'] = $failed; + } + + if (! empty($errors)) { + $response_data['warnings'] = $errors; + } + + return rest_ensure_response($response_data); + } + + /** + * Update a specific setting. + * + * @since 2.4.0 + * + * @param \WP_REST_Request $request WP Request Object. + * @return \WP_REST_Response|\WP_Error + */ + public function update_setting($request) { + + $this->maybe_log_api_call($request); + + $setting_key = $request->get_param('setting_key'); + + // Check if this is a sensitive setting + if ($this->is_sensitive_setting($setting_key)) { + return new \WP_Error( + 'setting_protected', + __('This setting is protected and cannot be modified via the API.', 'ultimate-multisite'), + ['status' => 403] + ); + } + + $params = $request->get_json_params(); + + if (empty($params)) { + $params = $request->get_body_params(); + } + + $value = wu_get_isset($params, 'value'); + + if (! isset($params['value'])) { + return new \WP_Error( + 'missing_value', + __('The "value" parameter is required.', 'ultimate-multisite'), + ['status' => 400] + ); + } + + $result = wu_save_setting($setting_key, $value); + + if (! $result) { + return new \WP_Error( + 'update_failed', + sprintf( + /* translators: %s is the setting key */ + __('Failed to update setting "%s".', 'ultimate-multisite'), + $setting_key + ), + ['status' => 500] + ); + } + + return rest_ensure_response( + [ + 'success' => true, + 'setting_key' => $setting_key, + 'value' => wu_get_setting($setting_key), + ] + ); + } + + /** + * Get the arguments schema for the update endpoint. + * + * @since 2.4.0 + * @return array + */ + protected function get_update_args(): array { + + return [ + 'settings' => [ + 'description' => __('An object containing setting key-value pairs to update.', 'ultimate-multisite'), + 'type' => 'object', + 'required' => false, + ], + ]; + } + + /** + * Check if a setting is sensitive and should not be exposed via API. + * + * @since 2.4.0 + * + * @param string $setting_key The setting key to check. + * @return bool + */ + protected function is_sensitive_setting(string $setting_key): bool { + + $sensitive_settings = [ + 'api_key', + 'api_secret', + 'stripe_api_sk_live', + 'stripe_api_sk_test', + 'paypal_client_secret_live', + 'paypal_client_secret_sandbox', + ]; + + /** + * Filter the list of sensitive settings that should not be exposed via API. + * + * @since 2.4.0 + * + * @param array $sensitive_settings List of sensitive setting keys. + * @param string $setting_key The setting key being checked. + */ + $sensitive_settings = apply_filters('wu_api_sensitive_settings', $sensitive_settings, $setting_key); + + return in_array($setting_key, $sensitive_settings, true); + } + + /** + * Filter out sensitive settings from a settings array. + * + * @since 2.4.0 + * + * @param array $settings The settings array to filter. + * @return array + */ + protected function filter_sensitive_settings(array $settings): array { + + foreach ($settings as $key => $value) { + if ($this->is_sensitive_setting($key)) { + unset($settings[ $key ]); + } + } + + return $settings; + } + + /** + * Log API call if logging is enabled. + * + * @since 2.4.0 + * + * @param \WP_REST_Request $request The request object. + * @return void + */ + protected function maybe_log_api_call($request): void { + + if (\WP_Ultimo\API::get_instance()->should_log_api_calls()) { + $payload = [ + 'route' => $request->get_route(), + 'method' => $request->get_method(), + 'url_params' => $request->get_url_params(), + 'body_params' => $request->get_body(), + ]; + + wu_log_add('api-calls', wp_json_encode($payload, JSON_PRETTY_PRINT)); + } + } +} diff --git a/inc/class-wp-ultimo.php b/inc/class-wp-ultimo.php index 1ff69b9a..029ea638 100644 --- a/inc/class-wp-ultimo.php +++ b/inc/class-wp-ultimo.php @@ -540,6 +540,11 @@ protected function load_extra_components(): void { */ \WP_Ultimo\API\Register_Endpoint::get_instance(); + /* + * Loads API settings endpoint. + */ + \WP_Ultimo\API\Settings_Endpoint::get_instance(); + /* * Loads Documentation */ From 58d27e59916b7f5b18f874e7b4522971c4badc7d Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 22:50:15 -0700 Subject: [PATCH 06/32] Fix problems with choosing country and state --- readme.txt | 7 +++++++ views/checkout/fields/field-select.php | 6 ++++++ views/checkout/fields/field-text.php | 10 +++++++++- 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/readme.txt b/readme.txt index 1f72355c..86c53f96 100644 --- a/readme.txt +++ b/readme.txt @@ -240,16 +240,23 @@ We recommend running this in a staging environment before updating your producti == Changelog == +Version [2.4.10] - Released on 2026-XX-XX +- New: Settings API +- Fix: Problems with choosing country and state + + Version [2.4.10] - Released on 2026-01-23 - New: Configurable minimum password strength setting with Medium, Strong, and Super Strong options. - New: Super Strong password requirements include 12+ characters, uppercase, lowercase, numbers, and special characters - compatible with WPMU DEV Defender Pro rules. - New: Real-time password requirement hints during checkout with translatable strings. - New: Themed password field styling with visibility toggle and color fallbacks for page builders (Elementor, Kadence, Beaver Builder). - New: Opt-in anonymous usage tracking to help improve the plugin. +- New: Better error page for customers and admins. - New: Rating reminder notice after 30 days of installation. - New: WooCommerce Subscriptions compatibility layer for site duplication. - Improved: JSON response handling for pending site creation in non-FastCGI environments. + Version [2.4.9] - Released on 2025-12-23 - New: Inline login prompt at checkout for existing users - returning customers can sign in directly without leaving the checkout flow. - New: GitHub Actions workflow for PR builds with WordPress Playground testing - enables one-click browser-based testing of pull requests. diff --git a/views/checkout/fields/field-select.php b/views/checkout/fields/field-select.php index 2f0d0ca1..2008bb17 100644 --- a/views/checkout/fields/field-select.php +++ b/views/checkout/fields/field-select.php @@ -26,10 +26,16 @@ ?> + html_attr['v-bind:name']); + ?> print_html_attributes(); ?>> + html_attr['v-bind:name']); + ?> + + name="id); ?>" type="type); ?>" placeholder="placeholder); ?>" value="value); ?>" print_html_attributes(); ?>> suffix) : ?> From 9998c0022f42a3670f1135752392d33d976b7d00 Mon Sep 17 00:00:00 2001 From: David Stone Date: Sat, 24 Jan 2026 23:23:27 -0700 Subject: [PATCH 07/32] Fix login redirect --- inc/checkout/class-checkout-pages.php | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/inc/checkout/class-checkout-pages.php b/inc/checkout/class-checkout-pages.php index 66c1e47c..b316e0ed 100644 --- a/inc/checkout/class-checkout-pages.php +++ b/inc/checkout/class-checkout-pages.php @@ -37,19 +37,28 @@ public function init(): void { add_filter('lostpassword_redirect', [$this, 'filter_lost_password_redirect']); + $use_custom_login = wu_get_setting('enable_custom_login_page', false); + + /* + * Login URL filters need to run on ALL sites (including subsites) + * so that password reset and login links redirect to the main site's + * custom login page instead of wp-login.php (which may be obfuscated). + * + * @see https://github.com/Ultimate-Multisite/ultimate-multisite/issues/291 + */ + if ($use_custom_login) { + add_filter('login_url', [$this, 'filter_login_url'], 10, 3); + + add_filter('lostpassword_url', [$this, 'filter_login_url'], 10, 3); + } + if (is_main_site()) { add_action('before_signup_header', [$this, 'redirect_to_registration_page']); - $use_custom_login = wu_get_setting('enable_custom_login_page', false); - if ( ! $use_custom_login) { return; } - add_filter('login_url', [$this, 'filter_login_url'], 10, 3); - - add_filter('lostpassword_url', [$this, 'filter_login_url'], 10, 3); - add_filter('retrieve_password_message', [$this, 'replace_reset_password_link'], 10, 4); add_filter('network_site_url', [$this, 'maybe_change_wp_login_on_urls']); From a5b944de80bfd14cfc3892ca9b1ad7a5354d4625 Mon Sep 17 00:00:00 2001 From: David Stone Date: Wed, 28 Jan 2026 22:30:22 -0700 Subject: [PATCH 08/32] Add support for pay what you want prices --- .../class-product-edit-admin-page.php | 134 ++++++++-- inc/checkout/class-cart.php | 178 +++++++++++--- inc/checkout/class-checkout.php | 24 +- inc/models/class-product.php | 230 ++++++++++++++++-- 4 files changed, 476 insertions(+), 90 deletions(-) diff --git a/inc/admin-pages/class-product-edit-admin-page.php b/inc/admin-pages/class-product-edit-admin-page.php index dd6b0637..19882ce5 100644 --- a/inc/admin-pages/class-product-edit-admin-page.php +++ b/inc/admin-pages/class-product-edit-admin-page.php @@ -274,30 +274,32 @@ public function register_widgets(): void { 'data-wu-app' => 'product_pricing', 'data-state' => wp_json_encode( [ - 'is_recurring' => $this->get_object()->is_recurring(), - 'pricing_type' => $this->get_object()->get_pricing_type(), - 'has_trial' => $this->get_object()->get_trial_duration() > 0, - 'has_setup_fee' => $this->get_object()->has_setup_fee(), - 'setup_fee' => $this->get_object()->get_setup_fee(), - 'amount' => $this->get_object()->get_formatted_amount(), - 'duration' => $this->get_object()->get_duration(), - 'duration_unit' => $this->get_object()->get_duration_unit(), + 'is_recurring' => $this->get_object()->is_recurring(), + 'pricing_type' => $this->get_object()->get_pricing_type(), + 'has_trial' => $this->get_object()->get_trial_duration() > 0, + 'has_setup_fee' => $this->get_object()->has_setup_fee(), + 'setup_fee' => $this->get_object()->get_setup_fee(), + 'amount' => $this->get_object()->get_formatted_amount(), + 'duration' => $this->get_object()->get_duration(), + 'duration_unit' => $this->get_object()->get_duration_unit(), + 'pwyw_recurring_mode' => $this->get_object()->get_pwyw_recurring_mode() ?: 'customer_choice', ] ), ], 'fields' => [ // Fields for price - 'pricing_type' => [ + 'pricing_type' => [ 'type' => 'select', 'title' => __('Pricing Type', 'ultimate-multisite'), 'placeholder' => __('Select Pricing Type', 'ultimate-multisite'), - 'desc' => __('Products can be free, paid, or require further contact for pricing.', 'ultimate-multisite'), + 'desc' => __('Products can be free, paid, pay what you want, or require further contact for pricing.', 'ultimate-multisite'), 'value' => $this->get_object()->get_pricing_type(), 'tooltip' => '', 'options' => [ - 'paid' => __('Paid', 'ultimate-multisite'), - 'free' => __('Free', 'ultimate-multisite'), - 'contact_us' => __('Contact Us', 'ultimate-multisite'), + 'paid' => __('Paid', 'ultimate-multisite'), + 'free' => __('Free', 'ultimate-multisite'), + 'pay_what_you_want' => __('Pay What You Want', 'ultimate-multisite'), + 'contact_us' => __('Contact Us', 'ultimate-multisite'), ], 'wrapper_html_attr' => [ 'v-cloak' => '1', @@ -306,7 +308,7 @@ public function register_widgets(): void { 'v-model' => 'pricing_type', ], ], - 'contact_us_label' => [ + 'contact_us_label' => [ 'type' => 'text', 'title' => __('Button Label', 'ultimate-multisite'), 'placeholder' => __('E.g. Contact us', 'ultimate-multisite'), @@ -317,7 +319,7 @@ public function register_widgets(): void { 'v-cloak' => '1', ], ], - 'contact_us_link' => [ + 'contact_us_link' => [ 'type' => 'url', 'title' => __('Button Link', 'ultimate-multisite'), 'placeholder' => __('E.g. https://contactus.page.com', 'ultimate-multisite'), @@ -328,7 +330,89 @@ public function register_widgets(): void { 'v-cloak' => '1', ], ], - 'recurring' => [ + 'pwyw_minimum_amount' => [ + 'type' => 'text', + 'title' => __('Minimum Price', 'ultimate-multisite'), + 'placeholder' => wu_format_currency('0'), + 'desc' => __('The minimum amount customers can pay. Leave at 0 for truly "pay what you want".', 'ultimate-multisite'), + 'value' => $this->get_object()->get_pwyw_minimum_amount(), + 'money' => true, + 'wrapper_html_attr' => [ + 'v-show' => "pricing_type == 'pay_what_you_want'", + 'v-cloak' => '1', + ], + ], + 'pwyw_suggested_amount' => [ + 'type' => 'text', + 'title' => __('Suggested Price', 'ultimate-multisite'), + 'placeholder' => wu_format_currency('0'), + 'desc' => __('A suggested price shown as the default value in the price input.', 'ultimate-multisite'), + 'value' => $this->get_object()->get_pwyw_suggested_amount(), + 'money' => true, + 'wrapper_html_attr' => [ + 'v-show' => "pricing_type == 'pay_what_you_want'", + 'v-cloak' => '1', + ], + ], + 'pwyw_recurring_mode' => [ + 'type' => 'select', + 'title' => __('Recurring Mode', 'ultimate-multisite'), + 'desc' => __('Control whether customers can choose between one-time and recurring payments.', 'ultimate-multisite'), + 'value' => $this->get_object()->get_pwyw_recurring_mode(), + 'options' => [ + 'customer_choice' => __('Customer Chooses (One-time or Recurring)', 'ultimate-multisite'), + 'force_recurring' => __('Force Recurring Only', 'ultimate-multisite'), + 'force_one_time' => __('Force One-time Only', 'ultimate-multisite'), + ], + 'wrapper_html_attr' => [ + 'v-show' => "pricing_type == 'pay_what_you_want'", + 'v-cloak' => '1', + ], + 'html_attr' => [ + 'v-model' => 'pwyw_recurring_mode', + ], + ], + 'pwyw_duration_group' => [ + 'type' => 'group', + 'title' => __('Billing Period', 'ultimate-multisite'), + 'desc' => __('The billing period for recurring PWYW payments. Only applies when recurring is enabled.', 'ultimate-multisite'), + 'wrapper_html_attr' => [ + 'v-show' => "pricing_type == 'pay_what_you_want' && pwyw_recurring_mode != 'force_one_time'", + 'v-cloak' => '1', + ], + 'fields' => [ + 'duration' => [ + 'type' => 'number', + 'value' => $this->get_object()->get_duration(), + 'placeholder' => 1, + 'wrapper_classes' => 'wu-w-1/2', + 'min' => 1, + 'html_attr' => [ + 'v-model' => 'duration', + 'v-bind:name' => '""', + 'steps' => 1, + 'v-on:keypress' => 'numeric_only', + ], + ], + 'duration_unit' => [ + 'type' => 'select', + 'value' => $this->get_object()->get_duration_unit(), + 'placeholder' => '', + 'wrapper_classes' => 'wu-w-1/2 wu-ml-2', + 'html_attr' => [ + 'v-model' => 'duration_unit', + 'v-bind:name' => '""', + ], + 'options' => [ + 'day' => __('Day(s)', 'ultimate-multisite'), + 'week' => __('Week(s)', 'ultimate-multisite'), + 'month' => __('Month(s)', 'ultimate-multisite'), + 'year' => __('Year(s)', 'ultimate-multisite'), + ], + ], + ], + ], + 'recurring' => [ 'type' => 'toggle', 'title' => __('Is Recurring?', 'ultimate-multisite'), 'desc' => __('Check this if this product has a recurring charge.', 'ultimate-multisite'), @@ -341,13 +425,13 @@ public function register_widgets(): void { 'v-model' => 'is_recurring', ], ], - 'amount' => [ + 'amount' => [ 'type' => 'hidden', 'html_attr' => [ 'v-model' => 'amount', ], ], - '_amount' => [ + '_amount' => [ 'type' => 'text', 'title' => __('Price', 'ultimate-multisite'), 'placeholder' => __('Price', 'ultimate-multisite'), @@ -363,7 +447,7 @@ public function register_widgets(): void { 'v-model' => 'amount', ], ], - 'amount_group' => [ + 'amount_group' => [ 'type' => 'group', 'title' => __('Price', 'ultimate-multisite'), // translators: placeholder %1$s is the amount, %2$s is the duration (such as 1, 2, 3), and %3$s is the unit (such as month, year, week) @@ -413,7 +497,7 @@ public function register_widgets(): void { ], ], ], - 'billing_cycles' => [ + 'billing_cycles' => [ 'type' => 'number', 'title' => __('Billing Cycles', 'ultimate-multisite'), 'placeholder' => __('E.g. 1', 'ultimate-multisite'), @@ -425,7 +509,7 @@ public function register_widgets(): void { 'v-cloak' => '1', ], ], - 'has_trial' => [ + 'has_trial' => [ 'type' => 'toggle', 'title' => __('Offer Trial', 'ultimate-multisite'), 'desc' => __('Check if you want to add a trial period to this product.', 'ultimate-multisite'), @@ -438,7 +522,7 @@ public function register_widgets(): void { 'v-model' => 'has_trial', ], ], - 'trial_group' => [ + 'trial_group' => [ 'type' => 'group', 'title' => __('Trial', 'ultimate-multisite'), 'tooltip' => '', @@ -467,7 +551,7 @@ public function register_widgets(): void { ], ], ], - 'has_setup_fee' => [ + 'has_setup_fee' => [ 'type' => 'toggle', 'title' => __('Add Setup Fee?', 'ultimate-multisite'), 'desc' => __('Check if you want to add a setup fee.', 'ultimate-multisite'), @@ -480,13 +564,13 @@ public function register_widgets(): void { 'v-model' => 'has_setup_fee', ], ], - 'setup_fee' => [ + 'setup_fee' => [ 'type' => 'hidden', 'html_attr' => [ 'v-model' => 'setup_fee', ], ], - '_setup_fee' => [ + '_setup_fee' => [ 'type' => 'text', 'money' => true, 'title' => __('Setup Fee', 'ultimate-multisite'), diff --git a/inc/checkout/class-cart.php b/inc/checkout/class-cart.php index 053c5471..f9dd93d9 100644 --- a/inc/checkout/class-cart.php +++ b/inc/checkout/class-cart.php @@ -229,6 +229,22 @@ class Cart implements \JsonSerializable { */ protected $extra = []; + /** + * Custom amounts for PWYW products. + * + * @since 2.0.0 + * @var array + */ + protected $custom_amounts = []; + + /** + * Customer's recurring choice for PWYW products. + * + * @since 2.0.0 + * @var array + */ + protected $pwyw_recurring = []; + /** * The cart description. * @@ -260,54 +276,66 @@ public function __construct($args) { /* * Cart Type. */ - 'cart_type' => 'new', + 'cart_type' => 'new', /* * The list of products being bought. */ - 'products' => [], + 'products' => [], /* * The duration parameters * This will dictate which price variations we are going to use. */ - 'duration' => false, - 'duration_unit' => false, + 'duration' => false, + 'duration_unit' => false, /* * The membership ID. * This is passed when we want to handle a upgrade/downgrade/addon. */ - 'membership_id' => false, + 'membership_id' => false, /* * Payment ID. * This is passed when we are trying to recovered a abandoned/pending payment. */ - 'payment_id' => false, + 'payment_id' => false, /* * The discount code to be used. */ - 'discount_code' => false, + 'discount_code' => false, /* * If we should auto-renew or not. */ - 'auto_renew' => true, + 'auto_renew' => true, /* * The country, state, and city of the customer. * Used for taxation purposes. */ - 'country' => '', - 'state' => '', - 'city' => '', + 'country' => '', + 'state' => '', + 'city' => '', /* * Currency */ - 'currency' => '', + 'currency' => '', + + /* + * Custom amounts for PWYW products. + * Keyed by product ID => custom amount. + */ + 'custom_amounts' => [], + + /* + * Customer's recurring choice for PWYW products. + * Keyed by product ID => boolean. + */ + 'pwyw_recurring' => [], ], $args @@ -335,13 +363,15 @@ public function __construct($args) { /* * Set the country, duration and duration_unit. */ - $this->cart_type = $this->attributes->cart_type; - $this->country = $this->attributes->country; - $this->state = $this->attributes->state; - $this->city = $this->attributes->city; - $this->currency = $this->attributes->currency; - $this->duration = $this->attributes->duration; - $this->duration_unit = $this->attributes->duration_unit; + $this->cart_type = $this->attributes->cart_type; + $this->country = $this->attributes->country; + $this->state = $this->attributes->state; + $this->city = $this->attributes->city; + $this->currency = $this->attributes->currency; + $this->duration = $this->attributes->duration; + $this->duration_unit = $this->attributes->duration_unit; + $this->custom_amounts = is_array($this->attributes->custom_amounts) ? $this->attributes->custom_amounts : []; + $this->pwyw_recurring = is_array($this->attributes->pwyw_recurring) ? $this->attributes->pwyw_recurring : []; /* * Loads the current customer, if it exists. @@ -1665,7 +1695,7 @@ public function add_product($product_id_or_slug, $quantity = 1): bool { * If a price variation doesn't exist, we add an error to * the cart. */ - if ($product->is_free() === false) { + if ($product->is_free() === false && ! $product->is_pay_what_you_want()) { if (absint($this->duration) !== $product->get_duration() || $product->get_duration_unit() !== $this->duration_unit) { $price_variation = $product->get_price_variation($this->duration, $this->duration_unit); @@ -1690,15 +1720,73 @@ public function add_product($product_id_or_slug, $quantity = 1): bool { } } + /* + * Handle Pay What You Want pricing. + */ + $is_recurring = $product->is_recurring(); + + if ($product->is_pay_what_you_want()) { + $custom_amount = $this->get_custom_amount_for_product($product->get_id()); + + if (null !== $custom_amount) { + $minimum = $product->get_pwyw_minimum_amount(); + + if ($custom_amount < $minimum) { + $this->errors->add( + 'pwyw-below-minimum', + sprintf( + // translators: %1$s is the product name, %2$s is the minimum amount formatted as currency + __('The amount for %1$s must be at least %2$s.', 'ultimate-multisite'), + $product->get_name(), + wu_format_currency($minimum, $product->get_currency()) + ) + ); + + return false; + } + + $amount = (float) $custom_amount; + } else { + // Use suggested amount as default + $amount = $product->get_pwyw_suggested_amount(); + } + + // Determine recurring status based on product mode and customer choice + $recurring_mode = $product->get_pwyw_recurring_mode(); + + if ('force_recurring' === $recurring_mode) { + $is_recurring = true; + } elseif ('force_one_time' === $recurring_mode) { + $is_recurring = false; + } else { + // customer_choice - check customer's selection, default to false (one-time) + $is_recurring = $this->get_pwyw_recurring_for_product($product->get_id()); + } + } + + // Build line item data + $line_item_base = [ + 'product' => $product, + 'quantity' => $quantity, + 'unit_price' => $amount, + 'duration' => $duration, + 'duration_unit' => $duration_unit, + ]; + + // For PWYW products, explicitly set the recurring status + if ($product->is_pay_what_you_want()) { + $line_item_base['recurring'] = $is_recurring; + + // If recurring, ensure duration values are set + if ($is_recurring && (! $duration || ! $duration_unit)) { + $line_item_base['duration'] = $product->get_duration(); + $line_item_base['duration_unit'] = $product->get_duration_unit(); + } + } + $line_item_data = apply_filters( 'wu_add_product_line_item', - [ - 'product' => $product, - 'quantity' => $quantity, - 'unit_price' => $amount, - 'duration' => $duration, - 'duration_unit' => $duration_unit, - ], + $line_item_base, $product, $duration, $duration_unit, @@ -2324,7 +2412,13 @@ public function apply_discounts_to_item($line_item) { return $line_item; } - if (is_wp_error($this->discount_code->is_valid($line_item->get_product_id()))) { + $is_valid = $this->discount_code->is_valid( + $line_item->get_product_id(), + $line_item->get_duration(), + $line_item->get_duration_unit() + ); + + if (is_wp_error($is_valid)) { return $line_item; } @@ -2836,4 +2930,32 @@ protected function cancel_conflicting_pending_payments(): void { // Pending payment is the same. Nothing to do, Let the form element show the pay pending payment message. } } + + /** + * Get the custom amount for a PWYW product. + * + * @since 2.0.0 + * @param int $product_id The product ID. + * @return float|null The custom amount or null if not set. + */ + public function get_custom_amount_for_product($product_id) { + + $product_id = (int) $product_id; + + return isset($this->custom_amounts[ $product_id ]) ? (float) $this->custom_amounts[ $product_id ] : null; + } + + /** + * Get whether this PWYW product should be recurring. + * + * @since 2.0.0 + * @param int $product_id The product ID. + * @return bool + */ + public function get_pwyw_recurring_for_product($product_id): bool { + + $product_id = (int) $product_id; + + return (bool) wu_get_isset($this->pwyw_recurring, $product_id, false); + } } diff --git a/inc/checkout/class-checkout.php b/inc/checkout/class-checkout.php index 3fc8a1a2..7b23ea1a 100644 --- a/inc/checkout/class-checkout.php +++ b/inc/checkout/class-checkout.php @@ -1618,17 +1618,19 @@ public function create_order(): void { apply_filters( 'wu_cart_parameters', [ - 'products' => $this->request_or_session('products', []), - 'discount_code' => $this->request_or_session('discount_code'), - 'country' => $country, - 'state' => $state, - 'city' => $city, - 'membership_id' => $this->request_or_session('membership_id'), - 'payment_id' => $this->request_or_session('payment_id'), - 'auto_renew' => $this->request_or_session('auto_renew', false), - 'duration' => $this->request_or_session('duration'), - 'duration_unit' => $this->request_or_session('duration_unit'), - 'cart_type' => $this->request_or_session('cart_type', 'new'), + 'products' => $this->request_or_session('products', []), + 'discount_code' => $this->request_or_session('discount_code'), + 'country' => $country, + 'state' => $state, + 'city' => $city, + 'membership_id' => $this->request_or_session('membership_id'), + 'payment_id' => $this->request_or_session('payment_id'), + 'auto_renew' => $this->request_or_session('auto_renew', false), + 'duration' => $this->request_or_session('duration'), + 'duration_unit' => $this->request_or_session('duration_unit'), + 'cart_type' => $this->request_or_session('cart_type', 'new'), + 'custom_amounts' => $this->request_or_session('custom_amounts', []), + 'pwyw_recurring' => $this->request_or_session('pwyw_recurring', []), ], $this ) diff --git a/inc/models/class-product.php b/inc/models/class-product.php index 90eec5b1..b813e175 100644 --- a/inc/models/class-product.php +++ b/inc/models/class-product.php @@ -75,6 +75,21 @@ class Product extends Base_Model implements Limitable { */ const META_LEGACY_OPTIONS = 'legacy_options'; + /** + * Meta key for PWYW minimum amount. + */ + const META_PWYW_MINIMUM_AMOUNT = 'wu_pwyw_minimum_amount'; + + /** + * Meta key for PWYW suggested amount. + */ + const META_PWYW_SUGGESTED_AMOUNT = 'wu_pwyw_suggested_amount'; + + /** + * Meta key for PWYW recurring mode. + */ + const META_PWYW_RECURRING_MODE = 'wu_pwyw_recurring_mode'; + /** * The product name. * @@ -319,6 +334,32 @@ class Product extends Base_Model implements Limitable { */ protected $legacy_options; + /** + * PWYW minimum amount. + * + * @since 2.0.0 + * @var float + */ + protected $pwyw_minimum_amount; + + /** + * PWYW suggested amount. + * + * @since 2.0.0 + * @var float + */ + protected $pwyw_suggested_amount; + + /** + * PWYW recurring mode. + * + * Can be 'customer_choice', 'force_recurring', or 'force_one_time'. + * + * @since 2.0.0 + * @var string + */ + protected $pwyw_recurring_mode; + /** * Query Class to the static query methods. * @@ -360,28 +401,31 @@ public function validation_rules() { $currency = wu_get_setting('currency_symbol', 'USD'); return [ - 'featured_image_id' => 'integer', - 'currency' => "required|default:{$currency}", - 'pricing_type' => 'required|in:free,paid,contact_us', - 'trial_duration' => 'integer', - 'trial_duration_unit' => 'in:day,week,month,year|default:month', - 'parent_id' => 'integer', - 'amount' => 'numeric|default:0', - 'recurring' => 'default:0', - 'setup_fee' => 'numeric', - 'duration' => 'numeric|default:1', - 'duration_unit' => 'in:day,week,month,year|default:month', - 'billing_cycles' => 'integer|default:0', - 'active' => 'default:1', - 'price_variations' => "price_variations:{$duration},{$duration_unit}", - 'type' => "required|default:plan|in:{$allowed_types}", - 'slug' => "required|unique:\WP_Ultimo\Models\Product,slug,{$id}|min:2", - 'taxable' => 'boolean|default:0', - 'tax_category' => 'default:', - 'contact_us_label' => 'default:', - 'contact_us_link' => 'url:http,https', - 'customer_role' => 'alpha_dash', - 'network_id' => 'integer|nullable', + 'featured_image_id' => 'integer', + 'currency' => "required|default:{$currency}", + 'pricing_type' => 'required|in:free,paid,contact_us,pay_what_you_want', + 'trial_duration' => 'integer', + 'trial_duration_unit' => 'in:day,week,month,year|default:month', + 'parent_id' => 'integer', + 'amount' => 'numeric|default:0', + 'recurring' => 'default:0', + 'setup_fee' => 'numeric', + 'duration' => 'numeric|default:1', + 'duration_unit' => 'in:day,week,month,year|default:month', + 'billing_cycles' => 'integer|default:0', + 'active' => 'default:1', + 'price_variations' => "price_variations:{$duration},{$duration_unit}", + 'type' => "required|default:plan|in:{$allowed_types}", + 'slug' => "required|unique:\WP_Ultimo\Models\Product,slug,{$id}|min:2", + 'taxable' => 'boolean|default:0', + 'tax_category' => 'default:', + 'contact_us_label' => 'default:', + 'contact_us_link' => 'url:http,https', + 'customer_role' => 'alpha_dash', + 'network_id' => 'integer|nullable', + 'pwyw_minimum_amount' => 'numeric|default:0', + 'pwyw_suggested_amount' => 'numeric|default:0', + 'pwyw_recurring_mode' => 'in:customer_choice,force_recurring,force_one_time|default:customer_choice', ]; } @@ -548,11 +592,11 @@ public function get_pricing_type() { } /** - * Set pricing type can be one of 'free', 'paid', and 'contact_us'. + * Set pricing type can be one of 'free', 'paid', 'contact_us', and 'pay_what_you_want'. * * @since 2.0.0 - * @param string $pricing_type The pricing type can be 'free', 'paid' or 'contact_us'. - * @options free,paid,contact_us + * @param string $pricing_type The pricing type can be 'free', 'paid', 'contact_us', or 'pay_what_you_want'. + * @options free,paid,contact_us,pay_what_you_want * @return void */ public function set_pricing_type($pricing_type): void { @@ -564,6 +608,9 @@ public function set_pricing_type($pricing_type): void { $this->set_recurring(false); } + + // For PWYW, we don't force amount to 0 - it uses suggested_amount as default + // and recurring is determined by pwyw_recurring_mode } /** @@ -667,7 +714,7 @@ public function set_duration_unit($duration_unit): void { /** * Get the product amount. * - * @return int + * @return int|float */ public function get_amount() { @@ -679,6 +726,11 @@ public function get_amount() { return 0; } + // For PWYW, return the suggested amount as the default + if ($this->is_pay_what_you_want()) { + return $this->get_pwyw_suggested_amount(); + } + return $this->amount; } @@ -699,6 +751,17 @@ public function get_formatted_amount($key = 'amount') { return $this->get_contact_us_label() ?: __('Contact Us', 'ultimate-multisite'); } + if ($this->is_pay_what_you_want()) { + $minimum = $this->get_pwyw_minimum_amount(); + + if ($minimum > 0) { + // translators: %s is the minimum amount formatted as currency + return sprintf(__('From %s', 'ultimate-multisite'), wu_format_currency($minimum, $this->get_currency())); + } + + return __('Name Your Price', 'ultimate-multisite'); + } + return wu_format_currency($this->get_amount(), $this->get_currency()); } @@ -1533,6 +1596,121 @@ public function set_legacy_options($legacy_options): void { $this->legacy_options = $this->meta[ self::META_LEGACY_OPTIONS ]; } + /** + * Checks if this product uses Pay What You Want pricing. + * + * @since 2.0.0 + * @return bool + */ + public function is_pay_what_you_want(): bool { + + return 'pay_what_you_want' === $this->get_pricing_type(); + } + + /** + * Checks if this PWYW product allows customer to choose recurring. + * + * @since 2.0.0 + * @return bool + */ + public function allows_customer_recurring_choice(): bool { + + return $this->is_pay_what_you_want() && 'customer_choice' === $this->get_pwyw_recurring_mode(); + } + + /** + * Get the PWYW minimum amount. + * + * @since 2.0.0 + * @return float + */ + public function get_pwyw_minimum_amount(): float { + + if (null === $this->pwyw_minimum_amount) { + $this->pwyw_minimum_amount = (float) $this->get_meta(self::META_PWYW_MINIMUM_AMOUNT, 0); + } + + return (float) $this->pwyw_minimum_amount; + } + + /** + * Set the PWYW minimum amount. + * + * @since 2.0.0 + * @param float $amount The minimum amount customers can pay. + * @return void + */ + public function set_pwyw_minimum_amount($amount): void { + + $this->meta[ self::META_PWYW_MINIMUM_AMOUNT ] = wu_to_float($amount); + + $this->pwyw_minimum_amount = $this->meta[ self::META_PWYW_MINIMUM_AMOUNT ]; + } + + /** + * Get the PWYW suggested amount. + * + * @since 2.0.0 + * @return float + */ + public function get_pwyw_suggested_amount(): float { + + if (null === $this->pwyw_suggested_amount) { + $this->pwyw_suggested_amount = (float) $this->get_meta(self::META_PWYW_SUGGESTED_AMOUNT, 0); + } + + return (float) $this->pwyw_suggested_amount; + } + + /** + * Set the PWYW suggested amount. + * + * @since 2.0.0 + * @param float $amount The suggested price shown as the default value. + * @return void + */ + public function set_pwyw_suggested_amount($amount): void { + + $this->meta[ self::META_PWYW_SUGGESTED_AMOUNT ] = wu_to_float($amount); + + $this->pwyw_suggested_amount = $this->meta[ self::META_PWYW_SUGGESTED_AMOUNT ]; + } + + /** + * Get the PWYW recurring mode. + * + * @since 2.0.0 + * @return string One of 'customer_choice', 'force_recurring', or 'force_one_time'. + */ + public function get_pwyw_recurring_mode(): string { + + if (null === $this->pwyw_recurring_mode) { + $this->pwyw_recurring_mode = $this->get_meta(self::META_PWYW_RECURRING_MODE, 'customer_choice'); + } + + return $this->pwyw_recurring_mode ?: 'customer_choice'; + } + + /** + * Set the PWYW recurring mode. + * + * @since 2.0.0 + * @param string $mode The recurring mode: 'customer_choice', 'force_recurring', or 'force_one_time'. + * @return void + */ + public function set_pwyw_recurring_mode($mode): void { + + $valid_modes = ['customer_choice', 'force_recurring', 'force_one_time']; + + if ( ! in_array($mode, $valid_modes, true)) { + $mode = 'customer_choice'; + } + + $this->meta[ self::META_PWYW_RECURRING_MODE ] = $mode; + + $this->pwyw_recurring_mode = $this->meta[ self::META_PWYW_RECURRING_MODE ]; + } + /** * List of limitations that need to be merged. * From ab41443966924507a14be42ac4050e23d0a5ae2f Mon Sep 17 00:00:00 2001 From: David Stone Date: Wed, 28 Jan 2026 22:30:45 -0700 Subject: [PATCH 09/32] Add support for pay what you want prices --- .../checkout/templates/pricing-table/list.php | 36 ++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/views/checkout/templates/pricing-table/list.php b/views/checkout/templates/pricing-table/list.php index 450e4486..487cb816 100644 --- a/views/checkout/templates/pricing-table/list.php +++ b/views/checkout/templates/pricing-table/list.php @@ -55,8 +55,42 @@ class="wu-relative wu-block wu-rounded-lg wu-border wu-border-gray-300 wu-bg-whi
get_recurring_description()); ?>
+ is_pay_what_you_want()) : ?> +
+ +
+ + +
+ + allows_customer_recurring_choice()) : ?> + + + get_pwyw_recurring_mode()) : ?> + + +
+ + '; - }); - return; - } - - // Initialize addon - My_Addon::get_instance(); -}); - -/** - * Main addon class - */ -class My_Addon { - - use \WP_Ultimo\Traits\Singleton; - - /** - * Initialize the addon - */ - public function init() { - // Load dependencies - $this->load_dependencies(); - - // Setup hooks - $this->setup_hooks(); - - // Initialize components - $this->init_components(); - } - - /** - * Load required files - */ - private function load_dependencies() { - require_once MY_ADDON_PATH . 'inc/class-my-addon.php'; - } - - /** - * Setup WordPress hooks - */ - private function setup_hooks() { - // Activation/deactivation - register_activation_hook(MY_ADDON_PLUGIN_FILE, [$this, 'activate']); - register_deactivation_hook(MY_ADDON_PLUGIN_FILE, [$this, 'deactivate']); - - // WP Ultimo hooks - add_action('wu_checkout_completed', [$this, 'on_checkout_completed'], 10, 3); - add_filter('wu_checkout_form_fields', [$this, 'add_custom_fields'], 10, 2); - } - - /** - * Initialize addon components - */ - private function init_components() { - // Initialize admin pages, models, etc. - } - - /** - * Plugin activation - */ - public function activate() { - // Create custom tables, set options, etc. - $this->create_custom_table(); - update_option('my_addon_version', MY_ADDON_VERSION); - } - - /** - * Plugin deactivation - */ - public function deactivate() { - // Cleanup if needed - } - - /** - * Handle checkout completion - */ - public function on_checkout_completed($payment, $customer, $membership) { - // Custom logic when checkout completes - $this->send_welcome_email($customer); - $this->setup_customer_account($customer, $membership); - } - - /** - * Add custom checkout fields - */ - public function add_custom_fields($fields, $form) { - $fields['company_size'] = [ - 'type' => 'select', - 'title' => 'Company Size', - 'options' => [ - 'small' => '1-10 employees', - 'medium' => '11-100 employees', - 'large' => '100+ employees' - ], - 'required' => false - ]; - - return $fields; - } -} -``` - -### Custom Model Example - -```php -table_name = "{$wpdb->prefix}my_addon_leads"; - } - - /** - * Get the company name - */ - public function get_company() { - return $this->get_meta('company'); - } - - /** - * Set the company name - */ - public function set_company($company) { - return $this->add_meta('company', $company); - } - - /** - * Convert lead to customer - */ - public function convert_to_customer($user_data = []) { - // Create WordPress user - $user_id = wp_create_user( - $user_data['username'] ?? $this->get_email(), - $user_data['password'] ?? wp_generate_password(), - $this->get_email() - ); - - if (is_wp_error($user_id)) { - return $user_id; - } - - // Create WP Ultimo customer - $customer = wu_create_customer([ - 'user_id' => $user_id, - 'email_verification' => 'verified', - 'type' => 'customer' - ]); - - if (is_wp_error($customer)) { - return $customer; - } - - // Copy lead data to customer - $customer->add_meta('company', $this->get_company()); - $customer->add_meta('lead_source', $this->get_source()); - - // Mark lead as converted - $this->set_status('converted'); - $this->add_meta('converted_customer_id', $customer->get_id()); - $this->save(); - - return $customer; - } -} -``` - -### Admin Page Integration - -```php -id, [ - 'title' => __('Leads', 'my-addon'), - 'menu_title' => __('Leads', 'my-addon'), - 'capability' => 'wu_read_leads', - 'position' => $this->position, - 'parent' => 'wp-ultimo', - 'callback' => [$this, 'render'] - ]); - } - - /** - * Render the page - */ - public function render() { - // Get leads data - $leads = My_Addon\Models\Lead::query([ - 'number' => 20, - 'paged' => absint($_GET['paged'] ?? 1) - ]); - - // Render template - wu_get_template('admin/leads-list', [ - 'leads' => $leads, - 'page_title' => __('Manage Leads', 'my-addon') - ]); - } -} -``` - ---- - -## Code Examples - -### Advanced Integration Examples - -#### 1. Multi-Gateway Payment Processing - -```php -/** - * Process payment with fallback gateways - */ -class Smart_Payment_Processor { - - private $gateway_priority = ['stripe', 'paypal', 'manual']; - - public function process_payment_with_fallback($payment, $cart) { - foreach ($this->gateway_priority as $gateway_id) { - $gateway = wu_get_gateway($gateway_id); - - if (!$gateway || !$gateway->is_available()) { - continue; - } - - $result = $gateway->process_single_payment($payment, $cart); - - if (!is_wp_error($result)) { - // Payment successful - do_action('wu_payment_processed_successfully', $payment, $gateway_id); - return $result; - } - - // Log failed attempt - wu_log_add('payment-processing', sprintf( - 'Gateway %s failed for payment %d: %s', - $gateway_id, - $payment->get_id(), - $result->get_error_message() - )); - } - - // All gateways failed - do_action('wu_payment_processing_failed', $payment); - return new WP_Error('all_gateways_failed', 'All payment methods failed'); - } -} -``` - -#### 2. Dynamic Pricing Engine - -```php -/** - * Advanced pricing rules engine - */ -class Dynamic_Pricing_Engine { - - public function __construct() { - add_filter('wu_cart_total', [$this, 'apply_dynamic_pricing'], 20, 2); - add_filter('wu_product_price', [$this, 'modify_product_price'], 10, 3); - } - - public function apply_dynamic_pricing($total, $cart) { - $customer = $cart->get_customer(); - $rules = $this->get_pricing_rules(); - - foreach ($rules as $rule) { - if ($this->rule_applies($rule, $cart, $customer)) { - $total = $this->apply_rule($rule, $total, $cart); - } - } - - return $total; - } - - private function get_pricing_rules() { - return [ - [ - 'type' => 'volume_discount', - 'condition' => ['total_greater_than' => 100], - 'discount' => 0.1 // 10% - ], - [ - 'type' => 'loyalty_discount', - 'condition' => ['customer_tenure_months' => 12], - 'discount' => 0.15 // 15% - ], - [ - 'type' => 'seasonal_promo', - 'condition' => ['date_range' => ['2024-11-01', '2024-12-31']], - 'discount' => 0.2 // 20% - ] - ]; - } - - private function rule_applies($rule, $cart, $customer) { - foreach ($rule['condition'] as $condition => $value) { - switch ($condition) { - case 'total_greater_than': - if ($cart->get_total() <= $value) return false; - break; - - case 'customer_tenure_months': - if (!$customer || $customer->get_months_active() < $value) return false; - break; - - case 'date_range': - $now = current_time('Y-m-d'); - if ($now < $value[0] || $now > $value[1]) return false; - break; - } - } - - return true; - } - - private function apply_rule($rule, $total, $cart) { - $discount_amount = $total * $rule['discount']; - - // Log the discount application - wu_log_add('pricing', sprintf( - 'Applied %s rule: %.2f discount on total %.2f', - $rule['type'], - $discount_amount, - $total - )); - - return $total - $discount_amount; - } -} - -new Dynamic_Pricing_Engine(); -``` - -#### 3. Advanced Site Provisioning - -```php -/** - * Custom site provisioning with external services - */ -class Advanced_Site_Provisioner { - - public function __construct() { - add_action('wu_site_published', [$this, 'provision_site'], 10, 2); - add_action('wu_membership_status_to_expired', [$this, 'suspend_site_services']); - } - - public function provision_site($site, $membership) { - $plan = $membership->get_plan(); - - // Configure based on plan features - switch_to_blog($site->get_id()); - - // Install plugins based on plan - $this->install_plan_plugins($plan); - - // Configure SSL - if ($plan->has_feature('ssl')) { - $this->setup_ssl($site); - } - - // Setup CDN - if ($plan->has_feature('cdn')) { - $this->configure_cdn($site); - } - - // Configure backups - if ($plan->has_feature('backups')) { - $this->setup_automated_backups($site, $plan->get_backup_frequency()); - } - - // Setup monitoring - $this->setup_site_monitoring($site, $membership->get_customer()); - - restore_current_blog(); - - // Send completion notification - $this->send_provisioning_complete_email($site, $membership); - } - - private function install_plan_plugins($plan) { - $plugins = $plan->get_included_plugins(); - - foreach ($plugins as $plugin_slug) { - if ($this->plugin_exists($plugin_slug)) { - activate_plugin($plugin_slug); - - // Configure plugin if needed - $this->configure_plugin($plugin_slug, $plan); - } - } - } - - private function setup_ssl($site) { - $domain = $site->get_domain(); - - // API call to SSL provider - $ssl_service = new SSL_Provider_API(); - $result = $ssl_service->request_certificate($domain); - - if ($result->success) { - $site->add_meta('ssl_certificate_id', $result->certificate_id); - $site->add_meta('ssl_status', 'active'); - } - } - - private function configure_cdn($site) { - $cdn_service = new CDN_Provider_API(); - - $zone = $cdn_service->create_zone([ - 'name' => $site->get_domain(), - 'type' => 'full' - ]); - - if ($zone->success) { - $site->add_meta('cdn_zone_id', $zone->id); - - // Update DNS records - $this->update_cdn_dns($site, $zone); - } - } - - private function setup_automated_backups($site, $frequency) { - $backup_service = new Backup_Provider_API(); - - $schedule = $backup_service->create_schedule([ - 'site_id' => $site->get_id(), - 'frequency' => $frequency, - 'retention' => 30 // days - ]); - - $site->add_meta('backup_schedule_id', $schedule->id); - } - - private function setup_site_monitoring($site, $customer) { - $monitoring_service = new Monitoring_API(); - - $monitor = $monitoring_service->create_monitor([ - 'url' => $site->get_domain(), - 'customer_email' => $customer->get_email(), - 'check_interval' => 300 // 5 minutes - ]); - - $site->add_meta('monitoring_id', $monitor->id); - } -} - -new Advanced_Site_Provisioner(); -``` - -#### 4. Custom Limitations System - -```php -/** - * Advanced limitations with usage tracking - */ -class Advanced_Limitations { - - public function __construct() { - add_filter('wu_limitation_plugins_allowed', [$this, 'check_plugin_limit'], 10, 3); - add_filter('wu_limitation_storage_allowed', [$this, 'check_storage_limit'], 10, 3); - add_action('activated_plugin', [$this, 'track_plugin_activation'], 10, 2); - } - - public function check_plugin_limit($allowed, $site_id, $membership) { - $plan = $membership->get_plan(); - $max_plugins = $plan->get_limit('max_plugins', 10); - - // Count active plugins - switch_to_blog($site_id); - $active_plugins = count(get_option('active_plugins', [])); - restore_current_blog(); - - if ($active_plugins >= $max_plugins) { - // Send warning notification - $this->send_limit_warning($membership->get_customer(), 'plugins', $max_plugins); - return false; - } - - return true; - } - - public function check_storage_limit($allowed, $site_id, $membership) { - $plan = $membership->get_plan(); - $max_storage = $plan->get_limit('max_storage_mb', 1000); // MB - - $current_usage = $this->get_site_storage_usage($site_id); - - if ($current_usage >= $max_storage) { - // Log limit reached - wu_log_add('limitations', sprintf( - 'Site %d reached storage limit: %dMB/%dMB', - $site_id, - $current_usage, - $max_storage - )); - - return false; - } - - // Warn at 80% usage - if ($current_usage >= ($max_storage * 0.8)) { - $this->send_storage_warning($membership->get_customer(), $current_usage, $max_storage); - } - - return true; - } - - private function get_site_storage_usage($site_id) { - // Calculate actual storage usage - $upload_dir = wp_upload_dir(); - $size = $this->get_directory_size($upload_dir['basedir']); - - // Convert to MB - return round($size / 1024 / 1024, 2); - } - - private function get_directory_size($directory) { - $size = 0; - $files = new RecursiveIteratorIterator( - new RecursiveDirectoryIterator($directory) - ); - - foreach ($files as $file) { - if ($file->isFile()) { - $size += $file->getSize(); - } - } - - return $size; - } - - private function send_limit_warning($customer, $limit_type, $limit_value) { - wu_mail_customer($customer, 'limit_warning', [ - 'limit_type' => $limit_type, - 'limit_value' => $limit_value, - 'upgrade_url' => wu_get_current_url('upgrade') - ]); - } -} - -new Advanced_Limitations(); -``` - -### Testing Your Integration - -#### Unit Test Example - -```php -customer = wu_create_customer([ - 'user_id' => $this->factory->user->create(), - 'type' => 'customer' - ]); - - // Create test membership - $this->membership = wu_create_membership([ - 'customer_id' => $this->customer->get_id(), - 'plan_id' => $this->create_test_plan() - ]); - } - - public function test_custom_field_saves_correctly() { - $checkout = new WP_Ultimo\Checkout\Checkout(); - - // Simulate form submission - $_POST['company_size'] = 'medium'; - - $result = $checkout->process_step_data([ - 'company_size' => 'medium' - ]); - - $this->assertTrue($result); - - // Verify data was saved - $saved_value = $this->customer->get_meta('company_size'); - $this->assertEquals('medium', $saved_value); - } - - public function test_pricing_rule_applies() { - $engine = new Dynamic_Pricing_Engine(); - - $cart = new WP_Ultimo\Checkout\Cart([ - 'customer_id' => $this->customer->get_id(), - 'products' => ['test-plan'] - ]); - - $cart->set_total(150); // Above $100 threshold - - $new_total = $engine->apply_dynamic_pricing(150, $cart); - - // Should have 10% discount - $this->assertEquals(135, $new_total); - } - - private function create_test_plan() { - return wu_create_product([ - 'name' => 'Test Plan', - 'type' => 'plan', - 'price' => 50, - 'duration' => 1, - 'duration_unit' => 'month' - ])->get_id(); - } -} -``` - -This comprehensive documentation provides developers with all the tools and knowledge needed to integrate with, extend, and build upon WP Ultimo's powerful platform. The extensive API, hook system, and examples enable creation of sophisticated SaaS solutions and custom integrations. +See [Official Ultimate Multisite Documentation Site](https://ultimatemultisite.com/docs/developer) diff --git a/assets/js/checkout.min.js b/assets/js/checkout.min.js index 7f42f880..d870b366 100644 --- a/assets/js/checkout.min.js +++ b/assets/js/checkout.min.js @@ -1 +1 @@ -((n,r,s)=>{window.history.replaceState&&window.history.replaceState(null,null,wu_checkout.baseurl),r.addAction("wu_on_create_order","nextpress/wp-ultimo",function(e,t){void 0!==t.order.extra.template_id&&t.order.extra.template_id&&(e.template_id=t.order.extra.template_id)}),r.addAction("wu_checkout_loaded","nextpress/wp-ultimo",function(e){void 0!==window.wu_auto_submittable_field&&window.wu_auto_submittable_field&&e.$watch(window.wu_auto_submittable_field,function(){jQuery(this.$el).submit()},{deep:!0})}),r.addAction("wu_checkout_loaded","nextpress/wp-ultimo",function(t){wu_create_cookie("wu_template",""),wu_create_cookie("wu_selected_products",""),wu_listen_to_cookie_change("wu_template",function(e){e&&(t.template_id=e)})}),n(document).on("click",'[href|="#wu-checkout-add"]',function(e){e.preventDefault();var e=n(this),t=e.attr("href").split("#").pop().replace("wu-checkout-add-","");"undefined"!=typeof wu_checkout_form&&-1===wu_checkout_form.products.indexOf(t)&&(wu_checkout_form.add_product(t),e.html(wu_checkout.i18n.added_to_order))}),window.addEventListener("pageshow",function(e){e.persisted&&this.window.wu_checkout_form&&this.window.wu_checkout_form.unblock()}),n(document).ready(function(){var e;void 0!==window.Vue&&(Object.defineProperty(Vue.prototype,"$moment",{value:moment}),e={plan:(e=function(e){return isNaN(e)?e:parseInt(e,10)})(wu_checkout.plan),errors:[],order:wu_checkout.order,products:s.map(wu_checkout.products,e),template_id:wu_checkout.template_id,template_category:"",gateway:wu_checkout.gateway,request_billing_address:wu_checkout.request_billing_address,country:wu_checkout.country,state:"",city:"",site_url:wu_checkout.site_url,site_domain:wu_checkout.site_domain,is_subdomain:wu_checkout.is_subdomain,discount_code:wu_checkout.discount_code,toggle_discount_code:0,payment_method:"",username:"",email_address:"",payment_id:wu_checkout.payment_id,membership_id:wu_checkout.membership_id,cart_type:"new",auto_renew:1,duration:wu_checkout.duration,duration_unit:wu_checkout.duration_unit,prevent_submission:!1,valid_password:!0,stored_templates:{},state_list:[],city_list:[],labels:{},show_login_prompt:!1,login_prompt_field:"",checking_user_exists:!1,logging_in:!1,login_error:"",inline_login_password:""},r.applyFilters("wu_before_form_init",e),jQuery("#wu_form").length)&&(Vue.component("colorPicker",{props:["value"],template:'',mounted(){let o=this;n(this.$el).val(this.value).wpColorPicker({width:200,defaultColor:this.value,change(e,t){o.$emit("input",t.color.toString())}})},watch:{value(e){n(this.$el).wpColorPicker("color",e)}},destroyed(){n(this.$el).off().wpColorPicker("destroy")}}),window.wu_checkout_form=new Vue({el:"#wu_form",data:e,directives:{init:{bind(e,t,o){o.context[t.arg]=t.value}}},components:{dynamic:{functional:!0,template:"#dynamic",props:["template"],render(e,t){t=t.props.template;return e(t?{template:t}:"
nbsp;
")}}},computed:{hooks(){return wp.hooks},unique_products(){return s.uniq(this.products,!1,e=>parseInt(e,10))}},methods:{debounce(e){return s.debounce(e,200,!0)},open_url(e,t="_blank"){window.open(e,t)},get_template(e,t){void 0===t.id&&(t.id="default");var o=e+"/"+t.id;return void 0!==this.stored_templates[o]?this.stored_templates[o]:(o=this.hooks.applyFilters("wu_before_template_fetch",{duration:this.duration,duration_unit:this.duration_unit,products:this.products,...t},this),this.fetch_template(e,o),'
'+wu_checkout.i18n.loading+"
")},reset_templates(n){if(void 0===n)this.stored_templates={};else{let i={};s.forEach(this.stored_templates,function(e,t){var o=t.toString().substr(0,t.toString().indexOf("/"));!1===s.contains(n,o)&&(i[t]=e)}),this.stored_templates=i}},fetch_template(o,i){let n=this;void 0===i.id&&(i.id="default"),this.request("wu_render_field_template",{template:o,attributes:i},function(e){var t=o+"/"+i.id;e.success?Vue.set(n.stored_templates,t,e.data.html):Vue.set(n.stored_templates,t,"
"+e.data[0].message+"
")})},go_back(){this.block(),window.history.back()},set_prevent_submission(e){this.$nextTick(function(){this.prevent_submission=e})},remove_product(t,o){this.products=s.filter(this.products,function(e){return e!=t&&e!=o})},add_plan(e){this.plan&&this.remove_product(this.plan),this.plan=e,this.add_product(e)},add_product(e){this.products.push(e)},has_product(e){return-1