bbPress.org

I’m also looking for the REST API for bbPress but unable to find info on it either.

bit more digging

it would appear that wordpress 4.7 takes out the filter capability

https://github.com/WP-API/WP-API/issues/2964

there is plugin that puts it back

https://github.com/WP-API/rest-filter

Otherwise I think they now want you to filter at the client end.

so http://MY_SITE.COM/wp-json/wp/v2/posts gives you all the posts, and then you pick those that are the right post type.

If you try the plugin above, then I think

http://MY_SITE.COM/wp-json/wp/v2/posts?filter[type]=topic

does it

Please do report progress back !!

ok, I’ve found a link to some code that doesn’t entirely make sense yet, but gives me some clues, but I’ll do some more digging over the next few days.

To enable default REST API support for topics you could use a snippet like this one:

add_action( 'bbp_register_post_types', function() {
	register_post_type( bbp_get_topic_post_type(), [ 'show_in_rest' => true ] );
}, 11 );

This waits until bbPress has registered its post types, then modifies the properties of the topic post type so that it is exposed via the REST API. You could of course extend it to cover forum and reply posts, too. With that in place, you should find URLs like the following work as expected:

http://bbpress.site/wp-json/wp/v2/topic

@barryhughes-1 – huge thanks – the answer is always simple once you know !

I’ve just tried

http://mysite.com/wp-json/wp/v2/topic

lists all topics

http://mysite.com/wp-json/wp/v2/forum/16316

lists forum 16316

http://mysite.com/wp-json/wp/v2/topic/?sortBy=date

lists all topics newest first

I found that the above code took away the Forums, Topics and Replies from the dashboard in bbpress.

I found some other code and modified it as follows

/**
  * Add REST API support to an already registered post type.
  */
  add_action( 'init', 'rew_custom_post_type_rest_support', 25 );
  
  function rew_custom_post_type_rest_support() {
  	global $wp_post_types;
  
  	$post_type_name =  bbp_get_reply_post_type();
  	if( isset( $wp_post_types[ $post_type_name ] ) ) {
  		$wp_post_types[$post_type_name]->show_in_rest = true;
  		$wp_post_types[$post_type_name]->rest_base = $post_type_name;
  		$wp_post_types[$post_type_name]->rest_controller_class = 'WP_REST_Posts_Controller';
  	}
	$post_type_name =  bbp_get_topic_post_type();
  	if( isset( $wp_post_types[ $post_type_name ] ) ) {
  		$wp_post_types[$post_type_name]->show_in_rest = true;
  		$wp_post_types[$post_type_name]->rest_base = $post_type_name;
  		$wp_post_types[$post_type_name]->rest_controller_class = 'WP_REST_Posts_Controller';
  	}
	$post_type_name =  bbp_get_forum_post_type();
  	if( isset( $wp_post_types[ $post_type_name ] ) ) {
  		$wp_post_types[$post_type_name]->show_in_rest = true;
  		$wp_post_types[$post_type_name]->rest_base = $post_type_name;
  		$wp_post_types[$post_type_name]->rest_controller_class = 'WP_REST_Posts_Controller';
  	}
	  
  }

@barryhughes-1 – thoughts – can this be done better?

As far as I can see that is down to the rest api, not bbpress – it does the same with posts ie not show author.

I suspect barry is way ahead of me in knowledge but these two links seem to show that you write api callbacks into your website and then add them to the api

http://wordpress.stackexchange.com/questions/224332/how-to-get-author-meta-into-post-endpoint-in-api-v2

http://v2.wp-api.org/extending/adding/

My replies seem to keep disappearing into the bbPress void … trying again just to see if this one will show up.

Additionally, as an example of how you can add pretty much anything you want to the JSON responses returned by the REST API:

function bbpress_rest_api_replies_extra_data( WP_REST_Response $response ) {
	if ( ! is_array( $response->data ) ) {
		return $response;
	}

	foreach ( $response->data as $key => $single_item ) {
		// Only modify replies
		if ( bbp_get_reply_post_type() !== $single_item['type'] ) {
			continue;
		}

		// Add the author's details using a custom format
		$author_id = get_post( $single_item['id'] )->post_author;
		$author = get_user_by( 'ID', $author_id );
		$response->data[ $key ]['author'] = "{$author->display_name} <{$author->user_email}>";
	}

	return $response;
}

add_filter( 'rest_request_after_callbacks', 'bbpress_rest_api_replies_extra_data' );

You could say this is a bit of a brute force hack and although when combined with my last snippet it successfully adds the author’s display name and email address to replies (not topics), it shouldn’t really be used for that purpose “as is”: it doesn’t escape the author details, you probably don’t want to expose their email addresses, plus it’s out of alignment with how author meta is returned for other post types … However, I felt it was worth sharing an example of how you can quite quickly add arbitrary fields to REST API output.

Absolutely – I’m also still exploring this new territory, nice to have an ‘excuse’ to do so 😉

No worries!