Hi!

We’re very excited to officially announce the launch of a new development resources site on the BuddyPress.org network.

Today we are inaugurating developer.buddypress.org with a complete handbook documenting the BP REST API. This API will be introduced into our next major version which is scheduled on September 30, 2019. We thought you’d be interested to have a tool to help you discover the BuddyPress REST endpoints and their parameters to start playing with them (You’ll need BuddyPress 5.0.0-RC1 to have even more fun with it!).

Using the BP REST API Handbook

The main part of the handbook is the « Developer Endpoint Reference ». We grouped these endpoints according to the component they belongs to.

View the full screenshot in a new tab.

Each page of the reference is firstly introducing the component and describing the data schema of items contained into the REST responses. Then for each verb (or method), you’ll find the available arguments, their definition and an example of use with the bp.apiRequest() JavaScript function. Below is a screenshot of the method to get a specific Activity.

The future of this development resources hub

You can have a good idea of what’s coming next into this developer oriented site looking at its current landing page. We will first work on building the full PHP Code Reference for BuddyPress: functions, classes and hooks.

Then, we haven’t planned anything yet ☺ and we’re very opened to ideas and of course contributions about the « how » step and the « do » one.

About the editing workflow

Unlike the BuddyPress Codex, it’s not possible for everyone to directly edit the content of the BP REST API Handbook or the future PHP Code Reference.

But you can always report issues or suggest improvements using our Bug Tracker making sure to select the « BuddyPress.org sites » option of the components dropdown of your ticket.

Props

The first version of the development resources hub was built thanks to the involvement of these contributors:

Boone B Gorges (boonebgorges), John James Jacoby (johnjamesjacoby), Mathieu Viet (imath), Michael Beckwith (tw2113), Renato Alves (espellcaste), Stephen Edgar (netweb).

Many thanks to them 😉