File: //home/dfwparty/dfwchat.net/wp-content/plugins/buddyboss-platform/bp-forums/common/shortcodes.php
<?php
/**
* Forums Shortcodes
*
* @package BuddyBoss\Shortcodes
*/
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
if ( ! class_exists( 'BBP_Shortcodes' ) ) :
/**
* Forums Shortcode Class
*
* @since bbPress (r3031)
*/
class BBP_Shortcodes {
/** Vars ******************************************************************/
/**
* @var array Shortcode => function
*/
public $codes = array();
/** Functions *************************************************************/
/**
* Add the register_shortcodes action to bbp_init
*
* @since bbPress (r3031)
*
* @uses setup_globals()
* @uses add_shortcodes()
*/
public function __construct() {
$this->setup_globals();
$this->add_shortcodes();
}
/**
* Shortcode globals
*
* @since bbPress (r3143)
* @access private
*
* @uses apply_filters()
*/
private function setup_globals() {
// Setup the shortcodes.
$this->codes = apply_filters(
'bbp_shortcodes',
array(
/** Forums */
'bbp-forum-index' => array( $this, 'display_forum_index' ), // Forum Index.
'bbp-forum-form' => array( $this, 'display_forum_form' ), // Topic form.
'bbp-single-forum' => array( $this, 'display_forum' ), // Specific forum - pass an 'id' attribute.
/** Topics */
'bbp-topic-index' => array( $this, 'display_topic_index' ), // Topic index.
'bbp-topic-form' => array( $this, 'display_topic_form' ), // Topic form.
'bbp-single-topic' => array( $this, 'display_topic' ), // Specific topic - pass an 'id' attribute.
/** Topic Tags */
'bbp-topic-tags' => array( $this, 'display_topic_tags' ), // All topic tags in a cloud.
'bbp-single-tag' => array( $this, 'display_topics_of_tag' ), // Topics of Tag.
/** Replies */
'bbp-reply-form' => array( $this, 'display_reply_form' ), // Specific reply form - pass an 'id' attribute.
'bbp-single-reply' => array( $this, 'display_reply' ), // Specific reply - pass an 'id' attribute.
/** Views */
'bbp-single-view' => array( $this, 'display_view' ), // Single view.
/** Search */
'bbp-search-form' => array( $this, 'display_search_form' ), // Search form.
'bbp-search' => array( $this, 'display_search' ), // Search.
/** Others */
'bbp-stats' => array( $this, 'display_stats' ), // Stats.
)
);
}
/**
* Register the Forums shortcodes
*
* @since bbPress (r3031)
*
* @uses add_shortcode()
* @uses do_action()
*/
private function add_shortcodes() {
foreach ( (array) $this->codes as $code => $function ) {
add_shortcode( $code, $function );
}
}
/**
* Unset some globals in the $bbp object that hold query related info
*
* @since bbPress (r3034)
*/
private function unset_globals() {
$bbp = bbpress();
// Unset global queries.
$bbp->forum_query = new WP_Query();
$bbp->topic_query = new WP_Query();
$bbp->reply_query = new WP_Query();
$bbp->search_query = new WP_Query();
// Unset global ID's.
$bbp->current_view_id = 0;
$bbp->current_forum_id = 0;
$bbp->current_topic_id = 0;
$bbp->current_reply_id = 0;
$bbp->current_topic_tag_id = 0;
// Reset the post data.
wp_reset_postdata();
}
/** Output Buffers ********************************************************/
/**
* Start an output buffer.
*
* This is used to put the contents of the shortcode into a variable rather
* than outputting the HTML at run-time. This allows shortcodes to appear
* in the correct location in the_content() instead of when it's created.
*
* @since bbPress (r3079)
*
* @param string $query_name
*
* @uses bbp_set_query_name()
* @uses ob_start()
*/
private function start( $query_name = '' ) {
// Set query name.
bbp_set_query_name( $query_name );
// Set shortcode query name.
set_query_var( '_bbp_shortcode_query', 'bbp_shortcodes' );
// call the enqueue script for shortcodes.
do_action( 'bbp_enqueue_scripts' );
// Start output buffer.
ob_start();
}
/**
* Return the contents of the output buffer and flush its contents.
*
* @since bbPress( r3079)
*
* @uses BBP_Shortcodes::unset_globals() Cleans up global values
* @return string Contents of output buffer.
*/
private function end() {
// Unset globals.
$this->unset_globals();
// Get the query name, for filter.
$query_name = bbp_get_query_name();
// Reset the query name.
bbp_reset_query_name();
// Return and flush the output buffer.
$output = ob_get_clean();
// Filter & return.
return apply_filters( 'bbp_display_shortcode', $output, $query_name );
}
/** Forum shortcodes ******************************************************/
/**
* Display an index of all visible root level forums in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses bbp_has_forums()
* @uses get_template_part()
* @return string
*/
public function display_forum_index() {
// Unset globals.
$this->unset_globals();
// Start output buffer.
$this->start( 'bbp_forum_archive' );
bbp_get_template_part( 'content', 'archive-forum' );
// Return contents of output buffer.
return $this->end();
}
/**
* Display the contents of a specific forum ID in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @uses bbp_single_forum_description()
* @return string
*/
public function display_forum( $attr, $content = '' ) {
// Sanity check required info.
if ( ! empty( $content ) || ( empty( $attr['id'] ) || ! is_numeric( $attr['id'] ) ) ) {
return $content;
}
// Set passed attribute to $forum_id for clarity.
$forum_id = bbpress()->current_forum_id = $attr['id'];
// Bail if ID passed is not a forum.
if ( ! bbp_is_forum( $forum_id ) ) {
return $content;
}
// Start output buffer.
$this->start( 'bbp_single_forum' );
// Check forum caps.
if ( bbp_user_can_view_forum( array( 'forum_id' => $forum_id ) ) ) {
bbp_get_template_part( 'content', 'single-forum' );
// Forum is private/hidden and user does not have caps.
} elseif ( bbp_is_forum_private( $forum_id, false ) || bbp_is_forum_hidden( $forum_id, false ) ) {
bbp_get_template_part( 'feedback', 'no-access' );
}
// Return contents of output buffer.
return $this->end();
}
/**
* Display the forum form in an output buffer and return to ensure
* post/page contents are displayed first.
*
* @since bbPress (r3566)
*
* @uses get_template_part()
*/
public function display_forum_form() {
// Start output buffer.
$this->start( 'bbp_forum_form' );
// Output templates.
bbp_get_template_part( 'form', 'forum' );
// Return contents of output buffer.
return $this->end();
}
/** Topic shortcodes ******************************************************/
/**
* Display an index of all visible root level topics in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses bbp_get_hidden_forum_ids()
* @uses get_template_part()
* @return string
*/
public function display_topic_index() {
// Unset globals.
$this->unset_globals();
// Filter the query.
if ( ! bbp_is_topic_archive() ) {
add_filter( 'bbp_before_has_topics_parse_args', array( $this, 'display_topic_index_query' ) );
}
// Start output buffer.
$this->start( 'bbp_topic_archive' );
// Output template.
bbp_get_template_part( 'content', 'archive-topic' );
// Return contents of output buffer.
return $this->end();
}
/**
* Display the contents of a specific topic ID in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @return string
*/
public function display_topic( $attr, $content = '' ) {
// Sanity check required info.
if ( ! empty( $content ) || ( empty( $attr['id'] ) || ! is_numeric( $attr['id'] ) ) ) {
return $content;
}
// Unset globals.
$this->unset_globals();
// Set passed attribute to $forum_id for clarity.
$topic_id = bbpress()->current_topic_id = $attr['id'];
$forum_id = bbp_get_topic_forum_id( $topic_id );
// Bail if ID passed is not a topic.
if ( ! bbp_is_topic( $topic_id ) ) {
return $content;
}
// Reset the queries if not in theme compat.
if ( ! bbp_is_theme_compat_active() ) {
$bbp = bbpress();
// Reset necessary forum_query attributes for topics loop to function.
$bbp->forum_query->query_vars['post_type'] = bbp_get_forum_post_type();
$bbp->forum_query->in_the_loop = true;
$bbp->forum_query->post = get_post( $forum_id );
// Reset necessary topic_query attributes for topics loop to function.
$bbp->topic_query->query_vars['post_type'] = bbp_get_topic_post_type();
$bbp->topic_query->in_the_loop = true;
$bbp->topic_query->post = get_post( $topic_id );
}
// Start output buffer.
$this->start( 'bbp_single_topic' );
// Check forum caps.
if ( bbp_user_can_view_forum( array( 'forum_id' => $forum_id ) ) ) {
bbp_get_template_part( 'content', 'single-topic' );
// Forum is private/hidden and user does not have caps.
} elseif ( bbp_is_forum_private( $forum_id, false ) || bbp_is_forum_hidden( $forum_id, false ) ) {
bbp_get_template_part( 'feedback', 'no-access-topic' );
}
// Return contents of output buffer.
return $this->end();
}
/**
* Display the topic form in an output buffer and return to ensure
* post/page contents are displayed first.
*
* Supports 'forum_id' attribute to display the topic form for a particular
* forum. This currently has styling issues from not being wrapped in
* <div id="bbpress-forums"></div> which will need to be sorted out later.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @return string
*/
public function display_topic_form( $attr = array(), $content = '' ) {
// Sanity check supplied info.
if ( ! empty( $content ) || ( ! empty( $attr['forum_id'] ) && ( ! is_numeric( $attr['forum_id'] ) || ! bbp_is_forum( $attr['forum_id'] ) ) ) ) {
return $content;
}
// Unset globals.
$this->unset_globals();
// If forum id is set, use the 'bbp_single_forum' query name.
if ( ! empty( $attr['forum_id'] ) ) {
// Set the global current_forum_id for future requests.
bbpress()->current_forum_id = $forum_id = bbp_get_forum_id( $attr['forum_id'] );
// Start output buffer.
$this->start( 'bbp_single_forum' );
// No forum id was passed.
} else {
// Set the $forum_id variable to satisfy checks below.
$forum_id = 0;
// Start output buffer.
$this->start( 'bbp_topic_form' );
}
// If the forum id is set, check forum caps else display normal topic form.
if ( empty( $forum_id ) || bbp_user_can_view_forum( array( 'forum_id' => $forum_id ) ) ) {
bbp_get_template_part( 'form', 'topic' );
// Forum is private/hidden and user does not have caps.
} elseif ( bbp_is_forum_private( $forum_id, false ) || bbp_is_forum_hidden( $forum_id, false ) ) {
bbp_get_template_part( 'feedback', 'no-access-topic' );
}
// Return contents of output buffer.
return $this->end();
}
/** Replies ***************************************************************/
/**
* Display the contents of a specific reply ID in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @return string
*/
public function display_reply( $attr, $content = '' ) {
// Sanity check required info.
if ( ! empty( $content ) || ( empty( $attr['id'] ) || ! is_numeric( $attr['id'] ) ) ) {
return $content;
}
// Unset globals.
$this->unset_globals();
// Set passed attribute to $reply_id for clarity.
$reply_id = bbpress()->current_reply_id = $attr['id'];
$forum_id = bbp_get_reply_forum_id( $reply_id );
// Bail if ID passed is not a reply.
if ( ! bbp_is_reply( $reply_id ) ) {
return $content;
}
// Reset the queries if not in theme compat.
if ( ! bbp_is_theme_compat_active() ) {
$bbp = bbpress();
// Reset necessary forum_query attributes for replys loop to function.
$bbp->forum_query->query_vars['post_type'] = bbp_get_forum_post_type();
$bbp->forum_query->in_the_loop = true;
$bbp->forum_query->post = get_post( $forum_id );
// Reset necessary reply_query attributes for replys loop to function.
$bbp->reply_query->query_vars['post_type'] = bbp_get_reply_post_type();
$bbp->reply_query->in_the_loop = true;
$bbp->reply_query->post = get_post( $reply_id );
}
// Start output buffer.
$this->start( 'bbp_single_reply' );
// Check forum caps.
if ( bbp_user_can_view_forum( array( 'forum_id' => $forum_id ) ) ) {
bbp_get_template_part( 'content', 'single-reply' );
// Forum is private/hidden and user does not have caps.
} elseif ( bbp_is_forum_private( $forum_id, false ) || bbp_is_forum_hidden( $forum_id, false ) ) {
bbp_get_template_part( 'feedback', 'no-access-reply' );
}
// Return contents of output buffer.
return $this->end();
}
/**
* Display the reply form in an output buffer and return to ensure
* post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @uses get_template_part()
*/
public function display_reply_form( $attr = array(), $content = '' ) {
if ( isset( $attr['id'] ) && bbp_is_topic( $attr['id'] ) ) {
// Unset globals.
$this->unset_globals();
$forum_id = 0;
$topic_id = 0;
// Get forum ID from given topic ID.
$forum_id = bbp_get_reply_forum_id( $attr['id'] );
$topic_id = $attr['id'];
// Set global variables.
bbpress()->current_forum_id = $forum_id;
bbpress()->current_topic_id = $topic_id;
// Reset the queries if not in theme compat.
if ( ! bbp_is_theme_compat_active() ) {
$bbp = bbpress();
// Reset necessary forum_query attributes for replies loop to function.
$bbp->forum_query->query_vars['post_type'] = bbp_get_forum_post_type();
$bbp->forum_query->in_the_loop = true;
$bbp->forum_query->post = get_post( $forum_id );
// Reset necessary topic_query attributes for replies loop to function.
$bbp->topic_query->query_vars['post_type'] = bbp_get_topic_post_type();
$bbp->topic_query->in_the_loop = true;
$bbp->topic_query->post = get_post( $topic_id );
}
}
// Start output buffer.
$this->start( 'bbp_reply_form' );
// Output templates.
bbp_get_template_part( 'form', 'reply' );
// Return contents of output buffer.
return $this->end();
}
/** Topic Tags ************************************************************/
/**
* Display a tag cloud of all topic tags in an output buffer and return to
* ensure that post/page contents are displayed first.
*
* @since bbPress (r3110)
*
* @return string
*/
public function display_topic_tags() {
// Unset globals.
$this->unset_globals();
// Start output buffer.
$this->start( 'bbp_topic_tags' );
// Output the topic tags.
wp_tag_cloud(
array(
'smallest' => 9,
'largest' => 38,
'number' => 80,
'taxonomy' => bbp_get_topic_tag_tax_id(),
)
);
// Return contents of output buffer.
return $this->end();
}
/**
* Display the contents of a specific topic tag in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3110)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @return string
*/
public function display_topics_of_tag( $attr, $content = '' ) {
// Sanity check required info.
if ( ! empty( $content ) || ( empty( $attr['id'] ) || ! is_numeric( $attr['id'] ) ) ) {
return $content;
}
// Unset globals.
$this->unset_globals();
// Filter the query.
if ( ! bbp_is_topic_tag() ) {
add_filter( 'bbp_before_has_topics_parse_args', array( $this, 'display_topics_of_tag_query' ) );
}
// Start output buffer.
$this->start( 'bbp_topic_tag' );
// Set passed attribute to $ag_id for clarity.
bbpress()->current_topic_tag_id = $tag_id = $attr['id'];
// Output template.
bbp_get_template_part( 'content', 'archive-topic' );
// Return contents of output buffer.
return $this->end();
}
/**
* Display the contents of a specific topic tag in an output buffer
* and return to ensure that post/page contents are displayed first.
*
* @since bbPress (r3346)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @return string
*/
public function display_topic_tag_form() {
// Unset globals.
$this->unset_globals();
// Start output buffer.
$this->start( 'bbp_topic_tag_edit' );
// Output template.
bbp_get_template_part( 'content', 'topic-tag-edit' );
// Return contents of output buffer.
return $this->end();
}
/** Views *****************************************************************/
/**
* Display the contents of a specific view in an output buffer and return to
* ensure that post/page contents are displayed first.
*
* @since bbPress (r3031)
*
* @param array $attr
* @param string $content
* @uses get_template_part()
* @uses bbp_single_forum_description()
* @return string
*/
public function display_view( $attr, $content = '' ) {
// Sanity check required info.
if ( empty( $attr['id'] ) ) {
return $content;
}
// Set passed attribute to $view_id for clarity.
$view_id = $attr['id'];
// Start output buffer.
$this->start( 'bbp_single_view' );
// Unset globals.
$this->unset_globals();
// Set the current view ID.
bbpress()->current_view_id = $view_id;
// Load the view.
bbp_view_query( $view_id );
// Output template.
bbp_get_template_part( 'content', 'single-view' );
// Return contents of output buffer.
return $this->end();
}
/** Search ****************************************************************/
/**
* Display the search form in an output buffer and return to ensure
* post/page contents are displayed first.
*
* @since bbPress (r4585)
*
* @uses get_template_part()
*/
public function display_search_form() {
// Bail if search is disabled.
if ( ! bbp_allow_search() ) {
return;
}
// Start output buffer.
$this->start( 'bbp_search_form' );
// Output templates.
bbp_get_template_part( 'form', 'search' );
// Return contents of output buffer.
return $this->end();
}
/**
* Display the contents of search results in an output buffer and return to
* ensure that post/page contents are displayed first.
*
* @since bbPress (r4579)
*
* @param array $attr
* @param string $content
* @uses bbp_search_query()
* @uses get_template_part()
*/
public function display_search( $attr, $content = '' ) {
// Sanity check required info.
if ( ! empty( $content ) ) {
return $content;
}
// Bail if search is disabled.
if ( ! bbp_allow_search() ) {
return;
}
// Trim search attribute if it's set.
if ( isset( $attr['search'] ) ) {
$attr['search'] = trim( $attr['search'] );
}
// Set passed attribute to $search_terms for clarity
$search_terms = empty( $attr['search'] )
? bbp_get_search_terms()
: $attr['search'];
// Get the rewrite ID (one time, to avoid repeated calls)
$rewrite_id = bbp_get_search_rewrite_id();
// Unset globals.
$this->unset_globals();
// Set terms for query
set_query_var( $rewrite_id, $search_terms );
// Start output buffer
$this->start( $rewrite_id );
// Output template.
bbp_get_template_part( 'content', 'search' );
// Return contents of output buffer.
return $this->end();
}
/** Other *****************************************************************/
/**
* Display forum statistics
*
* @since bbPress (r4509)
*
* @return shring
*/
public function display_stats() {
// Unset globals.
$this->unset_globals();
// Start output buffer.
$this->start();
// Output statistics.
bbp_get_template_part( 'content', 'statistics' );
// Return contents of output buffer.
return $this->end();
}
/**
* Display a breadcrumb
*
* @since bbPress (r3302)
*
* @return string
*/
public function display_breadcrumb() {
// Unset globals.
$this->unset_globals();
// Start output buffer.
$this->start();
// Output breadcrumb.
bbp_breadcrumb();
// Return contents of output buffer.
return $this->end();
}
/** Query Filters *********************************************************/
/**
* Filter the query for the topic index
*
* @since bbPress (r3637)
*
* @param array $args
* @return array
*/
public function display_topic_index_query( $args = array() ) {
$args['author'] = 0;
$args['show_stickies'] = true;
$args['order'] = 'DESC';
return $args;
}
/**
* Filter the query for topic tags
*
* @since bbPress (r3637)
*
* @param array $args
* @return array
*/
public function display_topics_of_tag_query( $args = array() ) {
if ( ! empty( bbpress()->current_topic_tag_id ) ) {
$args['tax_query'] = array(
array(
'taxonomy' => bbp_get_topic_tag_tax_id(),
'field' => 'id',
'terms' => bbpress()->current_topic_tag_id,
),
);
}
return $args;
}
}
endif;