feat: add settings import/export functionality - #734

coderGtm · 2026-06-16T08:32:42Z

What?

Closes #191

This PR implements the ability to export and import non-sensitive AI configuration settings and introduces a dedicated AI section in WordPress Site Health.

Why?

Allowing users to move AI configurations between environments (e.g., staging to production, multi-site etc.) improves the developer experience. By excluding sensitive credentials from the export, we ensure security while maintaining portability. The Site Health integration provides administrators with a quick overview of the plugin's status and credential health.

How?

REST API: Created includes/REST/Settings_IO_Controller.php to handle GET /ai/v1/settings/export and POST /ai/v1/settings/import.
Security: Implemented SENSITIVE_PATTERNS filtering to ensure API keys, tokens, and secrets are never exported or overwritten during import.
Site Health: Added includes/Admin/Site_Health.php to provide debug information (version, enabled features, credential status) and a status test for connectivity.
UI/UX:
- Added "Export settings" and "Import settings" to the AI settings menu in routes/ai-home/stage.tsx.
- Implemented a confirmation modal for imports.
Tests: Added comprehensive integration tests in tests/Integration/Includes/REST/Settings_IO_ControllerTest.php and tests/Integration/Includes/Admin/Site_HealthTest.php.

Use of AI Tools

AI assistance: Yes
Tool(s): GitHub Copilot
Model(s): Claude Sonnet 4.6, GPT-4o
Used for: Authoring the codebase exploration, UI components, and the integration test suite.

Testing Instructions

Navigate to AI Settings.
Open the kebab menu (three vertical dots) in the top right.
Click Export settings. A JSON file containing your current toggles and developer configurations (but no API keys) should download.
Toggle several features to different states.
Click Import settings in the menu and select the previously downloaded file.
Confirm the prompt "This will overwrite existing AI settings."
Verification: The UI should update immediately to reflect the imported settings without a page refresh.
Navigate to Tools > Site Health.
In the Status tab, verify the "AI Plugin" test results.
In the Info tab, verify the "AI Plugin" section contains correct metadata about your setup.

Screenshots or screencast

Menu Items:

Confirmation prompt before completing import:

Changelog Entry

Added - Import/Export functionality for non-sensitive AI settings.
Added - AI-specific Site Health integration and status tests.

github-actions · 2026-06-16T08:32:57Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: coderGtm <gautam23@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>
Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

coderGtm · 2026-06-18T10:40:32Z

The failing JavaScript quality check is due to a conflict between eslint and typescript. While eslint prefers dot notation, typescript complains about it (TS4111). Should I suppress the eslint error?

dkotter · 2026-06-18T14:52:30Z

The failing JavaScript quality check is due to a conflict between eslint and typescript. While eslint prefers dot notation, typescript complains about it (TS4111). Should I suppress the eslint error?

We do have a number of these that we already ignore with inline statements so I think that's fine

…to feature/import-export-config

dkotter

Overall this looks really good, left a few comments. In addition, an E2E test here would be nice to verify the import/export options are available

dkotter · 2026-06-23T15:27:38Z

+				),
+				'description' => sprintf(
+					'<p>%s</p>',
+					__( 'At least one AI connector has credentials configured and is ready to use.', 'ai' )


So this isn't entirely accurate. The has_ai_credentials function will tell us if a Provider has credentials set but doesn't tell us if the credentials are valid. We do have a new is_connector_configured function that we could use here instead

Well, I am not entirely convinced that Site Health checks should also check the validity of the credentials. But if you insist, I can implement it that way as I am not able to side either way on this.

I don't feel strongly on if we should check validity of credentials here but we can't accurately say At least one AI connector has credentials configured and is ready to use if we just check if credentials exist. I'd suggest we at least modify that message and just remove the and is ready to use part

coderGtm · 2026-06-25T11:52:40Z

Thanks @dkotter for reviewing this. I will work on the feedback over the days and request a review again.

# Conflicts: # includes/Main.php

codecov · 2026-07-07T06:13:55Z

Codecov Report

❌ Patch coverage is 95.29915% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.18%. Comparing base (35a15e1) to head (4e62810).

Files with missing lines	Patch %	Lines
includes/Admin/Site_Health.php	94.50%	5 Missing ⚠️
includes/REST/Settings_IO_Controller.php	96.42%	5 Missing ⚠️
includes/Main.php	50.00%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             develop     #734      +/-   ##
=============================================
+ Coverage      79.83%   80.18%   +0.35%     
- Complexity      2475     2526      +51     
=============================================
  Files            104      106       +2     
  Lines          10006    10240     +234     
=============================================
+ Hits            7988     8211     +223     
- Misses          2018     2029      +11

Flag	Coverage Δ
unit	`80.18% <95.29%> (+0.35%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

jeffpaul · 2026-07-13T18:43:29Z

@coderGtm looks like a merge conflict, then perhaps good for re-review on our end?

coderGtm · 2026-07-13T18:58:51Z

@jeffpaul I am yet to add the e2e test and checking the validation and sanitization again. So once I do those and resolve the merge conflict, I'll manually request a re-review.

Thanks for checking it out.

# Conflicts: # routes/ai-home/stage.tsx

…for wpai_features_enabled

coderGtm · 2026-07-21T06:15:44Z

I have made the suggested improvements to this PR and it is ready for re-review.

cc: @jeffpaul @dkotter

…d settings are preserved during import.

feat: add settings import/export functionality

2683599

coderGtm and others added 2 commits June 16, 2026 14:11

docs: remove emdashes

d32f36a

Merge branch 'develop' into feature/import-export-config

e6b3b14

coderGtm marked this pull request as draft June 16, 2026 09:26

coderGtm and others added 2 commits June 18, 2026 13:34

Merge branch 'develop' into feature/import-export-config

b8b1ef9

lint: fix coding standard errors

38643d0

coderGtm and others added 5 commits June 19, 2026 16:37

lint: suppress eslint dot notation error

31d35ad

fix: ensure option names are consistently treated as strings

cb58b9e

Merge branch 'develop' into feature/import-export-config

b1f0a0a

fix: ensure option names are consistently treated as strings

bcdbfc4

Merge remote-tracking branch 'origin/feature/import-export-config' in…

73048bd

…to feature/import-export-config

coderGtm marked this pull request as ready for review June 19, 2026 12:34

dkotter assigned coderGtm Jun 23, 2026

dkotter requested changes Jun 23, 2026

View reviewed changes

dkotter added this to the Future Release milestone Jun 23, 2026

jeffpaul modified the milestones: Future Release, 1.2.0 Jun 26, 2026

refactor: offload logic from stage.tsx to separate files

9c91866

coderGtm requested a review from a team July 7, 2026 05:59

Merge branch 'develop' into feature/import-export-config

cf64958

# Conflicts: # includes/Main.php

coderGtm added 3 commits July 7, 2026 11:49

feat: register site health integration conditionally

388e486

feat: enhance sensitive option detection

033287c

phpcs: fix phpcs error

42fd441

jeffpaul modified the milestones: 1.2.0, 1.3.0 Jul 13, 2026

coderGtm and others added 4 commits July 20, 2026 13:23

Merge branch 'develop' into feature/import-export-config

f6c6a05

# Conflicts: # routes/ai-home/stage.tsx

fix: validate and sanitize values against registered schema; add tests

c55db59

fix: update Settings_IO_ControllerTest to ensure consistent baseline …

1bbc1a2

…for wpai_features_enabled

Merge branch 'develop' into feature/import-export-config

4566058

coderGtm requested a review from dkotter July 21, 2026 06:15

dkotter requested changes Jul 21, 2026

View reviewed changes

Comment thread includes/REST/Settings_IO_Controller.php Outdated

Comment thread routes/ai-home/hooks/use-settings-import-export.ts Outdated

coderGtm and others added 6 commits July 23, 2026 12:20

fix: include registered defaults for unset options and ensure disable…

9aa577b

…d settings are preserved during import.

fix: failing tests

98a024a

refactor: remove as any usage

488ddd9

Merge branch 'develop' into feature/import-export-config

4f04822

Merge branch 'develop' into feature/import-export-config

0a78a57

Output more robust error and success messages. Add documentation

4e62810

dkotter requested a review from jeffpaul as a code owner July 24, 2026 16:43

dkotter approved these changes Jul 24, 2026

View reviewed changes

dkotter merged commit 7d11901 into WordPress:develop Jul 24, 2026
24 checks passed

Uh oh!

Conversation

coderGtm commented Jun 16, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Use of AI Tools

Testing Instructions

Screenshots or screencast

Changelog Entry

Uh oh!

github-actions Bot commented Jun 16, 2026

Uh oh!

coderGtm commented Jun 18, 2026

Uh oh!

dkotter commented Jun 18, 2026

Uh oh!

dkotter left a comment

Choose a reason for hiding this comment

Uh oh!

dkotter Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

coderGtm Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

dkotter Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderGtm commented Jun 25, 2026

Uh oh!

codecov Bot commented Jul 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jeffpaul commented Jul 13, 2026

Uh oh!

coderGtm commented Jul 13, 2026

Uh oh!

coderGtm commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderGtm commented Jun 16, 2026 •

edited by github-actions Bot

Loading

codecov Bot commented Jul 7, 2026 •

edited

Loading