Contents

Code Reference Functions bbp_get_displayed_user_field()

bbp_get_displayed_user_field( string $field = '', string $filter = 'display' )

Return a sanitized user field value

Description

This function relies on the $filter parameter to decide how to sanitize the field value that it finds. Since it uses the WP_User object’s magic __get() method, it can also be used to get user_meta values.

See also

Parameters

$field

(Optional) Field to get

Default value: ''

$filter

(Optional) How to filter the field value (null|raw|db|display|edit)

Default value: 'display'

Return

(string|bool) Value of the field if it exists, else false

Source

File: bp-forums/users/template.php 

	function bbp_get_displayed_user_field( $field = '', $filter = 'display' ) {

		// Get the displayed user
		$user         = bbpress()->displayed_user;

		// Juggle the user filter property because we don't want to muck up how
		// other code might interact with this object.
		$old_filter   = $user->filter;
		$user->filter = $filter;

		// Get the field value from the WP_User object. We don't need to perform
		// an isset() because the WP_User::__get() does it for us.
		$value        = $user->$field;

		// Put back the user filter property that was previously juggled above.
		$user->filter = $old_filter;

		// Return empty
		return apply_filters( 'bbp_get_displayed_user_field', $value, $field, $filter );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r2688) Introduced.

Uses

Uses
Uses Description
bp-forums/classes/class-bbpress.php: bbpress()

The main function responsible for returning the one true bbPress Instance to functions everywhere.
Used By
Used By Description
bp-forums/core/theme-compat.php: bbp_template_include_theme_compat()

Reset main query vars and filter ‘the_content’ to output a Forums template part as needed.
bp-forums/core/template-loader.php: bbp_get_single_user_template()

Get the user profile template
bp-forums/core/template-loader.php: bbp_get_single_user_edit_template()

Get the user profile edit template
bp-forums/core/template-loader.php: bbp_get_favorites_template()

Get the user favorites template
bp-forums/core/template-loader.php: bbp_get_subscriptions_template()

Get the user subscriptions template
bp-forums/users/template.php: bbp_displayed_user_field()

Output a sanitized user field value
Show 1 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.