OAuth::getRequestToken

(PECL OAuth >= 0.99.1)

OAuth::getRequestToken — Fetch a request token

Description

public OAuth::getRequestToken(string $request_token_url, string $callback_url = ?, string $http_method = ?): array

Fetch a request token, secret and any additional response parameters from the service provider.

Parameters

request_token_url: URL to the request token API.
callback_url: OAuth callback URL. If callback_url is passed and is an empty value, it is set to "oob" to address the OAuth 2009.1 advisory.
http_method: HTTP method to use, e.g. GET or POST.

Return Values

Returns an array containing the parsed OAuth response on success or false on failure.

Changelog

Version	Description
PECL oauth 1.0.0	Previously returned `null` on failure, instead of `false`.
PECL oauth 0.99.9	The `callback_url` parameter was added

Examples

Example #1 OAuth::getRequestToken() example

<?php
try {
    $oauth = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET);
    $request_token_info = $oauth->getRequestToken("https://example.com/oauth/request_token");
    if(!empty($request_token_info)) {
        print_r($request_token_info);
    } else {
        print "Failed fetching request token, response was: " . $oauth->getLastResponse();
    }
} catch(OAuthException $E) {
    echo "Response: ". $E->lastResponse . "\n";
}
?>

The above example will output something similar to:

Array
(
    [oauth_token] => some_token
    [oauth_token_secret] => some_token_secret
)

User Contributed Notes 1 note

down

bohwaz ¶

14 years ago


Please note that if you don't supply callback_url, the oauth parameter oauth_callback will not be sent to the server and will result in an error from the server, as this parameter is REQUIRED in the OAuth spec.

add a note