Subscriptions Widget: Add fallbacks for values associated with widget instance keys #44265

coder-karen · 2025-07-10T12:04:29Z

Fixes VULCAN-247

Proposed changes:

This PR adds fallback (default) values for values associated with widget instance keys, within the update function.
This prevents PHP warnings from occurring due to undefined array keys.
The scenario in which this was happening was from within a site creation process (Headstart), via API. However not all information is being included in this process.
Initially, I approached this by setting blank defaults, to display as close to expected as possible. However, if keys weren't set, this could result in missing or incomplete widget settings or unexpected display issues.
Now, we merge the new widget settings over the old instance, and then over the defaults, to ensure all expected keys are present while preserving any existing values not explicitly updated (including blank values). This approach prevents accidental data loss, maintains compatibility with legacy or partial configurations, and guarantees that the widget always has a complete set of settings.
Additionally, using defaults from within the update function is also used by several other widgets (eg. Milestone, Gallery, Instagram Widget).

Logs: e0ddd44d3db9ab1d7ef595112dce260e-logstash

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Code-review
You can also test that general updating works as expected. To do that, with the PR applied on a test site you'd need to install the Classic Widgets plugin. You'll need a legacy theme as well, such as Twenty Seventeen. Under Appearance > Widget, move a Blog Subscriptions widget to a widget area. The regular defaults should fill in. Remove some content and click save - updating should work as expected. Also test the checkbox to ensure it saves properly.

On Simple - presumably you'd need a site using legacy widgets (old site?), so I'm not too sure how to test that.

… keys, if using the update function directly

github-actions · 2025-07-10T12:05:18Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the update/subscriptions-widget-update-function-defaults branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack update/subscriptions-widget-update-function-defaults

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2025-07-10T12:05:36Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
You can use GitHub's Reviewers functionality to request a review.
When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly:
- Scheduled release: August 5, 2025
- Code freeze: August 4, 2025

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

jp-launch-control · 2025-07-10T12:13:08Z

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

…aw data here

coder-karen · 2025-07-11T11:18:44Z

projects/plugins/jetpack/modules/subscriptions/views.php

+			$instance['title']               = wp_strip_all_tags( stripslashes( $instance['title'] ) );
+			$instance['title_following']     = wp_strip_all_tags( stripslashes( $instance['title_following'] ) );
+			$instance['subscribe_logged_in'] = wp_filter_post_kses( stripslashes( $instance['subscribe_logged_in'] ) );
+			$instance['subscribe_button']    = wp_strip_all_tags( stripslashes( $instance['subscribe_button'] ) );
 		}

 		$instance['show_subscribers_total']     = isset( $new_instance['show_subscribers_total'] ) && $new_instance['show_subscribers_total'];


We leave the original checks here, as these are for checkboxes. Otherwise, the checkbox would always revert to the default value when unchecked, ignoring the user’s action.

… set, and use static function call

darssen

Thanks for working on this @coder-karen.

From a code review perspective, changes look good. 👍

…-defaults

coder-karen added 2 commits July 10, 2025 12:51

Add fallbacks for values associated with Subscription widget instance…

d467799

… keys, if using the update function directly

changelog

55ecbab

coder-karen self-assigned this Jul 10, 2025

coder-karen added [Type] Bug When a feature is broken and / or not performing as intended [Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [Status] In Progress labels Jul 10, 2025

github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jul 10, 2025

Use default values where keys don't exist

a7f2eda

coder-karen marked this pull request as ready for review July 11, 2025 11:05

Change checkbox values back to original check to ensure we only use r…

b06b2f9

…aw data here

coder-karen commented Jul 11, 2025

View reviewed changes

coder-karen added [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels Jul 11, 2025

coder-karen requested a review from a team July 11, 2025 11:32

Add inline defaults for two keys that dont have pre-existing defaults…

32f4d47

… set, and use static function call

darssen approved these changes Jul 18, 2025

View reviewed changes

Merge branch 'trunk' into update/subscriptions-widget-update-function…

d745248

…-defaults

coder-karen merged commit 4327540 into trunk Jul 21, 2025
67 checks passed

coder-karen deleted the update/subscriptions-widget-update-function-defaults branch July 21, 2025 09:26

github-actions bot removed the [Status] Needs Review This PR is ready for review. label Jul 21, 2025

github-actions bot added this to the jetpack/14.9 milestone Jul 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Subscriptions Widget: Add fallbacks for values associated with widget instance keys #44265

Subscriptions Widget: Add fallbacks for values associated with widget instance keys #44265

coder-karen commented Jul 10, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 10, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 10, 2025 •

edited

Loading

Uh oh!

jp-launch-control bot commented Jul 10, 2025 •

edited

Loading

Uh oh!

coder-karen Jul 11, 2025

Uh oh!

darssen left a comment

Uh oh!

Uh oh!

Uh oh!

Subscriptions Widget: Add fallbacks for values associated with widget instance keys #44265

Subscriptions Widget: Add fallbacks for values associated with widget instance keys #44265

Conversation

coder-karen commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Uh oh!

github-actions bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jp-launch-control bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Uh oh!

coder-karen Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

darssen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coder-karen commented Jul 10, 2025 •

edited

Loading

github-actions bot commented Jul 10, 2025 •

edited

Loading

github-actions bot commented Jul 10, 2025 •

edited

Loading

jp-launch-control bot commented Jul 10, 2025 •

edited

Loading