Helper to get a REST API object URL from a component.

[espellcaste]

This is a little helper to grab a REST API url from a specific object. Currently we have bp_rest_get_user_url but for other components, we need to build the url every single time.

We are doing lots of code duplication in the REST API plugin that could be improved using a more improved helper function.

[imath]

Thanks @espellcaste

Could you improve the patch a bit to "fully" deprecate bp_rest_get_user_url() and make it use bp_rest_get_object_url(). See /src/deprecated/8.0.php` for examples.

eg:

function bp_rest_get_user_url( $user_id ) {
	_deprecated_function( __FUNCTION__, '9.0.0', 'bp_rest_get_object_url( $user_id, \'members\' )' );
	return bp_rest_get_object_url( $user_id, 'members' );
}

[espellcaste]

@imath Do I create a new file for the 9.0 version?

require( $this->plugin_dir . 'bp-core/deprecated/9.0.php' );

I don't the see the 8.0 version being loaded anywhere so I'm confused if this was added in the previous version.

[imath]

@espellcaste Good catch! You're absolutely right. I've just committed the fix r12975

[imath]

Looks good!

[espellcaste]

In 12985:

Introducing a new helper function bp_rest_get_object_url, used to grab a REST API endpoint url from a specific component.

We are also deprecating the legacy version bp_rest_get_user_url

Props imath

Fixes #8490

[imath]

The $this->plugin_dir . 'bp-core/deprecated/9.0.php' file is missing in r12985. I'm reopening the ticket just to be sure we don't forget to add it 😉

[espellcaste]

In 12986:

Introducing a file with deprecated functions for the 9.0 version of BuddyPress.

see #8490