WP / MemberMouse / Discourse Integration Guide


(Leah Kramer) #1

I maintain Discourse and MemberMouse running on 2 sites. Hopefully this guide will be helpful to people. Your exact specifications may differ from what my desired results were. This guide assumes that you are familiar with MemberMouse hooks, filters and MemberMouse PHP interface. And also assumes you can comfortably add custom code to WordPress via functions.php or your own custom plugin.

This guide below is what we added in order to:

  • Activate/deactivate the user in Discourse depending on their membership status in MemberMouse
  • Set Discourse groups that represent MemberMouse membership levels
  • Sync up username/email changes instantaneously
  • And misc other helpful little tweaks

Step 1: Install Discourse and WordPress and wp-discourse WordPress plugin

Get the WordPress and Discourse and wp-discourse WordPress plugin up and running and configured properly with WordPress as the SSO provider. There are lots of threads about this here.

Step 2: Check the box to allow the wp-discourse plugin to create a new user in Discourse when user is created in WordPress

I found that in order for the wp-discourse to actually create a user in Discourse when a user is created in WordPress, I needed to make a code change in the plugin. This is because the plugin relies on the “wp_login” action but it behaves differently in MemberMouse than regular WordPress behavior. So you need add this line to the file /lib/discourse-sso.php in public function __construct( $wordpress_email_verifier ):

add_action( 'my_mm_account_added', array( $this, 'create_discourse_user' ), 10, 2 );

And in functions.php or your own plugin add:

function add_user_to_discourse($data) {
	do_action( 'my_mm_account_added', $data["username"], get_user_by('ID',$data["member_id"]) );	
}
add_action('mm_member_add', 'add_user_to_discourse');

Step 3: If you want, make it so new users don’t need to click a Discourse email activation link

By default Discourse will send an activation email to the new user but I chose to turn this off since the user has already jumped through a satisfactory number of hoops in WordPress to join. If your WordPress site has a low barrier to joining, you may not want to skip the activation email. In our case, you have to pay to join so. Add this to functions.php or to a special plugin you create.

add_filter( 'wpdc_auto_create_user_require_activation', 'my_wpdc_auto_create_user_require_activation' );
function my_wpdc_auto_create_user_require_activation( $require_activation ) {
    return false;
}

Step 4: Whenever an account change happens to a MemberMouse user:
Map MemberMouse membership levels to Discourse groups
Sync the email address/username
Activate/deactivate user in Discourse as appropriate

You can add this to functions.php or your own plugin.

add_action('mm_member_membership_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_status_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_account_update', 'run_discourse_sync_based_on_mm_acct_change');

In the function run_discourse_sync_based_on_mm_acct_change you want to:

(1) Use the Discourse API to get this user’s Discourse username (may be slightly different than their WordPress one due to Discourse’s own username rules) and Discourse ID number. (documentation)

(2) Map their MemberMouse membership level ID to the equivalent Discourse group ID and then set their group in Discourse. First you need to delete their old group ID. (documentation). Then you can set the new group. (documentation)

(3) Sync up their username and email if they have been changed in WordPress. We only allow these to be changed in WordPress. I got help with this part here.

(4) Activate/deactivate the user in Discourse depending on their status in MemberMouse. Activate (documentation). Deactivate seems to be missing from the API docs. $url = $url_base.‘admin/users/’.$discourse_userid.’/deactivate.json?’.$api_auth;

Step 5: Auto-redirect back to Discourse when appropriate

(I highly recommend holding off on this part of things until you get a really good feel for how WordPress and Discourse work together.)

If a user is NOT logged into Discourse and NOT logged into WordPress. And they come to a url in Discourse and click the blue Login button, they are taken to WordPress to login but then MemberMouse directs the user to whatever page you have it set to redirect to in MemberMouse’s settings. The user doesn’t get redirected back to Discourse unfortunately. So here is how I solved this. You can add this to functions.php or your own plugin. (Thread for more info.)

// If the person came from the discourse forum, push them to exactly where they were after logging in
function my_mm_login_redirect( $infoObj ) {
	if ( @$_COOKIE['detected_forum_referal'] != '' ) { // You need take care of setting this temporary cookie if the user just arrived via discourse
		$current_user       = $infoObj->user;
		$user_id            = $current_user->ID;
		// Payload and signature.
		$payload = @$_COOKIE['mm_cookie_sso'];
		$sig     = @$_COOKIE['mm_cookie_sig'];
		// Change %0B back to %0A.
		$payload = rawurldecode( str_replace( '%0B', '%0A', rawurlencode( $payload ) ) );
		// Validate signature.
		$sso_secret = 'YOUR-SSO-SECRET';
		$sso        = new \WPDiscourse\SSO\SSO( $sso_secret );
		if ( ! ( $sso->validate( $payload, $sig ) ) ) {
			return '';
		}
		$nonce  = $sso->get_nonce( $payload );
		$params = array(
			'nonce'               => $nonce,
			'username'            => $current_user->user_login,
			'email'               => $current_user->user_email,
			'external_id'         => $user_id,
		);
		$params = apply_filters( 'wpdc_sso_params', $params, $current_user );
		$q = $sso->build_login_string( $params );
		do_action( 'wpdc_sso_provider_before_sso_redirect', $user_id, $current_user );
		// Redirect back to Discourse.
		return('YOUR-FORUM-BASE-URL' . '/session/sso_login?' . $q);
	}
	return('');
}
add_filter( 'mm_login_redirect', 'my_mm_login_redirect', 10, 1 );

If someone changes their email in WordPress, change it in Discourse - sso_sync
(john hashim) #2

if i May ask do you need to install the Discourse on its own or … you just need the discourse plugin in your wordpress


(Leah Kramer) #3

You need to install Discourse on it’s own. The plugin just helps WordPress and Discourse talk to each other.


(john hashim) #4

thank you m new here and i like this community so im in a process on launching it on my Google cloude…


(André) #5

@lkramer - how does this workflow need to change to use MemberMouse Bundles instead of the MM membership status?

(For us MM memberships are too limited, as a customer can only be in one at a time (free or paid). We have many products, so we use Bundles which allows us infinite flexibility.)

Our use case is as follows:

We sell multiple courses. We control course access using Bundles. “Product 1 Bundle” and “Product 2 Bundle,” etc. Any one customer can have access to one or many (or all) of course courses.

Within Discourse we have a separate course forum (category/group) for each product…

We want customers of “Product 1 Bundle” to only be able to see the Discourse category/group for that course, and so on.

Any idea how your workflow would need to change to allow for our use case?

Thx a ton in advance, Leah!


(Leah Kramer) #6

In order to rely on bundles rather than membership levels – anywhere I mentioned membership status/level, you’d just check the person’s bundle status via a MemberMouse php function. So check whether they have bundle X and whether it’s currently ‘active’ and if so, put them in Discourse group X or else remove them from group X. I believe the MemberMouse php function you want is something like this:

if ( mm_member_decision(array("hasBundle"=>"1")) )

Now, regarding only making certain Discourse categories accessible to certain Discourse groups, I’ve never tried it but according to this thread here you can restrict categories to certain groups:

So as long as you can successfully set/unset a person’s Discourse group based on their bundle (which should be do-able), then you can achieve your goal of only having access to certain categories.


(Leah Kramer) #7

Another tidbit of potentially helpful info – To learn to use the Discourse API, write some small isolated scripts to get small pieces working as a proof of concept and to know exactly what code works. There are often several ways to interact with an API even within one language. So, e.g, write a little script that just tests the concept of setting and unsetting someone’s Discourse group. This is what I did and then I knew it was safe/reliable to add them into the MemberMouse eco-system where approprirate. :slight_smile:


(Kane York) #8

The best way to sync group membership is, of course, the sync_sso and during SSO login (which should go through the same function!! you don’t want to add someone from a group and take them back out when they log in) — because this is way more efficient, only 1 API call to change as many groups as you want.


(André) #9

Thx @lkramer! (and @riking)


(Leah Kramer) #10

Thx @riking. So are you saying you can set/unset multiple groups in sync_sso. That’s good to know.


(Jay Pfaffman) #11

This wasn’t working for me, and I just upgraded, and now there is no create_discourse_user, it seems.

@Simon_Cossar, have you got a suggestion here?

It seems that having to edit the plugin to make membermouse work is something of a bummer. I think that I can imagine code that would solve that if I first could get WordPress to trigger creating the account.


(Simon Cossar) #12

It’s still there: wp-discourse/utilities.php at master · discourse/wp-discourse · GitHub

You need to call it with the namespace WPDiscourse\Utilities\Utilities::create_discourse_user( $user )

There is also a sync_sso_record function that would be better to use if you are able to. It takes an array of sso parameters as an argument. You can get them from the get_sso_params function.

I’m in the process of cleaning up this file. I won’t remove any functions that I’ve posted about on meta. If I break anything, let me know.

Edit: I read the OP more closely. I hadn’t realized it was editing the plugin’s code. That part will be broken by the most recent update. It would be better to call either the create_discourse_user or the sync_sso_record function from WPDiscourse\Utilities, and add the my_mm_account_added hook to your functions.php file or a separate plugin.


(Jay Pfaffman) #13

Thanks, @Simon_Cossar!

Here’s what I’m doing now:

function add_user_to_discourse($data) {
	do_action( 'my_mm_account_added', $data["username"], get_user_by('ID',$data["member_id"]) );
    error_log ("Doing add_user");
}

add_action('mm_member_add', 'add_user_to_discourse');

Also, I have a handful of actions like


add_action('mm_member_membership_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_status_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_account_update', 'run_discourse_sync_based_on_mm_acct_change');

Should all of these call sync_sso_record? And what should go in $user when I call WPDiscourse\Utilities\Utilities::create_discourse_user( $user )? (I’m going to RTFC now, but perhaps your 2 minutes can save me an hour. :slight_smile:)

Edit: OK, should something like this work? I see that it’s getting called, but the user’s not getting created.

function add_user_to_discourse($data) {
    $user['name'] = $data['first_name'] . " " . $data['last_name'];
    $user['user_email'] = $data['email'];
    error_log ("Calling create_discourse_user");
    WPDiscourse\Utilities\Utilities::create_discourse_user( $user );
}

(Simon Cossar) #14

Assuming you are also adding the user to a group, I think you could just call WPDiscourse\Utilities\Utilities::add_user_to_discourse_group( $user_id, 'group,names' ). That gets the sso params for then calls sync_sso_record with the params. The remove_user_from_discourse_group function works in a similar way, except it removes users from a group or groups.

If you just want to create or update a user without dealing with groups, you can do something like this:

$user = get_user_by( 'id', 1 ); // Supply user_id here.
$sso_params = WPDiscourse\Utilities\Utilities::get_sso_params( $user );
WPDiscourse\Utilities\Utilities::sync_sso_record( $sso_params );

If SSO is enabled, I don’t think there would be a reason to prefer the create_discourse_user function over the sync_sso_record function. If you do need to use it, it takes a WordPress user object as the argument: $user = get_user_by( 'id', 1 );


(Jay Pfaffman) #15

Yeah. Sadly, I started with code that was written before add_user_to_discourse_group existed. I was just wondering whether I should change my working API calls to use that instead.

It’s not obvious to me that add_user_to_discourse_group will create the user. Is that happening somewhere that I don’t see?


(Simon Cossar) #16

Yes, it creates a user by sending the SSO parameters to the Discourse /admin/users/sync_sso route. It actually takes a comma separated list of group names as its argument (no spaces between names), so it should be renamed. You can also call it with an empty string as the group_names argument. You have to at least supply an empty string for the group names, or it will throw an error.


(Jay Pfaffman) #17

So, this is a zillion times easier than it used to be!

add_user_to_discourse_group( $user_id, $group_names ) wants the WP userid? and the Discourse group name (no fussing in the json to figure out the group_id?!?!)?

Now I just need to find the $user_id and I’ll be golden.

Edit: $user = get_user_by('ID',$data["member_id"])

Edit: I’m all set! The version of the MemberMouse bundle-to-group function that I was working on yesterday was over 200 lines. The working version today is about 40.

Thanks again, @Simon_Cossar!


(Simon Cossar) #18

Great! I’ll document the changes to the functions soon. They take the same arguments as before, but behave a little differently. One thing to note is that Discourse will still consider the add_user_to_discourse_group and remove_user_from_discourse_group functions to be API calls - they are just making fewer API calls than the previous version did.

The functions return the status code that is returned from the Discourse request. You want to be getting a 200 response. If you’re adding a lot of users at the same time, you need to look out for 429 status codes and find some way of dealing with them. (When adding one user at a time it shouldn’t be an issue.)


(Jay Pfaffman) #19

Well, I’m pretty sure that last summer when I did this before there was a lot more that I had to do with my own darn API calls. This is pretty great. Hooray that this is now your day job!


(Leah Kramer) #20

Maybe you can write a new and improved MemberMouse guide, Jay, when this is all said and done. :slight_smile: Come to think of it, just a general, “hook Discourse up to your membership plugin” guide would be great for ANY membership plugin. I’m guessing they all have similar “hooks” as MemberMouse.