bbp_get_user_id( int $user_id, bool $displayed_user_fallback = true, bool $current_user_fallback = false )

Return a validated user id

Description

Parameters

$user_id

(Optional) User id

$displayed_user_fallback

(Optional) Fallback on displayed user?

Default value: true

$current_user_fallback

(Optional) Fallback on current user?

Default value: false

Return

(int) Validated user id

Source

File: bp-forums/users/template.php

	function bbp_get_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
		$bbp = bbpress();

		// Easy empty checking
		if ( !empty( $user_id ) && is_numeric( $user_id ) ) {
			$bbp_user_id = $user_id;

		// Currently viewing or editing a user
		} elseif ( ( true === $displayed_user_fallback ) && !empty( $bbp->displayed_user->ID ) ) {
			$bbp_user_id = $bbp->displayed_user->ID;

		// Maybe fallback on the current_user ID
		} elseif ( ( true === $current_user_fallback ) && !empty( $bbp->current_user->ID ) ) {
			$bbp_user_id = $bbp->current_user->ID;

		// Failsafe
		} else {
			$bbp_user_id = 0;
		}

		return (int) apply_filters( 'bbp_get_user_id', (int) $bbp_user_id, $displayed_user_fallback, $current_user_fallback );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2729)	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/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::update_item_permissions_check()	Check if a given request has access to update a topic.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::get_topic_action_states()	Get topic actions state based on current user.
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::action_items()	Actions on Topic
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::create_item()	Create a topic.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::update_item()	Update/Edit a topic.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::get_forum_action_states()	Get forum action states based on current user.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::update_item_permissions_check()	Check if a given request has access to update a reply.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::update_item()	Subscribe/Unsubscribe users for the forum.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::update_item_permissions_check()	Check if a given request has access to update a forum.
bp-forums/admin/admin.php: BBP_Admin::suggest_user()	Ajax action for facilitating the topic and reply author auto-suggest
bp-forums/topics/functions.php: bbp_update_topic_revision_log()	Update the revision log of the topic
bp-forums/users/capabilities.php: bbp_user_has_profile()	Does a user have a profile for the current site
bp-forums/users/capabilities.php: bbp_set_user_role()	Return a user’s main role
bp-forums/users/capabilities.php: bbp_get_user_role()	Return a user’s forums role
bp-forums/users/capabilities.php: bbp_get_user_blog_role()	Return a user’s blog role
bp-forums/users/template.php: bbp_user_can_view_forum()	Check if the user can access a specific forum
bp-forums/users/template.php: bbp_get_user_replies_created_url()	Return the link to the user’s replies
bp-forums/users/template.php: bbp_get_user_subscribe_link()	Return the link to subscribe/unsubscribe from a forum or topic
bp-forums/users/template.php: bbp_get_user_topics_created_url()	Return the link to the user’s topics
bp-forums/users/template.php: bbp_get_subscriptions_permalink()	Return the link to the user’s subscriptions page (profile page)
bp-forums/users/template.php: bbp_get_favorites_permalink()	Return the link to the user’s favorites page (profile page)
bp-forums/users/template.php: bbp_get_user_favorites_link()	User favorites link
bp-forums/users/template.php: bbp_get_user_display_role()	Return a user’s main role for display
bp-forums/users/template.php: bbp_get_user_profile_edit_url()	Return URL to the profile edit page of a user
bp-forums/users/template.php: bbp_get_user_nicename()	Return a users nicename to the screen
bp-forums/users/template.php: bbp_get_user_profile_url()	Return URL to the profile page of a user
bp-forums/users/template.php: bbp_get_user_profile_edit_link()	Return link to the profile edit page of a user
bp-forums/users/template.php: bbp_get_displayed_user_id()	Return ID of displayed user
bp-forums/users/functions.php: bbp_forum_subscriptions_handler()	Handles the front end subscribing and unsubscribing forums
bp-forums/users/functions.php: bbp_subscriptions_handler()	Handles the front end subscribing and unsubscribing topics
bp-forums/users/functions.php: bbp_get_user_topics_started()	Get the topics that a user created
bp-forums/users/functions.php: bbp_get_user_replies_created()	Get the replies that a user created
bp-forums/users/template.php: bbp_user_id()	Output a validated user id
bp-forums/users/template.php: bbp_get_current_user_id()	Return ID of current user
bp-forums/users/functions.php: bbp_get_user_subscribed_forum_ids()	Get a user’s subscribed forum ids
bp-forums/users/functions.php: bbp_get_user_subscribed_topic_ids()	Get a user’s subscribed topics’ ids
bp-forums/users/functions.php: bbp_is_user_subscribed_to_forum()	Check if a forum is in user’s subscription list or not
bp-forums/users/functions.php: bbp_is_user_subscribed_to_topic()	Check if a topic is in user’s subscription list or not
bp-forums/users/functions.php: bbp_get_user_topic_subscriptions()	Get a user’s subscribed topics
bp-forums/users/functions.php: bbp_get_user_forum_subscriptions()	Get a user’s subscribed forums
bp-forums/users/functions.php: bbp_get_user_favorites_topic_ids()	Get a user’s favorite topics’ ids
bp-forums/users/functions.php: bbp_is_user_favorite()	Check if a topic is in user’s favorites or not
bp-forums/users/functions.php: bbp_favorites_handler()	Handles the front end adding and removing of favorite topics
bp-forums/users/functions.php: bbp_get_user_topic_count_raw()	Return the raw database count of topics by a user
bp-forums/users/functions.php: bbp_get_user_reply_count_raw()	Return the raw database count of replies by a user
bp-forums/users/functions.php: bbp_get_user_favorites()	Get a user’s favorite topics
bp-forums/users/options.php: bbp_get_user_post_count()	Return a users total post count
bp-forums/users/options.php: bbp_update_user_last_posted()	Update a users last posted time, for use with post throttling
bp-forums/users/options.php: bbp_get_user_last_posted()	Return the raw value of teh last posted time.
bp-forums/users/options.php: bbp_add_user_options()	Add default user options
bp-forums/users/options.php: bbp_delete_user_options()	Delete default user options
bp-forums/users/options.php: bbp_get_user_topic_count()	Return a users reply count
bp-forums/users/options.php: bbp_get_user_reply_count()	Return a users reply count
bp-forums/common/template.php: bbp_title()	Custom page title for Forums pages
bp-forums/replies/functions.php: bbp_update_reply_revision_log()	Update the revision log of the reply
bp-members/classes/class-bp-core-members-switching.php: BP_Core_Members_Switching::action_bbpress_button()	Adds a ‘View As’ link to each member’s profile page in bbPress.

Show 51 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.

Contents