Phan: Address PhanPossiblyUndeclaredVariable violations #45911

tbradsha · 2025-11-12T21:58:58Z

Closes MONOREP-221

This addresses PhanPossiblyUndeclaredVariable violations, skipping the following:

packages/block-delimiter
plugins/crm
plugins/super-cache
icalendar-reader and markdown libs

Fixes include:

Suppressions due to false positives (Phan sometimes gets confused when a var is defined under a specific condition, and later on is used under a different block gated by the same condition)
Declaring vars in an broader scope
Using null coalescence
Rearranging logic (projects/packages/backup/src/class-jetpack-backup.php and projects/plugins/jetpack/modules/subscriptions/views.php)
Adding fallback values with an else or default case

Edge cases aside, there was one actual bug in projects/plugins/vaultpress/vaultpress.php that may have prevented the Jetpack logo from showing.

Proposed changes:

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:

The goal was to keep things as close to the original functionality as possible. CI should be happy.

github-actions · 2025-11-12T21:59:47Z

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 or WordPress.com Site Helper), and enable the fix/phan/PhanPossiblyUndeclaredVariable branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack fix/phan/PhanPossiblyUndeclaredVariable

bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/phan/PhanPossiblyUndeclaredVariable

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-11-12T22:00:03Z

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: December 2, 2025

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

Vaultpress plugin:

No scheduled milestone found for this plugin.

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

Boost plugin:

Next scheduled release: November 26, 2025

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

Wpcomsh plugin:

Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2)

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

jp-launch-control · 2025-11-13T13:31:40Z

Code Coverage Summary

Coverage changed in 14 files. Only the first 5 are listed here.

File	Coverage	Δ%	Δ Uncovered
projects/plugins/boost/app/lib/minify/class-concatenate-js.php	0/166 (0.00%)	0.00%	2 ❤️‍🩹
projects/plugins/jetpack/modules/widgets/flickr.php	0/107 (0.00%)	0.00%	2 ❤️‍🩹
projects/plugins/vaultpress/class.vaultpress-database.php	0/264 (0.00%)	0.00%	2 ❤️‍🩹
projects/packages/sync/src/modules/class-full-sync.php	0/239 (0.00%)	0.00%	1 ❤️‍🩹
projects/plugins/jetpack/class.jetpack.php	736/2266 (32.48%)	-0.01%	1 ❤️‍🩹

Full summary · PHP report · JS report

projects/packages/analyzer/src/class-differences.php

projects/packages/image-cdn/src/class-image-cdn.php

projects/packages/publicize/src/class-publicize.php

projects/packages/search/src/widgets/class-search-widget.php

projects/packages/videopress/tests/php/VideoPress_Uploader_Test.php

anomiex · 2025-11-13T17:02:01Z

projects/plugins/jetpack/class.json-api-endpoints.php

 		if ( $site_id > -1 ) {
 			$author['site_ID']      = (int) $site_id;
-			$author['site_visible'] = $site_visible;
+			$author['site_visible'] = $site_visible ?? false;


Any particular reason not to do this to preserve the current behavior?

Suggested change

$author['site_visible'] = $site_visible ?? false;

$author['site_visible'] = $site_visible ?? null;

This value seems to be a bool in normal cases, so I figured I'd match that in edge cases.

Looks like before it was always null unless IS_WPCOM && ! $is_jetpack && $site_id > -1. 🤷

anomiex · 2025-11-13T17:06:26Z

projects/plugins/jetpack/class.json-api.php

 		// Find which endpoint to serve.
-		$found = false;
+		$found       = false;
+		$path_pieces = array();


You could probably leave this out. The suppression you're adding on line 591 for $endpoint should cover $path_pieces too.

It's true the suppression would cover it, but there are scenarios where it isn't defined (e.g. if the outer or inner for loop doesn't run through).

But in that case $endpoint won't be defined either. So why set one but not the other?

projects/plugins/jetpack/class.json-api.php

Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>

anomiex · 2025-11-17T18:03:22Z

projects/packages/search/src/widgets/class-search-widget.php

 		}

-		if ( ! $display_filters && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {
+		if ( empty( $filters ) && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {


$filters will always exist, so you could just do like

Suggested change

if ( empty( $filters ) && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {

if ( ! $filters && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {

anomiex · 2025-11-17T18:03:34Z

projects/packages/search/src/widgets/class-search-widget.php

 		endif;

-		if ( $display_filters ) {
+		if ( ! empty( $filters ) ) {


Same

Suggested change

if ( ! empty( $filters ) ) {

if ( $filters ) {

anomiex · 2025-11-17T18:04:37Z

projects/packages/search/src/widgets/class-search-widget.php

 		Template_Tags::render_widget_search_form( array(), '', '' );

-		if ( $display_filters ) {
+		if ( ! empty( $filters ) ) {


Same

Suggested change

if ( ! empty( $filters ) ) {

if ( $filters ) {

anomiex · 2025-11-17T18:08:11Z

projects/plugins/jetpack/class.json-api-endpoints.php

 		if ( $site_id > -1 ) {
 			$author['site_ID']      = (int) $site_id;
-			$author['site_visible'] = $site_visible;
+			$author['site_visible'] = $site_visible ?? false;


Looks like before it was always null unless IS_WPCOM && ! $is_jetpack && $site_id > -1. 🤷

anomiex · 2025-11-17T18:09:25Z

projects/plugins/jetpack/class.json-api.php

 		// Find which endpoint to serve.
-		$found = false;
+		$found       = false;
+		$path_pieces = array();


But in that case $endpoint won't be defined either. So why set one but not the other?

tbradsha added 4 commits November 12, 2025 14:39

Address most PhanPossiblyUndeclaredVariable instances

5c0b197

Remove now-redundant assignment

3d9a1ce

Update Phan baselines

7a2a539

Add changelogs

1e67916

tbradsha requested a review from a team November 12, 2025 21:58

tbradsha self-assigned this Nov 12, 2025

tbradsha added [Status] Needs Review This PR is ready for review. [Type] Janitorial labels Nov 12, 2025

anomiex reviewed Nov 13, 2025

View reviewed changes

tbradsha and others added 6 commits November 14, 2025 13:49

Don't rely on foreach PHP quirk

e306056

Reset vars early and in each loop

eaca565

Remove interim var

378840a

Initialize vars at top of function

793f071

Add todo comment

3060ddc

Apply suggestions from code review

fd4395b

Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>

tbradsha requested a review from anomiex November 14, 2025 21:32

anomiex reviewed Nov 17, 2025

View reviewed changes

	$author['site_visible'] = $site_visible ?? false;
	$author['site_visible'] = $site_visible ?? null;

	if ( empty( $filters ) && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {
	if ( ! $filters && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {

Phan: Address PhanPossiblyUndeclaredVariable violations #45911

Are you sure you want to change the base?

Phan: Address PhanPossiblyUndeclaredVariable violations #45911

Conversation

tbradsha commented Nov 12, 2025 • edited by robertsreberski 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 Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Code Coverage Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tbradsha commented Nov 12, 2025 •

edited by robertsreberski

Loading

github-actions bot commented Nov 12, 2025 •

edited

Loading

github-actions bot commented Nov 12, 2025 •

edited

Loading

jp-launch-control bot commented Nov 13, 2025 •

edited

Loading