WordPress provider for OAuth 2.0 Client
, (*1)
This package provides WordPress OAuth 2.0 support for the PHP League's OAuth 2.0 Client., (*2)
Installation
To install, use composer:, (*3)
composer require krombox/oauth2-wordpress
Prerequirements
1) WP OAuth Server plugin installed and configured, (*4)
Usage
Usage is the same as The League's OAuth client, using \Krombox\OAuth2\Client\Provider\WordPress
as the provider., (*5)
Authorization Code Flow
$provider = new Krombox\OAuth2\Client\Provider\WordPress([
'clientId' => '{wordpress-client-id}',
'clientSecret' => '{wordpress-client-secret}',
'redirectUri' => 'https://example.com/callback-url',
'domain' => 'https://example.com',
]);
if (!isset($_GET['code'])) {
// If we don't have an authorization code then get one
$authUrl = $provider->getAuthorizationUrl();
$_SESSION['oauth2state'] = $provider->getState();
header('Location: '.$authUrl);
exit;
// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
unset($_SESSION['oauth2state']);
exit('Invalid state');
} else {
// Try to get an access token (using the authorization code grant)
$token = $provider->getAccessToken('authorization_code', [
'code' => $_GET['code']
]);
// Optional: Now you have a token you can look up a users profile data
try {
// We got an access token, let's now get the user's details
$user = $provider->getResourceOwner($token);
// Use these details to create a new profile
printf('Hello %s!', $user->getId());
} catch (Exception $e) {
// Failed to get user details
exit('Oh dear...');
}
// Use this to interact with an API on the users behalf
echo $token->getToken();
}
Testing
bash
$ ./vendor/bin/phpunit
, (*6)
Credits
License
The MIT License (MIT). Please see License File for more information., (*7)