You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Enterprise identity management for WordPress powered by [WorkOS](https://workos.
10
10
11
11
### Custom AuthKit (WordPress-hosted login)
12
12
13
-
-**React login shell** on wp-login.php, `[workos_login_v2]` shortcode, `workos/login-form` block, and a dedicated `/workos/login/{profile}` route — all driven by the same TypeScript bundle
13
+
-**React login shell** on wp-login.php, `[workos:login]` shortcode, and a dedicated `/workos/login/{profile}` route — all driven by the same TypeScript bundle
14
14
-**Login Profiles** — admin-defined presets (enabled methods, pinned organization, signup/invite/reset toggles, MFA policy, branding) managed through a React admin editor at **WorkOS → Login Profiles**
3.**PHP filters** — last-mile mutation of the data the shell renders.
8
8
9
-
The same surfaces are available everywhere the AuthKit shell appears: the wp-login.php takeover, the `[workos_login_v2]` shortcode, the `workos/login-form` block, and the `/workos/login/{slug}` rewrite.
9
+
The same surfaces are available everywhere the AuthKit shell appears: the wp-login.php takeover, the `[workos:login]` shortcode, and the `/workos/login/{slug}` rewrite.
Copy file name to clipboardExpand all lines: readme.txt
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Integration with WorkOS connects your WordPress site with [WorkOS](https://worko
23
23
24
24
= Custom AuthKit =
25
25
26
-
* **WordPress-hosted React login** — no redirect to WorkOS for password, magic code, signup, invitation, or MFA. Mounts on wp-login.php, a shortcode (`[workos_login_v2]`), a Gutenberg block, and a dedicated `/workos/login/{profile}` route.
26
+
* **WordPress-hosted React login** — no redirect to WorkOS for password, magic code, signup, invitation, or MFA. Mounts on wp-login.php, a shortcode (`[workos:login]`), and a dedicated `/workos/login/{profile}` route.
27
27
* **Login Profiles** — admin-defined presets (enabled sign-in methods, pinned organization, signup/invite toggles, MFA policy, branding) edited from **WorkOS → Login Profiles**. The organization picker loads live from WorkOS so admins pick an org by name instead of pasting raw IDs.
28
28
* **Sign-in methods** — email + password, magic code, social OAuth (Google, Microsoft, GitHub, Apple), and passkey. Each profile chooses its own subset.
29
29
* **MFA** — TOTP, SMS, and WebAuthn/passkey with in-app enrollment + challenge. Profile-level `mfa.enforce` (`never`/`if_required`/`always`) and factor allowlist are applied at login time.
@@ -35,7 +35,7 @@ Integration with WorkOS connects your WordPress site with [WorkOS](https://worko
* **Login Bypass** — Access the native WordPress login form via `?fallback=1` when WorkOS is unavailable.
40
40
* **Password Reset Integration** — Redirect password reset to WorkOS or fall back to WordPress.
41
41
* **Registration Redirect** — Redirect registration to WorkOS AuthKit.
@@ -86,11 +86,11 @@ Yes, if "Password Fallback" is enabled in settings. Users can access the standar
86
86
87
87
= How do I add a login button to my site? =
88
88
89
-
Use the `[workos_login]` shortcode, add the "WorkOS Login" Gutenberg block, or use the "WorkOS Login" classic widget. All three render a styled login button that redirects to WorkOS AuthKit.
89
+
Add the "WorkOS Login" Gutenberg block or use the "WorkOS Login" classic widget. Both render a styled login button that redirects to WorkOS AuthKit.
90
90
91
91
= How do I show the new WordPress-hosted login (Custom AuthKit) on a page? =
92
92
93
-
Use `[workos_login_v2 profile="your-profile-slug"]`, add the "WorkOS Login Form" block, or link to `/workos/login/{profile}`. All three mount the same React shell. The reserved `default` Login Profile automatically takes over wp-login.php.
93
+
Use `[workos:login profile="your-profile-slug"]`or link to `/workos/login/{profile}`. Both mount the same React shell. The reserved `default` Login Profile automatically takes over wp-login.php.
94
94
95
95
= Can different login pages offer different sign-in methods? =
96
96
@@ -169,7 +169,7 @@ WorkOS is provided by WorkOS, Inc.
169
169
= 1.0.0 - 2026-04-23 =
170
170
171
171
Custom AuthKit (WordPress-hosted login):
172
-
* React login shell on wp-login.php, `[workos_login_v2]` shortcode, `workos/login-form` block, and `/workos/login/{profile}` route.
172
+
* React login shell on wp-login.php, `[workos:login]` shortcode, and `/workos/login/{profile}` route.
173
173
* Login Profiles — admin-defined presets for enabled methods, pinned organization, signup/invite/reset flows, MFA policy, and branding, managed at WorkOS → Login Profiles.
174
174
* Pinned-organization picker in the Profile editor reads live from WorkOS (with a "Custom ID…" fallback for legacy or unlisted orgs), and the Profiles list renders organization names instead of raw IDs.
0 commit comments