From 74d4d4974b95ff2a2161be1dcc0c8ec0e288215d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerg=C5=91=20Tisza?= Date: Thu, 28 Dec 2023 19:46:14 -0800 Subject: documentation: Mention ReservedUsernames in newSystemUser() Change-Id: I90df61c39f351a3ea7adda3f0a6b06342b04ca17 --- includes/user/User.php | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'includes/user') diff --git a/includes/user/User.php b/includes/user/User.php index a0972a124586..b8ae0b70ef2e 100644 --- a/includes/user/User.php +++ b/includes/user/User.php @@ -41,6 +41,7 @@ use MediaWiki\HookContainer\ProtectedHookAccessorTrait; use MediaWiki\Logger\LoggerFactory; use MediaWiki\Mail\UserEmailContact; use MediaWiki\MainConfigNames; +use MediaWiki\MainConfigSchema; use MediaWiki\MediaWikiServices; use MediaWiki\Page\PageIdentity; use MediaWiki\Parser\Sanitizer; @@ -767,6 +768,8 @@ class User implements Authority, UserIdentity, UserEmailContact { * - AuthManager is instructed to revoke access, to invalidate or remove * passwords and other credentials. * + * System users should usually be listed in $wgReservedUsernames. + * * @param string $name Username * @param array $options Options are: * - validate: Type of validation to use: @@ -780,6 +783,8 @@ class User implements Authority, UserIdentity, UserEmailContact { * exists, default false * @return User|null * @since 1.27 + * @see self::isSystemUser() + * @see MainConfigSchema::ReservedUsernames */ public static function newSystemUser( $name, $options = [] ) { $options += [ -- cgit v1.2.3