PHPackages                             benjaminmedia/wp-wa-oauth - 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. benjaminmedia/wp-wa-oauth

ActiveWordpress-plugin[Authentication & Authorization](/categories/authentication)

benjaminmedia/wp-wa-oauth
=========================

Log in users from the WA platform

1.5.0(6y ago)12041PHPPHP >=5.6

Since May 17Pushed 6y ago13 watchersCompare

[ Source](https://github.com/BenjaminMedia/wp-wa-oauth)[ Packagist](https://packagist.org/packages/benjaminmedia/wp-wa-oauth)[ Docs](https://github.com/BenjaminMedia/wp-wa-oauth)[ RSS](/packages/benjaminmedia-wp-wa-oauth/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (33)Used By (0)

Bonnier Publications - WordPress WhiteAlbum OAuth plugin
========================================================

[](#bonnier-publications---wordpress-whitealbum-oauth-plugin)

This plugin enables your WordPress site to integrate with the WA user base. It does it by integrating with the WA OAuth API, and giving you a set of api functions that you may call in your theme to conditionally lock content from unauthorized users.

### Requirements

[](#requirements)

- WordPress 4.4 or higher
- WP REST API must be installed and activated version 2.0 or higher
- Language support (Optional) Polylang plugin must installed and activated version 1.8.4 or higher
- PHP 5.6 or higher

### Installation/Configuration

[](#installationconfiguration)

Install through composer:

```
composer require benjaminmedia/wp-wa-oauth
```

Download lastest release from: And unzip and place in your /wp-content/plugins directory.

#### Getting credentials and Configuration

[](#getting-credentials-and-configuration)

Once you have installed and activated the plugin then make sure that you have a set of api credentials. If you do not have a set of credentials then you should contact Bonnier to get them. You need to have a set of credentials for each domain on your site. Before credentials can be generated you must inform Bonnier of the redirect URI that should work with the credentials. This must be in the following format http://|https://\[your-domain\].\[your-country\]/wp-json/bp-wa-oauth/v1/oauth/login

Example:

Other than the redirect URI you should also tell them which WA userbase you want to authenticate against ie:  or another WA site.

Once you have your credentials log in to your WP admin panel and go to the menu settings->Wp Wa Oauth: here you must enter each set of credentials you recieved.

Here you also have the option to Globally enable or disable the login for each domain. Furthermore you may also select a Globally required user role level.

If you have multiple languages versions of the site, make sure that you use the Polylang plugin.

If you wish specific pages to be unlocked or require another user role than the Globally set. Then you may visit the the edit page for each page/post and here you will find a meta box called: 'WA OAuth locked content'. Any setting you make here will override the Global settings you have set.

#### Creating local users

[](#creating-local-users)

As of version 1.1.0 and up the plugin now supports creating local users. This means that you from the plugin settings page can toggle wether you want the plugin to create WordPress users after they have logged in.

If you enable this feature you may also choose an option whether the WordPress user should be automatically logged in to WordPress upon authenticating with WA.

Users will be given custom roles created from the roles that WA delivers: currently this amounts to two roles `users` and `subscribers`. To avoid conflicts with existing WordPress roles the role names will be prefixed with `bp_wa_`meaning the final role names will be `bp_wa_users` and `bp_wa_subscribers`.

Both roles will be given only the read access this, will allow users to edit/view their profile and nothing in WordPress and nothing else.

As of version 1.2.2 the plugin now hijacks already existing users that have the same email address as the logged in user from WA. The plugin will update the local user fields with the fields from the WA user.

###### Customizing role capabilities:

[](#customizing-role-capabilities)

You may override the default capabilities of the roles created you should add the following filters to a plugin or your functions.php file.

```
// To override the default capabilities you should implement a filter like so

add_filter('bp_wa_users_capabilities', function($default) {
	return array_merge($default, ['edit_posts' => false]);
});

// you can either extend the default capabilities by doing an array merge or,
// you can override the capabilities completely by returning a new array like so

add_filter('bp_wa_subscribers_capabilities', function($default) {
	return ['edit_posts' => true];
});

// note the filter follows a [role_name].[_capabilities] format
```

###### Hooking into the update of local user

[](#hooking-into-the-update-of-local-user)

As of version 1.2.0 and up of the plugin you may now hook into the update call of the local user. This is done by adding a WordPress filter using the add\_filter method, an example of this can be seen below:

```
add_filter('bp_wa_oauth_on_user_update', function($users){

	$localUser = $users['wp']; // Local user object and Instance of the WP_User class
	$waUser = $users['wa']; // WhiteAlbum user object an instance of stdClass

	// Set the user_url property to the profile_image url
	$localUser->user_url = $waUser->profile_image->url;

	// You can also save custom_user meta
	update_user_meta($localUser->ID, 'user_birth_date', $waUser->birthdate);

	// it is important to remember to return the $localUser variable otherwise the changes made will not be saved.
	return $localUser;

});
```

Here is an example of the data that is returned by the Wa login service:

```
{
	id: 621905,
	url: "http://woman.dk/users/test-account",
	path: "/users/test-account",
	username: "test-account",
	first_name: "Test",
	last_name: "Account",
	gender: "male",
	birthdate: "1925-06-12",
	address: "",
	zip: "",
	city: "",
	email: "aa@attmatr.com",
	roles: [
		"users"
	],
	banned: false,
	unread_message_count: 0,
	profile_image: {
		id: 1291263,
		url: "http://bonnier.imgix.net/ladygaga-z6VF3a4XTgSQEraVN-qmRQ.jpg",
		copyright: null,
		title: null,
		description: null,
		uuid: "ladygaga-z6VF3a4XTgSQEraVN-qmRQ.jpg",
		crops: [ ],
		alt_text: null,
		width: 400,
		height: 300
	},
	cover_image: null
}
```

#### User update callbacks

[](#user-update-callbacks)

If you have the create local users option enabled, then what might happen is that the user will update their profile on the Main WhiteAlbum site. This, could potentially mean that the local user info that your have in your application can come out of sync. In order to counter this, WhiteAlbum has a callback feature, which means they can call your application each time there is a change to a user that has been logged in to your application.

The Plugin automatically setups the callback route and will also handle the update of the user information itself, but before WhiteAlbum can call your app. They need to be informed of your callback url. The callback uri is generated from the following format: http://|https://\[your-domain\].\[your-country\]/wp-json/bp-wa-oauth/v1/oauth/callback

Example url:

Your should give this url to Bonnier when requesting the credentials, then we will setup the callbacks.

Note: the callback can only work so long as your user has been logged into the application for the last 24 hours. Otherwise the local user information, will not get updated, until the next time they login to your application.

### Usage Example:

[](#usage-example)

The following code snippet shows an Example in php that may be used in your theme template files.

```

		login and return here
		login and redirect to specific url

		login current page

		login and redirect to specific url

```

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 63.6% of commits — single point of failure

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 ~46 days

Recently: every ~209 days

Total

31

Last Release

2314d ago

PHP version history (2 changes)v1.0.0PHP >=5.4

v1.0.1PHP >=5.6

### Community

Maintainers

![](https://www.gravatar.com/avatar/737efb54dd51c1c52e71bb30c0292f48675e60282aa0f73272697113542cdbe6?d=identicon)[alfhen](/maintainers/alfhen)

---

Top Contributors

[![alfhen](https://avatars.githubusercontent.com/u/5700924?v=4)](https://github.com/alfhen "alfhen (42 commits)")[![Xayer](https://avatars.githubusercontent.com/u/1837767?v=4)](https://github.com/Xayer "Xayer (13 commits)")[![Frozire](https://avatars.githubusercontent.com/u/6813614?v=4)](https://github.com/Frozire "Frozire (4 commits)")[![jonastanz](https://avatars.githubusercontent.com/u/12626047?v=4)](https://github.com/jonastanz "jonastanz (4 commits)")[![SorenThorup](https://avatars.githubusercontent.com/u/5878056?v=4)](https://github.com/SorenThorup "SorenThorup (2 commits)")[![sulfo](https://avatars.githubusercontent.com/u/830016?v=4)](https://github.com/sulfo "sulfo (1 commits)")

---

Tags

wordpress-pluginpluginwordpress

### Embed Badge

![Health badge](/badges/benjaminmedia-wp-wa-oauth/health.svg)

```
[![Health](https://phpackages.com/badges/benjaminmedia-wp-wa-oauth/health.svg)](https://phpackages.com/packages/benjaminmedia-wp-wa-oauth)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)