DevOps:Doc/FlexForm/2.5/API/FlexFormOpen - Revision history

3f181944-9694-4c7c-83d3-a6193204adb3 at 14:37, 23 February 2026

2026-02-23T14:37:51Z

← Older revision		Revision as of 16:37, 23 February 2026
Line 3:		Line 3:

	===Type===		===Type===
	FlexFormOpen		FlexFormOpen (Available since 2.7.1)

	===Synopsis===		===Synopsis===

3f181944-9694-4c7c-83d3-a6193204adb3: 3f181944-9694-4c7c-83d3-a6193204adb3 moved page DevOps:Doc/FlexForm/1.1/API/FlexFormOpen to DevOps:Doc/FlexForm/2.5/API/FlexFormOpen: Misspelled title

2026-02-23T14:35:26Z

3f181944-9694-4c7c-83d3-a6193204adb3 moved page FlexFormOpen to FlexFormOpen: Misspelled title

← Older revision	Revision as of 16:35, 23 February 2026
(No difference)

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295: User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295

2026-02-23T14:31:37Z

Charlot Cobben

ws-class-props
← Older revision		Revision as of 16:31, 23 February 2026
Line 1:		Line 1:
	{{Csp class properties		{{Csp class properties
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm
	\|Subject version=~~1.1,2.0,2.1,~~2.5		\|Subject version=2.5
	\|Doc parent=DevOps:Doc/FlexForm/1.1/API		\|Doc parent=DevOps:Doc/FlexForm/1.1/API
	\|Doc sort order=10		\|Doc sort order=10

3f181944-9694-4c7c-83d3-a6193204adb3 at 14:24, 23 February 2026

2026-02-23T14:24:39Z

← Older revision		Revision as of 16:24, 23 February 2026
Line 1:		Line 1:
	~~fdsfds~~		===Name===
			API

			===Type===
			FlexFormOpen

			===Synopsis===
			Open FlexForm API endpoint for lightweight validation actions.

			===Description===
			The '''FlexFormOpen''' API provides limited, publicly accessible FlexForm functionality intended for frontend validation use cases. It does not require readapi-rights.

			Currently, the available actions are:

			* '''canUserBeCreated''' – Checks whether a username can be created.

			This API is especially useful when implementing [[DevOps:Doc/FlexForm/2.0/CreateUser\|CreateUser]] forms.

			When paired with JavaScript, it allows real-time username validation (e.g., checking whether a username already exists or is invalid) before form submission.

			For security reasons, this API is '''disabled by default'''.

			To enable it, set the following configuration option:

			<syntaxhighlight lang="php">
			$wgFlexFormConfig['allowFlexFormOpenAPI'] = true;
			</syntaxhighlight>

			===Parameters===
			'''ffAction''' – The FlexFormOpen action to execute.

			* '''canUserBeCreated''' (required)

			'''additionalData''' – Additional data required for the action.

			* For '''canUserBeCreated''', this must contain the username to validate. (required)

			===Action: canUserBeCreated===
			Checks whether a username:

			* Does not already exist
			* Meets MediaWiki username validation requirements
			* Can safely be created

			This action does not create the user. It only performs validation.

			===Example (JavaScript)===
			Example using MediaWiki's mw.Api():

			<syntaxhighlight lang="javascript">
			var api = new mw.Api();

			api.get({
			action: "FlexFormOpen",
			ffAction: "canUserBeCreated",
			additionalData: correctedUsername,
			formatversion: 2
			}).done(function (data) {

			if (data.canUser === true) {
			console.log("Username can be created.");
			} else {
			console.log("Username cannot be created.");
			}

			});
			</syntaxhighlight>

			If the API is disabled via configuration (or default):

			<syntaxhighlight lang="json">
			{
			"error": {
			"message": "FlexFormOpen API is disabled."
			}
			}
			</syntaxhighlight>

			===Security Considerations===
			Because this API does not require authentication, it is disabled by default.

			It is strongly recommended to:

			* Only enable it when necessary
			* Implement frontend throttling or rate limiting if heavy usage is expected
			* Avoid exposing sensitive validation logic

			===Future Improvements===
			In future versions, an optional attribute may be introduced on FlexForm input fields that automatically performs username validation without requiring custom JavaScript.

3f181944-9694-4c7c-83d3-a6193204adb3: User:3f181944-9694-4c7c-83d3-a6193204adb3

2026-02-23T14:12:33Z

User:3f181944-9694-4c7c-83d3-a6193204adb3

ws-class-props
← Older revision	Revision as of 16:12, 23 February 2026
Line 1:	Line 1:
		{{Csp class properties
		\|Doc subject=DevOps:Doc/FlexForm
		\|Subject version=1.1,2.0,2.1,2.5
		\|Doc parent=DevOps:Doc/FlexForm/1.1/API
		\|Doc sort order=10
		\|Doc target group=Developer
		\|Doc synopsis=Trigger a FlexForm open action
		}}

3f181944-9694-4c7c-83d3-a6193204adb3: User:3f181944-9694-4c7c-83d3-a6193204adb3

2026-02-23T14:12:25Z

User:3f181944-9694-4c7c-83d3-a6193204adb3

ws-base-props
← Older revision	Revision as of 16:12, 23 February 2026
Line 1:	Line 1:
		{{Base properties
		\|Title=FlexFormOpen
		\|Class=Doc
		}}

3f181944-9694-4c7c-83d3-a6193204adb3: Created page with "fdsfds"

2026-02-23T14:12:15Z

Created page with "fdsfds"

New page

fdsfds