WordPress filter hook

bbp_get_user_slug

Fired by 2 WordPress plugins, running on 101K+ sites between them.

How to use bbp_get_user_slug

It's a filter: your callback receives the value, and must return the (changed) value. Add this to your theme's functions.php or a small custom plugin:

functions.php
add_filter( 'bbp_get_user_slug', function( $maybe_get_root_slug ) {
	// Change $maybe_get_root_slug here.
	return $maybe_get_root_slug;
}, 10, 1 );

Argument names come from bbPress's source. Other plugins may pass different values: check the call in the plugin you're targeting below.

2 plugins that fire bbp_get_user_slug

Sorted by active installs. Each entry shows where the plugin calls the hook and what it passes.

  1. bbPress icon bbPress100,000+ installs apply_filters( 'bbp_get_user_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_user_slug', $default ) ) includes/core/options.php:1046
  2. Forumax icon Forumax500+ installs apply_filters( 'bbp_get_user_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_user_slug', $default ) ) lib/bbpress/includes/core/options.php:903

Need a customisation built on this hook?

Tell us what you want to change and which plugin it's for. We'll write it, test it and send it back as a small plugin.