Class yii\authclient\clients\Twitter

Twitter allows authentication via Twitter OAuth.

In order to use Twitter OAuth you must register your application at https://dev.twitter.com/apps/new.

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'twitter' => [
                'class' => 'yii\authclient\clients\Twitter',
                'attributeParams' => [
                    'include_email' => 'true'
                ],
                'consumerKey' => 'twitter_consumer_key',
                'consumerSecret' => 'twitter_consumer_secret',
            ],
        ],
    ]
    ...
]

See also https://apps.twitter.com/.

Public Properties

Public Methods

Protected Methods

Property Details

$accessTokenMethod public property

Access token HTTP method.

public string $accessTokenMethod = 'POST'

$accessTokenUrl public property

OAuth access token URL.

public string $accessTokenUrl = 'https://api.twitter.com/oauth/access_token'

$apiBaseUrl public property

API base URL. This field will be used as yii\httpclient\Client::$baseUrl value of $httpClient. Note: changing this property will take no effect after $httpClient is instantiated.

public string $apiBaseUrl = 'https://api.twitter.com/1.1'

$attributeParams public property (available since version 2.0.6)

List of extra parameters, which should be used, while requesting user attributes from Twitter API. For example:

[
    'include_email' => 'true'
]

See also https://dev.twitter.com/rest/reference/get/account/verify_credentials.

public array $attributeParams = []

$authUrl public property

Authorize URL.

public string $authUrl = 'https://api.twitter.com/oauth/authenticate'

$requestTokenMethod public property

Request token HTTP method.

public string $requestTokenMethod = 'POST'

$requestTokenUrl public property

OAuth request token URL.

public string $requestTokenUrl = 'https://api.twitter.com/oauth/request_token'

Method Details