Build on XFtoWP with hooks, templates and the XenForo API

XenForo API

Call the XenForo API

xf_request() makes GET, POST and DELETE requests to the XenForo API. XFtoWP holds the API key and connection, so there’s no client to write.

• Any endpoint your API user can access
• Route IDs and body parameters
• Returns the response as a PHP object

Making XenForo API requests →

$board_index = xf_request( 'GET', 'index' );
xf_request( 'POST', 'threads', array(
	'body' => array(
		'node_id' => 1234,
		'title'   => 'New thread title',
		'message' => 'My own thread content.'
	)
) );

Each call is a live request. Cache the result instead of calling it on every page load.

function my_xf_webhook( $request ) {
	error_log( print_r( $request, true ) );
}
add_action( 'xfwp_webhook_post_insert', 'my_xf_webhook' );
// Also: xfwp_webhook_user_update
//       xfwp_webhook_user_upgrade_purchase_complete

The action name changes with the content type and event.

Webhooks

Webhook actions for XenForo events

When XenForo sends a webhook, XFtoWP runs xfwp_webhook_{content_type}_{event}, so your code can react to new posts, user updates or upgrade purchases.

• One action per content type and event
• $request holds the webhook data
• Uses the events you pick in XenForo’s webhook settings

Custom webhook actions →

Custom user fields

Custom user fields from your own data

Two filters add your own field to the Custom user fields screen and set its value when a user syncs, with the WordPress user, their user meta and the post ID passed in.

• xfwp_custom_fields adds the field
• xfwp_custom_user_fields_data sets the value
• Runs on every user sync and user action

Custom data in user fields →

add_filter( 'xfwp_custom_fields', function( $fields ) {
	$fields['user']['random_number'] = array(
		'label' => 'Random number'
	);
	return $fields;
} );
add_filter( 'xfwp_custom_user_fields_data',
	function( $fields, $wp_user, $usermeta, $post_id ) {
		$fields['random_number'] = rand();
		return $fields;
	}, 10, 4 );

Use the Field ID of the custom user field in XenForo as the key.

class XFWP_My_Integration extends XFWP_Integration {
	public $name = 'my-plugin';
	public function init() {
		add_action( 'my_plugin_purchase',
			array( $this, 'complete' ) );
	}
	public function complete( $order ) {
		$this->users->update_user( $order->user_id, array(
			'action'  => 'product_purchase',
			'post_id' => $order->product_id
		) );
	}
}
add_action( 'plugins_loaded', function() {
	new XFWP_My_Integration;
} );

my_plugin_purchase stands in for your plugin’s own purchase hook.

Integrations API

Integrations API for other plugins

Extend XFWP_Integration in your own plugin, then call update_user() from that plugin’s hooks to run User actions such as promotions, registrations and messages.

• Built the same way as the MemberPress integration
• update_user() runs the actions set for a product
• Optional products(), strings() and settings methods

Plugin Integrations API →

Bulk Actions API

Add your own Bulk Actions

Extend XFWP_Bulk_Action and register it with the xfwp_bulk_actions filter. Your action gets the Bulk Actions screen, batches, safety checks and run results.

• Start from WordPress or XenForo users
• Limit it to connected users
• Return a result for each user

class My_Bulk_Badge extends XFWP_Bulk_Action {
	public $sources = array( 'wp' );
	public $connected_only = true;
	public function label() {
		return 'Award a badge';
	}
	public function verb() {
		return 'Award';
	}
	public function progress() {
		return 'Awarding badges…';
	}
	public function run( $bulk, $pair ) {
		update_user_meta( $pair['wp_user']->ID, 'my_badge', 1 );
		return array_replace( $pair['row'], array(
			'outcome' => 'success',
			'message' => 'Badge awarded.'
		) );
	}
}

Add about() and review() to describe the action on screen, then load the class on plugins_loaded if XFWP_Bulk_Action exists.