PHPackages yongtiger/yii2-user - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. yongtiger/yii2-user ActiveYii2-extension[Authentication & Authorization](/categories/authentication) yongtiger/yii2-user =================== v0.24.5(8y ago)1841MITPHPPHP >=5.5 Since Jan 3Pushed 8y ago1 watchersCompare [ Source](https://github.com/yongtiger/yii2-user)[ Packagist](https://packagist.org/packages/yongtiger/yii2-user)[ Docs](http://www.branbook.cc)[ RSS](/packages/yongtiger-yii2-user/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (9)Versions (81)Used By (1) Yii2-user v0.24.5 (ADD# avatarWidgetConfig) =========================================== [](#yii2-user-v0245-add-avatarwidgetconfig) The most basic `user` module. [![Latest Stable Version](https://camo.githubusercontent.com/1ee5c78659fa0d8f8918d70ade8100be620cb6ac01cc83e0e7dd9f2dfd7cfec0/68747470733a2f2f706f7365722e707567782e6f72672f796f6e6774696765722f796969322d757365722f762f737461626c65)](https://packagist.org/packages/yongtiger/yii2-user)[![Total Downloads](https://camo.githubusercontent.com/64138a0d3cf3882fbb9dc24f51e22f48c27aefbbefdcda27f8a43c375462cb65/68747470733a2f2f706f7365722e707567782e6f72672f796f6e6774696765722f796969322d757365722f646f776e6c6f616473)](https://packagist.org/packages/yongtiger/yii2-user)[![Latest Unstable Version](https://camo.githubusercontent.com/ad02efd2ba41628dfdb65bb0cf65a6b158ffd0f27443dc5e6efcc324d6f6dba1/68747470733a2f2f706f7365722e707567782e6f72672f796f6e6774696765722f796969322d757365722f762f756e737461626c65)](https://packagist.org/packages/yongtiger/yii2-user)[![License](https://camo.githubusercontent.com/dd09300150ac5a7c066b221ee43e1380e631a9f66ac9802bc2d7e80ea899ffd3/68747470733a2f2f706f7365722e707567782e6f72672f796f6e6774696765722f796969322d757365722f6c6963656e7365)](https://packagist.org/packages/yongtiger/yii2-user) FEATURES -------- [](#features) - `User` module directly from Yii2 Advanced Template - internationalization with i18n - using `User` module both frontend & backend - `mailer` layout & views in `user` module - using `repassword` in signup, resetPassword - using `captcha` in `signup`, `login`, `requestPasswordResetToken`, `resetPassword` and backend `login` - ajax validation in `signup`, `login`, `requestPasswordResetToken` - activation via Email - Oauth login (if no user, try ot signup) - automatically updating oauth info - config of `User` module - login with username or email - password and email verify - user account - user account oauth - token sender and handler - change forms (ChangeUsernameForm, ChangeEmailForm, ChangePasswordForm) DEPENDENCES ----------- [](#dependences) - [Yii2 Advanced Template](https://github.com/yiisoft/yii2-app-advanced) INSTALLATION ------------ [](#installation) The preferred way to install this extension is through [composer](http://getcomposer.org/download/). Either run ``` php composer.phar require --prefer-dist yongtiger/yii2-user "*" ``` or add ``` "yongtiger/yii2-user": "*" ``` to the require section of your composer.json. CONFIGURATION ------------- [](#configuration) ### \\common\\config\\main.php [](#commonconfigmainphp) ``` 'components' => [ 'mailer' => [ 'class' => 'yii\swiftmailer\Mailer', 'viewPath' => '@common/mail', ///[Yii2 uesr:mail] 'htmlLayout' =>'@yongtiger/user/mail/layouts/html', 'textLayout' =>'@yongtiger/user/mail/layouts/text', // send all mails to a file by default. You have to set // 'useFileTransport' to false and configure a transport // for the mailer to send real emails. 'useFileTransport' => true, ], // ... ] ``` ### \\backend\\config\\main.php [](#backendconfigmainphp) ``` 'modules' => [ 'user' => [ 'class' => 'yongtiger\user\Module', ///Signup 'enableSignup' => false, 'disableSignupMessage' => false, ///[v0.9.5 (backend disableSignupMessage)] 'enableRecoveryPassword' => false, ///[v0.9.7 (backend:enableRecoveryPassword)] // ... ], 'components' => [ ///[Yii2 uesr] 'user' => [ 'identityClass' => 'yongtiger\user\models\User', 'enableAutoLogin' => true, 'identityCookie' => ['name' => '_identity-backend', 'httpOnly' => true], 'loginUrl' => ['user/security/login'], ///default is 'site/login' ], // ... ] ``` ### \\frontend\\config\\main.php [](#frontendconfigmainphp) ``` 'modules' => [ 'user' => [ 'class' => 'yongtiger\user\Module', ///Signup 'enableSignup' => false, 'disableSignupMessage' => Yii::t('user', 'This site has been closed registration.'), 'enableSignupWithUsername' => false, 'enableSignupWithRepassword' => false, 'enableSignupWithEmail' => false, 'enableSignupWithEmailActivation' => false, 'signupWithEmailActivationExpire' => 600, 'signupWithEmailActivationComposeHtml' => '@yongtiger/user/mail/activate-status-html', 'signupWithEmailActivationComposeText' => '@yongtiger/user/mail/activate-status-text', 'signupWithEmailActivationSetFrom' => ['support@brainbook.cc' => 'My Application robot'], 'enableSignupAjaxValidation' => false, 'enableSignupClientValidation' => false, 'enableSignupValidateOnBlur' => false, 'enableSignupValidateOnSubmit' => false, 'enableSignupWithCaptcha' => false, ///Login 'enableLogin' => false, 'disableLoginMessage' => Yii::t('user', 'This site has been closed login.'), //////[Yii2 uesr:login with username or email]when both `enableLoginWithUsername` and `enableLoginWithEmail` are `true` 'enableLoginWithUsername' => false, 'enableLoginWithEmail' => false, 'enableLoginAjaxValidation' => false, 'enableLoginClientValidation' => false, 'enableLoginValidateOnBlur' => false, 'enableLoginValidateOnSubmit' => false, 'enableLoginWithCaptcha' => false, ///[Yii2 uesr:recovery] 'enableRecoveryPassword' => true, ///[v0.9.7 (backend:enableRecoveryPassword)] 'recoveryPasswordExpire' => 0, 'recoveryPasswordComposeHtml' => '@yongtiger/user/mail/recover-password-html', 'recoveryPasswordComposeText' => '@yongtiger/user/mail/recover-password-text', 'recoveryPasswordSetFrom' => ['support@brainbook.cc' => 'My Application robot'], ///[Yii2 uesr:account] 'enableAccountChangeWithPassword' => false, 'enableAccountChangePasswordWithRepassword' => false, 'accountVerificatonExpire' => 600, 'accountVerifyEmailComposeHtml' => '@yongtiger/user/mail/verify-email-html', 'accountVerifyEmailComposeText' => '@yongtiger/user/mail/verify-email-text', 'accountVerifyEmailSetFrom' => ['support@brainbook.cc' => 'My Application robot'], 'enableAccountChangeAjaxValidation' => false, 'enableAccountChangeClientValidation' => false, 'enableAccountChangeValidateOnBlur' => false, 'enableAccountChangeValidateOnSubmit' => false, 'enableAccountChangeWithCaptcha' => false, ///[Yii2 uesr:token] 'enableSendTokenWithoutLoad' => false, 'enableSendTokenAjaxValidation' => false, 'enableSendTokenClientValidation' => false, 'enableSendTokenValidateOnBlur' => false, 'enableSendTokenValidateOnSubmit' => false, 'enableSendTokenWithCaptcha' => false, ///[Yii2 uesr:captcha] 'captcha' => [ 'class' => 'yii\captcha\CaptchaAction', // 'controller'=>'login', ///The controller that owns this action // 'backColor'=>0xFFFFFF, ///The background color. For example, 0x55FF00. Defaults to 0xFFFFFF, meaning white color. // 'foreColor'=>0x2040A0, ///The font color. For example, 0x55FF00. Defaults to 0x2040A0 (blue color). // 'padding' => 5, ///Padding around the text. Defaults to 2. // 'offset'=>-2, ///The offset between characters. Defaults to -2. You can adjust this property in order to decrease or increase the readability of the captcha. 'height' => 36, ///The height of the generated CAPTCHA image. Defaults to 50. need to be adjusted according to the specific verification code bit 'width' => 96, ///The width of the generated CAPTCHA image. Defaults to 120. 'maxLength' =>6, ///The maximum length for randomly generated word. Defaults to 7. 'minLength' =>4, ///The minimum length for randomly generated word. Defaults to 6. 'testLimit'=>5, ///How many times should the same CAPTCHA be displayed. Defaults to 3. A value less than or equal to 0 means the test is unlimited (available since version 1.1.2). Note that when 'enableClientValidation' is true (default), it will be invalid! 'fixedVerifyCode' => YII_ENV_TEST ? 'testme' : null, ///The fixed verification code. When this property is set, getVerifyCode() will always return the value of this property. This is mainly used in automated tests where we want to be able to reproduce the same verification code each time we run the tests. If not set, it means the verification code will be randomly generated. ], 'captchaActiveFieldWidget' => [ 'class' => 'yii\captcha\Captcha', 'imageOptions' => ['alt' => 'Verification Code', 'title' => 'Click to change another verification code.'], 'template' => '{image}{input}', ], ///[Yii2 uesr:oauth] 'enableOauth' => false, 'enableOauthSignup' => false, 'enableOauthSignupValidation' => false, 'authChoiceWidgetConfig' => [ 'baseAuthUrl' => new \yii\helpers\ReplaceArrayValue(['security/auth']), ///cannot be `['security/auth']`! ArrayHelper::merge will get wrong result. instead, we use `ReplaceArrayValue`. // 'popupMode' => false, ///defaults to true // 'options' => ['class'=>'control-label'], ///widget div options 'clientOptions' => [ 'popup'=> [ 'resizable'=>'yes', 'scrollbars'=>'yes', // 'toolbar'=>'no', // 'menubar'=>'no', // 'location'=>'no', // 'directories'=>'no', // 'status'=>'yes', // 'width'=>450, // 'height'=>380, ] ], ], 'auth' => [ 'class' => 'yii\authclient\AuthAction', // 'successCallback' => Yii::$app->user->isGuest ? [$this, 'authenticate'] : [$this, 'connect'], ///cannot configure 'successCallback' here because of `$this`!!! ///Cannot use `Yii::$app` here! we will use `Yii::$app->urlManager->createUrl()` in module init() later ///Cannot be `['security/auth']`! ArrayHelper::merge will get wrong result. instead, we use `ReplaceArrayValue`. 'successUrl' => new \yii\helpers\ReplaceArrayValue(['user/account/index']), 'cancelUrl' => new \yii\helpers\ReplaceArrayValue(['user/security/login']), ] ], ], 'components' => [ ///[Yii2 uesr] 'user' => [ 'identityClass' => 'yongtiger\user\models\User', 'enableAutoLogin' => true, 'identityCookie' => ['name' => '_identity-frontend', 'httpOnly' => true], 'loginUrl' => ['user/security/login'], ], ///[Yii2 uesr:oauth] 'authClientCollection' => [ 'class' => 'yii\authclient\Collection', 'clients' => [ 'google' => [ 'class' => 'yongtiger\authclient\clients\Google', 'clientId' => '409149769406-aigbmsp0doiqtgj167c2oqtl294pdbsp.apps.googleusercontent.com', 'clientSecret' => 'Y-PGLBHKJWM3XNyCyOXJCbdB', ///'scope' => 'profile email', ], 'twitter' => [ 'class' => 'yongtiger\authclient\clients\Twitter', 'consumerKey' => '8qsSIMpcPm0UWdBpHWl8bGNKY', 'consumerSecret' => 'RgE1AGjTVMVxzzGn0W9VB6KinItwT7qySb0yNFyEK3zb7AErlw', 'attributeParams' => [ 'include_email' => 'true' ], ], 'yandex' => [ 'class' => 'yongtiger\authclient\clients\Yandex', 'clientId' => '6c630052d9d7452c802963caf10cc835', 'clientSecret' => 'dce654019d944666a77856b5418a11e9', ], 'vkontakte' => [ 'class' => 'yongtiger\authclient\clients\VKontakte', 'clientId' => '5827650', 'clientSecret' => '0h9bQ0Jznka53DOS1TjE', ], 'facebook' => [ 'class' => 'yongtiger\authclient\clients\Facebook', 'clientId' => '1821672494750455', 'clientSecret' => '312e971fce4ec12c9966790c7a1704fa', ], 'linkedin' => [ 'class' => 'yongtiger\authclient\clients\LinkedIn', 'clientId' => '86ehrtbhkko1tl', 'clientSecret' => 'wS39dshiAzr9Myrl', // 'scope' => 'r_basicprofile r_emailaddress' ], 'github' => [ 'class' => 'yongtiger\authclient\clients\GitHub', 'clientId' => 'd9bf109efa527c68d1a7', 'clientSecret' => 'af919e40ce0fffdd1650e7bbab8c17bdb18560d4', // 'normalizeUserAttributeMap' => ['username'=>'login'], ///'scope' => 'user:email user', // 'viewOptions' => [ // 'popupWidth' => 160, // 'popupHeight' => 480, // ], ], 'live' => [ 'class' => 'yongtiger\authclient\clients\Live', 'clientId' => '11a7aa93-7369-42aa-8477-426aca7d1839', 'clientSecret' => '2YjcjkCBYwtiBHyp6mmvauh', ///'scope' => 'wl.basic wl.emails wl.contacts_emails wl.signin', ], // 'google-hybrid' => [ ///@see http://www.yiiframework.com/doc-2.0/yii-authclient-clients-googlehybrid.html // 'class' => 'yongtiger\authclient\clients\GoogleHybrid', // 'clientId' => '***', // 'clientSecret' => '***', // 'scope' => 'email' // 'viewOptions' => [ // 'widget' => [ // 'class' => 'yii\authclient\widgets\GooglePlusButton', // 'buttonHtmlOptions' => [ // 'data-approvalprompt' => 'force' // ], // ], // ], // ], 'yahoo' => [ 'class' => 'yongtiger\authclient\clients\Yahoo', ///@see https://github.com/dnshouse/yii2-authclient-extended/blob/master/Yahoo.php 'clientId' => 'dj0yJmk9aVMxbnRvclppM1NmJmQ9WVdrOU4zZHlSMVJ3TXpJbWNHbzlNQS0tJnM9Y29uc3VtZXJzZWNyZXQmeD1iZg--', 'clientSecret' => 'f17f0e8925bf17b8ff20a45517c628cd4f78dcdc', ///'scope' => 'openid profile' ], 'amazon' => [ 'class' => 'yongtiger\authclient\clients\Amazon', ///@see https://github.com/xjflyttp/yii2-oauth/blob/master/AmazonAuth.php 'clientId' => 'amzn1.application-oa2-client.c3b583b90a274981a36d53f47234f111', 'clientSecret' => 'd303910396688e088350570281d4896fbb641661bac06ce1ff5a68fdcc4a2717', ], 'instagram' => [ 'class' => 'yongtiger\authclient\clients\Instagram', 'clientId' => '70a18ce48a8c4ffb92b0d5b288bed466', 'clientSecret' => '8b59f9def099438b9259b62fc23808fd', ], 'reddit' => [ 'class' => 'yongtiger\authclient\clients\Reddit', ///@see https://github.com/amnah/yii2-user/blob/master/components/RedditAuth.php 'clientId' => 'rDzcE3ocGlxacg', 'clientSecret' => '9SKzxseITtqTgwDQFksUkvVLzwA', ], 'qq' => [ 'class' => 'yongtiger\authclient\clients\Qq', 'clientId' => '101367642', 'clientSecret' => '3fce443fcbf5789f8790d7f055de21da', ], 'weixin' => [ 'class' => 'yongtiger\authclient\clients\Weixin', 'clientId' => 'wx2634dbab565e2f27', 'clientSecret' => 'aefe4921e37778bd475054b78a6eff30', ], 'weibo' => [ 'class' => 'yongtiger\authclient\clients\Weibo', 'clientId' => '812398870', 'clientSecret' => 'e16fef081e8c717d4457434b630312be', ], // 'douban' => [ // 'class' => 'yongtiger\authclient\clients\Douban', // 'clientId' => '***', // 'clientSecret' => '***', // ], // 'renren' => [ // 'class' => 'yongtiger\authclient\clients\Renren', // 'clientId' => '***', // 'clientSecret' => '***', // ], ], ], // ... ] ``` > Note: Using behaviors of backend module, prohibit controllers of the module (such as `user`) which can be used in both frontend and backend. You can add your own backend module/controllers, otherwise it will not be accessed in the background. > Note: Use your own backend views in practical application! ### Internationalization setup (optional) [](#internationalization-setup-optional) All text and messages introduced in this extension are translatable under category: ``` 'extensions/yongtiger/yii2-user/*' ``` And the default basePath is '@vendor/yongtiger/yii2-user/src/messages'. If you want to custumize your own translations, using following application configuration: ``` return [ 'components' => [ 'i18n' => [ 'translations' => [ 'extensions/yongtiger/yii2-user/*' => [ 'class' => 'yii\i18n\PhpMessageSource', 'sourceLanguage' => 'en-US', 'basePath' => '', ///custumize your own translations 'fileMap' => [ 'extensions/yongtiger/yii2-user/user' => 'user.php', ], ], // ... ], ], // ... ], // ... ]; ``` USAGE IN FRONTEND ----------------- [](#usage-in-frontend) - guest: ``` /user /user/security /user/security/login /user/security/logout /user/registration/signup /user/token/send-token&type=recovery /user/token/send-token&type=activation ``` - after logged in: ``` /user/account/index /user/account/change&item=username /user/account/change&item=email /user/account/change&item=password /user/security/disconnect&provider= /user/security/auth&authclient= ``` USAGE IN BACKEND ---------------- [](#usage-in-backend) ``` ``` NOTES ----- [](#notes) - CAPTCHA validation should not be used in AJAX validation mode. @see () DOCUMENTS --------- [](#documents) SEE ALSO -------- [](#see-also) - [i18n:Long Text Translation](docs/i18n-long-text-translation.md) TODO ---- [](#todo) [Development roadmap](docs/development-roadmap.md) -------------------------------------------------- [](#development-roadmap) LICENSE ------- [](#license) **Yii2-user** is released under the MIT license, see [LICENSE](https://opensource.org/licenses/MIT) file for details. ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community6 Small or concentrated contributor base Maturity63 Established project with proven stability How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~4 days Total 80 Last Release 3070d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/4419bd4781ece5b372f87972d5559c6a9ff305d8600fcf99409ce072922b9771?d=identicon)[yongtiger](/maintainers/yongtiger) --- Tags Authenticationuseroauthrbacprofileyii2extensionsocial ### Embed Badge ![Health badge](/badges/yongtiger-yii2-user/health.svg) ``` [![Health](https://phpackages.com/badges/yongtiger-yii2-user/health.svg)](https://phpackages.com/packages/yongtiger-yii2-user) ``` ### Alternatives [nodge/yii2-eauth Yii2 EAuth Extension. EAuth allows to authenticate users with accounts on other websites (Google, Facebook, Twitter, etc). 19399.4k](/packages/nodge-yii2-eauth)[budyaga/yii2-users Module for manage users and their rights with the support of registration through social services and assigned to each user more than one social service. 409.1k](/packages/budyaga-yii2-users)[lowbase/yii2-user Yii2 user module 131.5k2](/packages/lowbase-yii2-user) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)