Add support for Blueprints login by bcotrim · Pull Request #2527 · Automattic/studio

bcotrim · 2026-02-03T18:34:14Z

Related issues

Fixes STU-829 STU-13 Feature Request: Default Admin name email #87

Proposed Changes

Remove login step from unsupported Blueprint features
Allow creating a site with custom admin username and password
Allow editing a site with custom admin username and password

Create site	Edit site

Testing Instructions

Pre-merge Checklist

Have you checked for TypeScript, React or other console errors?

wpmobilebot · 2026-02-03T18:48:24Z

📊 Performance Test Results

Comparing 8f06c9d vs trunk

site-editor

Metric	trunk	`8f06c9d`	Diff	Change
load	1397.00 ms	1438.00 ms	+41.00 ms	⚪ 0.0%

site-startup

Metric	trunk	`8f06c9d`	Diff	Change
siteCreation	7099.00 ms	7076.00 ms	-23.00 ms	⚪ 0.0%
siteStartup	3948.00 ms	3941.00 ms	-7.00 ms	⚪ 0.0%

Results are median values from multiple test runs.

Legend: 🟢 Improvement (faster) | 🔴 Regression (slower) | ⚪ No change (<50ms diff)

Implements STU-829 by allowing users to set custom admin username/password either via Blueprints or through new fields in Advanced settings. Blueprint credentials are extracted and pre-filled in the form, with CLI args taking precedence. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

…e form

…ests

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 32 out of 33 changed files in this pull request and generated 9 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-11T11:00:26Z

tools/common/lib/mu-plugins.ts

+						// Generate a unique email to avoid conflicts with existing users
+						$email = $provided_email ? $provided_email : 'admin@localhost.com';
+						if ( ! $provided_email ) {
+							$counter = 1;
+							while ( email_exists( $email ) && $counter < 100 ) {
+								$email = 'admin' . $counter . '@localhost.com';
+								$counter++;
+							}
+						}


When provided_email is provided but already exists in the database (checked by email_exists), the code still uses it without validation or uniqueness check. This could cause wp_insert_user to fail with a duplicate email error. The email uniqueness check with counter increment only applies when no email is provided. Consider checking if the provided email already exists and handling this case appropriately (either by showing an error to the user or generating a unique variation).

Copilot · 2026-02-11T11:00:27Z

common/lib/passwords.ts

+	if ( ! email.trim() ) {
+		return __( 'Admin email cannot be empty.' );
+	}
+	if ( ! /^[^\s@]+@[^\s@]+$/.test( email ) ) {


The email validation regex /^[^\s@]+@[^\s@]+$/ is very permissive and allows invalid emails like 'user@domain', 'user@.com', or 'user@@Domain'. While this might be intentional for local development environments, consider using a more robust email validation pattern that requires at least a TLD-like structure (e.g., /^[^\s@]+@[^\s@]+\.[^\s@]+$/) or use a standard email validation library to prevent common typos.

Suggested change

if ( ! /^[^\s@]+@[^\s@]+$/.test( email ) ) {

if ( ! /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test( email ) ) {

Copilot · 2026-02-11T11:00:27Z

src/modules/add-site/components/create-site-form.tsx

+		const hasErrors =
+			!! pathError ||
+			( useCustomDomain && !! customDomainError ) ||
+			! adminUsername.trim() ||
+			! adminPassword.trim();


The form validity check for onValidityChange (lines 283-287) doesn't include adminEmail validation, but the errorCount calculation at line 399-406 does include adminEmailError. This creates an inconsistency where the parent component might think the form is valid even when there's an email validation error, potentially allowing form submission with invalid data. Add adminEmail validation to the hasErrors check, similar to how errorCount is calculated.

Copilot · 2026-02-11T11:00:27Z

apps/cli/commands/site/set.ts

+	if ( adminEmail !== undefined ) {
+		const emailError = validateAdminEmail( adminEmail );
+		if ( emailError ) {
+			throw new LoggerError( emailError );
+		}
+	}


When adminEmail is provided but consists only of whitespace (e.g., --admin-email " "), the validateAdminEmail function will return an error message "Admin email cannot be empty." However, this contradicts the fact that email is optional in the UI. Consider checking if adminEmail.trim() is empty and if so, treating it as undefined/not provided rather than calling validateAdminEmail, to maintain consistency with the UI behavior where email is optional.

Copilot · 2026-02-11T11:00:28Z

tools/common/lib/mu-plugins.ts

@@ -416,18 +416,47 @@ function getStandardMuPlugins( options: MuPluginOptions ): MuPlugin[] {
 						exit;
 					}


The MU plugin accepts POST data without CSRF protection or authentication. While this is a local-only endpoint (studio-admin-api), it's important to note that any script running on the local machine could potentially call this endpoint. Consider adding a nonce or token-based authentication mechanism to prevent unauthorized admin credential modification, especially since passwords are being changed. Additionally, verify that the endpoint is only accessible from localhost/127.0.0.1.

Copilot · 2026-02-11T11:00:28Z

tools/common/lib/mu-plugins.ts

+					$username = ! empty( $_POST['username'] ) ? sanitize_user( $_POST['username'] ) : 'admin';
+					// Fallback to 'admin' if sanitize_user() strips all characters (e.g., !@#$%)
+					if ( empty( $username ) ) {


The username from POST is sanitized using sanitize_user(), which is correct. However, there's a fallback to 'admin' if sanitization strips all characters (line 421-422). This could mask validation issues - if a user intentionally sets an invalid username (like '!@#$%'), it silently changes to 'admin' instead of returning an error. Consider returning an error response when the sanitized username is empty but a username was provided, to match the client-side validation behavior.

Suggested change

$username = ! empty( $_POST['username'] ) ? sanitize_user( $_POST['username'] ) : 'admin';

// Fallback to 'admin' if sanitize_user() strips all characters (e.g., !@#$%)

if ( empty( $username ) ) {

if ( ! empty( $_POST['username'] ) ) {

$username = sanitize_user( $_POST['username'] );

// If a username was provided but sanitization removed all characters, treat as invalid input.

if ( $username === '' ) {

status_header( 400 );

header( 'Content-Type: application/json' );

echo json_encode( [ 'error' => 'Invalid username' ] );

exit;

}

} else {

// Default to 'admin' when no username is provided at all.

Copilot · 2026-02-11T11:00:28Z

src/modules/add-site/components/create-site-form.tsx

 		}
 		// eslint-disable-next-line react-hooks/exhaustive-deps
-	}, [ pathError, customDomainError, useCustomDomain ] );
+	}, [ pathError, customDomainError, useCustomDomain, adminUsername, adminPassword ] );


The useEffect dependencies list is missing adminEmail, even though adminEmail validation should affect form validity. This means changes to adminEmail won't trigger the validity check. Add adminEmail to the dependency array at line 296.

Suggested change

}, [ pathError, customDomainError, useCustomDomain, adminUsername, adminPassword ] );

}, [ pathError, customDomainError, useCustomDomain, adminUsername, adminPassword, adminEmail ] );

Copilot · 2026-02-11T11:00:28Z

cli/commands/site/create.ts

+		const adminEmail = options.adminEmail ?? undefined;
+		if ( adminEmail ) {
+			const emailError = validateAdminEmail( adminEmail );
+			if ( emailError ) {
+				throw new LoggerError( emailError );
+			}
+		}


When adminEmail is provided but consists only of whitespace, the validateAdminEmail function will return an error message "Admin email cannot be empty." However, this contradicts the fact that email is optional in the UI. Consider checking if adminEmail.trim() is empty and if so, treating it as undefined/not provided rather than calling validateAdminEmail, to maintain consistency with the UI behavior where email is optional.

Copilot · 2026-02-11T11:00:29Z

common/lib/blueprint-settings.ts

@@ -4,6 +4,8 @@ type BlueprintSiteSettings = Partial<
 	Pick< StoppedSiteDetails, 'phpVersion' | 'customDomain' | 'enableHttps' >


The type StoppedSiteDetails is used on line 4 but is not imported in this file. This will cause a TypeScript compilation error. Add the import statement for StoppedSiteDetails from the appropriate module (likely from 'src/ipc-types' or similar).

nightnei · 2026-02-12T14:30:16Z

Change username on a site that already has a custom username — verify new user created, old user left intact, auto-login works

I see this

Is it expected?

nightnei · 2026-02-12T14:32:10Z

I see that updating username creates a new user, is it expected?
I had expectation that the old one will be changed.

Maybe we should add some comment here. WDYT?

nightnei · 2026-02-12T14:34:22Z

Edit a legacy site (no stored credentials) without changing credentials — verify no unnecessary restart

Could you please provide more testing instruction or/and context for this test?

nightnei · 2026-02-12T15:13:11Z

I also tested email changes and everything works well 👍
Shallowly reviewed code changes - all LGTM 👍
Just left a few comments

bcotrim · 2026-02-12T15:38:19Z

Thanks for the review @nightnei

Change username on a site that already has a custom username — verify new user created, old user left intact, auto-login works

I see this Is it expected?

Yup, this is expected! AFAIK WordPress doesn’t support renaming user_login. So when someone changes the username, we create a new admin user and the old one stays. Added a code comment to make this clearer 👍

Could you please provide more testing instruction or/and context for this test?

A site created before this PR, we would always use admin admin@localhost.com and a generated password. Unrelated changes to the site settings (like site name for example) should not prompt for a server restart and have no side effects on user login.

wojtekn · 2026-02-13T08:27:23Z

Can we group and name fields in 'Add site' and 'Edit site' forms consistently?

bcotrim · 2026-02-13T13:14:24Z

Can we group and name fields in 'Add site' and 'Edit site' forms consistently?

Done

bcotrim · 2026-02-18T16:07:27Z

@wojtekn @nightnei could you give this PR another review please?

katinthehatsite · 2026-02-19T12:55:12Z

tools/common/lib/mu-plugins.ts

+						if ( ! $provided_email ) {
+							$counter = 1;
+							while ( email_exists( $email ) && $counter < 100 ) {
+								$email = 'admin' . $counter . '@localhost.com';


I am wondering if we should use something like: $email = 'admin-' . uniqid() . '@localhost.com'; for guaranteed uniqueness. It is just a minor thing though so feel free to skip the suggestion

katinthehatsite · 2026-02-19T12:57:12Z

tools/common/lib/mu-plugins.ts

+							wp_update_user( array( 'ID' => $user->ID, 'user_email' => $provided_email ) );
+						}
 					} else {
+						// WordPress doesn't support renaming user_login, so we create a new admin user.


I am wondering if this needs to be communicated to users in some way in the UI 🤔 Could be a notice like: Changing the username will create a new admin user. The previous admin user will remain in the database. but then this might be overengineering 🤔

The reason why I was asking this is because the user could still see it on their local site which could be potentially confusing:

katinthehatsite · 2026-02-19T13:09:43Z

tools/common/lib/passwords.ts

+		return __( 'Admin username cannot be empty.' );
+	}
+	if ( ! /^[a-zA-Z0-9_.@-]+$/.test( username ) ) {
+		return __( 'Username can only contain letters, numbers, and _.@- characters' );


I am wondering if we should stretch this along one line even if it goes under Password field. I think it looks a bit cut off now and I am not seeing any harm if it streches out. This will make it consistent with other

As a sidenote, should this end with a period? It looks like all the other strings contain period

katinthehatsite · 2026-02-19T13:16:08Z

apps/studio/src/modules/add-site/components/create-site-form.tsx

+											hasUserEditedCredentials.current = true;
+											setAdminEmail( value );
+										} }
+										placeholder="admin@localhost.com"


I am wondering if instead of a placeholder, we should add below a description such as The email defaults to admin@localhost.com` if not added or something along these lines. This could make it clearer to the user what the default is. Not a strong prefernce on my end though

katinthehatsite

Overall, the functionality looked good to me and I did not find anything major 👍 I left some minor comments for consideration but nothing blocking. I tested with the following file (in case someone wants to use it for testing):

blueprints.json

nightnei

Thanks @bcotrim, everything LGTM 👍
Also, I like the comment from Kat about adding a description to the UI, that the new user will be created. I would add it.

…prints-login

bcotrim · 2026-02-20T15:24:46Z

@katinthehatsite thanks for the review!
I've addressed most of the feedback. Regarding the username validation error I tried it but it looks strange if both username and password have validation errors:

I have decided to keep the error in the field column.

Would love another review when you get a chance! 🙏

bcotrim marked this pull request as draft February 3, 2026 18:34

bcotrim force-pushed the bcotrim/stu-829-blueprints-login branch 3 times, most recently from e61ae98 to 464cfac Compare February 4, 2026 15:02

bcotrim force-pushed the bcotrim/stu-829-blueprints-login branch from 464cfac to becd91f Compare February 4, 2026 15:12

bcotrim added 7 commits February 4, 2026 15:35

Add error handling for user creation and security note for CLI passwords

b330fe5

Fix hardcoded admin username in CLI output and site settings UI

33e613e

Add default values and validation for admin credentials in create sit…

cdd1dbd

…e form

Fix adminUsername not being persisted in toDiskFormat

d7e07ff

Fix password encoding, i18n, and credential editing guard

20ec434

Add username sanitization and PasswordControl tests

9e0cc1a

Add sanitize_user fallback, username format validation, and Unicode t…

fea6997

…ests

bcotrim self-assigned this Feb 5, 2026

bcotrim added 2 commits February 5, 2026 11:51

Add credential editing to site settings UI and CLI set command

a8330fe

Fix add-site test assertions for credential args

df06509

bcotrim marked this pull request as ready for review February 5, 2026 13:40

Merge branch 'trunk' into bcotrim/stu-829-blueprints-login

55e7f44

bcotrim requested a review from a team February 5, 2026 13:40

bcotrim added 2 commits February 6, 2026 19:19

Fix hardcoded admin username in site status command

a60cc40

Add admin email field to site settings and CLI

ab2fdc4

sejas requested a review from Copilot February 10, 2026 14:59

Copilot started reviewing on behalf of sejas February 10, 2026 14:59 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

Merge branch 'trunk' into bcotrim/stu-829-blueprints-login

ecd224c

bcotrim requested a review from Copilot February 11, 2026 10:53

Copilot started reviewing on behalf of bcotrim February 11, 2026 10:53 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes

copilot feedback

c3f6846

Merge branch 'trunk' into bcotrim/stu-829-blueprints-login

5782dc9

Merge branch 'trunk' into bcotrim/stu-829-blueprints-login

298f79e

Add comment explaining username change creates new user

5d641eb

bcotrim added 2 commits February 13, 2026 09:27

Merge trunk and make form field labels consistent

b41fc38

Fix prettier formatting in create-site-form

aa79075

Merge trunk and resolve monorepo restructure conflicts

e15dcee

katinthehatsite reviewed Feb 19, 2026

View reviewed changes

nightnei approved these changes Feb 19, 2026

View reviewed changes

bcotrim added 4 commits February 20, 2026 09:18

Merge remote-tracking branch 'origin/trunk' into bcotrim/stu-829-blue…

1219f51

…prints-login

Address PR feedback: credential form UX improvements

e13ace1

Merge remote-tracking branch 'origin/trunk' into bcotrim/stu-829-blue…

a4a8363

…prints-login

Fix import ordering and prettier formatting

ef8e1e2

bcotrim requested a review from katinthehatsite February 20, 2026 15:21

bcotrim and others added 4 commits February 23, 2026 15:43

Merge branch 'trunk' into bcotrim/stu-829-blueprints-login

8a64388

Fix credential updates for legacy sites and copySite missing fields

1c57a40

Merge trunk and resolve conflicts with debug log/display feature

8c43a63

Merge trunk and resolve create command config conflict

8f06c9d

	if ( ! /^[^\s@]+@[^\s@]+$/.test( email ) ) {
	if ( ! /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test( email ) ) {

		@@ -416,18 +416,47 @@ function getStandardMuPlugins( options: MuPluginOptions ): MuPlugin[] {
		exit;
		}

-					$username = ! empty( $_POST['username'] ) ? sanitize_user( $_POST['username'] ) : 'admin';
-					// Fallback to 'admin' if sanitize_user() strips all characters (e.g., !@#$%)
-					if ( empty( $username ) ) {
+					if ( ! empty( $_POST['username'] ) ) {
+						$username = sanitize_user( $_POST['username'] );
+						// If a username was provided but sanitization removed all characters, treat as invalid input.
+						if ( $username === '' ) {
+							status_header( 400 );
+							header( 'Content-Type: application/json' );
+							echo json_encode( [ 'error' => 'Invalid username' ] );
+							exit;
+						}
+					} else {
+						// Default to 'admin' when no username is provided at all.

	}, [ pathError, customDomainError, useCustomDomain, adminUsername, adminPassword ] );
	}, [ pathError, customDomainError, useCustomDomain, adminUsername, adminPassword, adminEmail ] );

		@@ -4,6 +4,8 @@ type BlueprintSiteSettings = Partial<
		Pick< StoppedSiteDetails, 'phpVersion' \| 'customDomain' \| 'enableHttps' >

Conversation

bcotrim commented Feb 3, 2026 • edited by nightnei Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Proposed Changes

Testing Instructions

Pre-merge Checklist

Uh oh!

wpmobilebot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Performance Test Results

site-editor

site-startup

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

nightnei commented Feb 12, 2026

Uh oh!

nightnei commented Feb 12, 2026

Uh oh!

nightnei commented Feb 12, 2026

Uh oh!

nightnei commented Feb 12, 2026

Uh oh!

bcotrim commented Feb 12, 2026

Uh oh!

wojtekn commented Feb 13, 2026

Uh oh!

bcotrim commented Feb 13, 2026

Uh oh!

bcotrim commented Feb 18, 2026

Uh oh!

katinthehatsite Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

katinthehatsite Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

katinthehatsite Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

katinthehatsite Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

katinthehatsite Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

katinthehatsite Feb 19, 2026

bcotrim commented Feb 3, 2026 •

edited by nightnei

Loading

wpmobilebot commented Feb 3, 2026 •

edited

Loading