bbp_get_topic( int|object $topic, string $output = OBJECT, string $filter = 'raw' )

Gets a topic

Description

Parameters

$topic

(Required) Topic id or topic object

$output

(Optional) OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT

Default value: OBJECT

$filter

(Optional) Sanitation filter. See sanitize_post()

Default value: 'raw'

Return

(mixed) Null if error or topic (in specified form) if success

Source

File: bp-forums/topics/template.php

function bbp_get_topic( $topic, $output = OBJECT, $filter = 'raw' ) {

	// Use topic ID
	if ( empty( $topic ) || is_numeric( $topic ) )
		$topic = bbp_get_topic_id( $topic );

	// Attempt to load the topic
	$topic = get_post( $topic, OBJECT, $filter );
	if ( empty( $topic ) )
		return $topic;

	// Bail if post_type is not a topic
	if ( $topic->post_type !== bbp_get_topic_post_type() )
		return null;

	// Tweak the data type to return
	if ( $output === OBJECT ) {
		return $topic;

	} elseif ( $output === ARRAY_A ) {
		$_topic = get_object_vars( $topic );
		return $_topic;

	} elseif ( $output === ARRAY_N ) {
		$_topic = array_values( get_object_vars( $topic ) );
		return $_topic;

	}

	return apply_filters( 'bbp_get_topic', $topic, $output, $filter );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2787)	Introduced.

Uses

Uses
Uses	Description
bp-forums/topics/template.php: bbp_get_topic_id()	Return the topic id
bp-forums/topics/template.php: bbp_get_topic_post_type()	Return the unique id of the custom post type for topics

Used By
Used By	Description
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::get_topic_current_user_permissions()	Topic permissions for the current user.
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::merge_item()	Merge Topic
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::split_item()	Split Topic
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::dropdown_items_permissions_check()	Check if a given request has access to view the siblings of the 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-reply-actions-endpoint.php: BP_REST_Reply_Actions_Endpoint::move_item()	Move a Reply.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::create_item()	Create a reply.
bp-forums/admin/topics.php: BBP_Topics_Admin::toggle_topic()	Toggle topic
bp-forums/admin/topics.php: BBP_Topics_Admin::toggle_topic_notice()	Toggle topic notices
bp-forums/templates/default/bbpress-functions.php: BBP_Default::ajax_favorite()	AJAX handler to add or remove a topic from a user’s favorites
bp-forums/templates/default/bbpress-functions.php: BBP_Default::ajax_subscription()	AJAX handler to Subscribe/Unsubscribe a user from a topic
bp-forums/topics/template.php: bbp_get_topic_reply_link()	Return the link to go directly to the reply form
bp-forums/topics/template.php: bbp_get_topic_trash_link()	Return the trash link of the topic
bp-forums/topics/template.php: bbp_get_topic_close_link()	Return the close link of the topic
bp-forums/topics/template.php: bbp_get_topic_stick_link()	Return the stick link of the topic
bp-forums/topics/template.php: bbp_get_topic_merge_link()	Return the merge link of the topic
bp-forums/topics/template.php: bbp_get_topic_spam_link()	Return the spam link of the topic
bp-forums/topics/template.php: bbp_get_topic_edit_link()	Return the edit link of the topic
bp-forums/topics/template.php: bbp_get_topic_edit_url()	Return URL to the topic edit page
bp-forums/topics/template.php: bbp_get_topic_replies_link()	Return the replies link of the topic
bp-forums/topics/functions.php: bbp_open_topic()	Opens a topic
bp-forums/topics/functions.php: bbp_spam_topic()	Marks a topic as spam
bp-forums/topics/functions.php: bbp_unspam_topic()	Unspams a topic
bp-forums/topics/functions.php: bbp_close_topic()	Closes a topic
bp-forums/topics/functions.php: bbp_toggle_topic_handler()	Handles the front end opening/closing, spamming/unspamming, sticking/unsticking and trashing/untrashing/deleting of topics
bp-forums/topics/functions.php: bbp_merge_topic_handler()	Merge topic handler
bp-forums/topics/functions.php: bbp_split_topic_handler()	Split topic handler
bp-forums/topics/functions.php: bbp_edit_topic_handler()	Handles the front end edit topic submission
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_add_user_topic_subscription()	Add a topic to user’s subscriptions
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_add_user_favorite()	Add a topic to user’s favorites
bp-forums/groups.php: BBP_Forums_Group_Extension::new_topic_redirect_to()	Redirect to the group forum screen
bp-forums/groups.php: BBP_Forums_Group_Extension::new_reply_redirect_to()	Redirect to the group forum screen
bp-forums/replies/functions.php: bbp_move_reply_handler()	Move reply handler
bp-forums/replies/functions.php: bbp_new_reply_handler()	Handles the front end reply submission

Show 31 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