/**
* Setup the post types for forums, topics and replies
*
* @since bbPress (r2597)
* @uses register_post_type() To register the post types
* @uses apply_filters() Calls various filters to modify the arguments
* sent to register_post_type()
*/
public static function register_post_types()
{
/** Forums ************************************************************/
// Register Forum content type
register_post_type(bbp_get_forum_post_type(), apply_filters('bbp_register_forum_post_type', array('labels' => bbp_get_forum_post_type_labels(), 'rewrite' => bbp_get_forum_post_type_rewrite(), 'supports' => bbp_get_forum_post_type_supports(), 'description' => __('bbPress Forums', 'bbpress'), 'capabilities' => bbp_get_forum_caps(), 'capability_type' => array('forum', 'forums'), 'menu_position' => 555555, 'has_archive' => bbp_get_root_slug(), 'exclude_from_search' => true, 'show_in_nav_menus' => true, 'public' => true, 'show_ui' => current_user_can('bbp_forums_admin'), 'can_export' => true, 'hierarchical' => true, 'query_var' => true, 'menu_icon' => '')));
/** Topics ************************************************************/
// Register Topic content type
register_post_type(bbp_get_topic_post_type(), apply_filters('bbp_register_topic_post_type', array('labels' => bbp_get_topic_post_type_labels(), 'rewrite' => bbp_get_topic_post_type_rewrite(), 'supports' => bbp_get_topic_post_type_supports(), 'description' => __('bbPress Topics', 'bbpress'), 'capabilities' => bbp_get_topic_caps(), 'capability_type' => array('topic', 'topics'), 'menu_position' => 555555, 'has_archive' => 'forums' === bbp_show_on_root() ? bbp_get_topic_archive_slug() : false, 'exclude_from_search' => true, 'show_in_nav_menus' => false, 'public' => true, 'show_ui' => current_user_can('bbp_topics_admin'), 'can_export' => true, 'hierarchical' => false, 'query_var' => true, 'menu_icon' => '')));
/** Replies ***********************************************************/
// Register reply content type
register_post_type(bbp_get_reply_post_type(), apply_filters('bbp_register_reply_post_type', array('labels' => bbp_get_reply_post_type_labels(), 'rewrite' => bbp_get_reply_post_type_rewrite(), 'supports' => bbp_get_reply_post_type_supports(), 'description' => __('bbPress Replies', 'bbpress'), 'capabilities' => bbp_get_reply_caps(), 'capability_type' => array('reply', 'replies'), 'menu_position' => 555555, 'exclude_from_search' => true, 'has_archive' => false, 'show_in_nav_menus' => false, 'public' => true, 'show_ui' => current_user_can('bbp_replies_admin'), 'can_export' => true, 'hierarchical' => false, 'query_var' => true, 'menu_icon' => '')));
}
/**
* Include root slug setting field
*
* @since 2.0.0 bbPress (r2786)
*
* @uses checked() To display the checked attribute
*/
function bbp_admin_setting_callback_show_on_root()
{
// Current setting
$show_on_root = bbp_show_on_root();
// Options for forum root output
$root_options = array('forums' => array('name' => __('Forum Index', 'bbpress')), 'topics' => array('name' => __('Topics by Freshness', 'bbpress')));
?>
<select name="_bbp_show_on_root" id="_bbp_show_on_root" <?php
bbp_maybe_admin_setting_disabled('_bbp_show_on_root');
?>
>
<?php
foreach ($root_options as $option_id => $details) {
?>
<option <?php
selected($show_on_root, $option_id);
?>
value="<?php
echo esc_attr($option_id);
?>
"><?php
echo esc_html($details['name']);
?>
</option>
<?php
}
?>
</select>
<?php
}
/**
* Add checks for bbPress conditions to parse_query action
*
* If it's a user page, WP_Query::bbp_is_single_user is set to true.
* If it's a user edit page, WP_Query::bbp_is_single_user_edit is set to true
* and the the 'wp-admin/includes/user.php' file is included.
* In addition, on user/user edit pages, WP_Query::home is set to false & query
* vars 'bbp_user_id' with the displayed user id and 'author_name' with the
* displayed user's nicename are added.
*
* If it's a forum edit, WP_Query::bbp_is_forum_edit is set to true
* If it's a topic edit, WP_Query::bbp_is_topic_edit is set to true
* If it's a reply edit, WP_Query::bbp_is_reply_edit is set to true.
*
* If it's a view page, WP_Query::bbp_is_view is set to true
* If it's a search page, WP_Query::bbp_is_search is set to true
*
* @since bbPress (r2688)
*
* @param WP_Query $posts_query
*
* @uses get_query_var() To get {@link WP_Query} query var
* @uses is_email() To check if the string is an email
* @uses get_user_by() To try to get the user by email and nicename
* @uses get_userdata() to get the user data
* @uses current_user_can() To check if the current user can edit the user
* @uses is_user_member_of_blog() To check if user profile page exists
* @uses WP_Query::set_404() To set a 404 status
* @uses apply_filters() Calls 'enable_edit_any_user_configuration' with true
* @uses bbp_get_view_query_args() To get the view query args
* @uses bbp_get_forum_post_type() To get the forum post type
* @uses bbp_get_topic_post_type() To get the topic post type
* @uses bbp_get_reply_post_type() To get the reply post type
* @uses remove_action() To remove the auto save post revision action
*/
function bbp_parse_query($posts_query)
{
// Bail if $posts_query is not the main loop
if (!$posts_query->is_main_query()) {
return;
}
// Bail if filters are suppressed on this query
if (true === $posts_query->get('suppress_filters')) {
return;
}
// Bail if in admin
if (is_admin()) {
return;
}
// Get query variables
$bbp_view = $posts_query->get(bbp_get_view_rewrite_id());
$bbp_user = $posts_query->get(bbp_get_user_rewrite_id());
$is_edit = $posts_query->get(bbp_get_edit_rewrite_id());
// It is a user page - We'll also check if it is user edit
if (!empty($bbp_user)) {
/** Find User *********************************************************/
// Setup the default user variable
$the_user = false;
// If using pretty permalinks, use the email or slug
if (get_option('permalink_structure')) {
// Email was passed
if (is_email($bbp_user)) {
$the_user = get_user_by('email', $bbp_user);
// Try nicename
} else {
$the_user = get_user_by('slug', $bbp_user);
}
}
// No user found by slug/email, so try the ID if it's numeric
if (empty($the_user) && is_numeric($bbp_user)) {
$the_user = get_user_by('id', $bbp_user);
}
// 404 and bail if user does not have a profile
if (empty($the_user->ID) || !bbp_user_has_profile($the_user->ID)) {
$posts_query->set_404();
return;
}
/** User Exists *******************************************************/
$is_favs = $posts_query->get(bbp_get_user_favorites_rewrite_id());
$is_subs = $posts_query->get(bbp_get_user_subscriptions_rewrite_id());
$is_topics = $posts_query->get(bbp_get_user_topics_rewrite_id());
$is_replies = $posts_query->get(bbp_get_user_replies_rewrite_id());
// View or edit?
if (!empty($is_edit)) {
// We are editing a profile
$posts_query->bbp_is_single_user_edit = true;
// Load the core WordPress contact methods
if (!function_exists('_wp_get_user_contactmethods')) {
include_once ABSPATH . 'wp-includes/registration.php';
}
// Load the edit_user functions
if (!function_exists('edit_user')) {
require_once ABSPATH . 'wp-admin/includes/user.php';
}
// Load the grant/revoke super admin functions
if (is_multisite() && !function_exists('revoke_super_admin')) {
require_once ABSPATH . 'wp-admin/includes/ms.php';
}
// Editing a user
$posts_query->bbp_is_edit = true;
// User favorites
} elseif (!empty($is_favs)) {
$posts_query->bbp_is_single_user_favs = true;
// User subscriptions
} elseif (!empty($is_subs)) {
$posts_query->bbp_is_single_user_subs = true;
// User topics
} elseif (!empty($is_topics)) {
$posts_query->bbp_is_single_user_topics = true;
// User topics
} elseif (!empty($is_replies)) {
$posts_query->bbp_is_single_user_replies = true;
// User profile
} else {
$posts_query->bbp_is_single_user_profile = true;
}
// Looking at a single user
$posts_query->bbp_is_single_user = true;
// Make sure 404 is not set
$posts_query->is_404 = false;
// Correct is_home variable
$posts_query->is_home = false;
// User is looking at their own profile
if (get_current_user_id() === $the_user->ID) {
$posts_query->bbp_is_single_user_home = true;
}
// Set bbp_user_id for future reference
$posts_query->set('bbp_user_id', $the_user->ID);
// Set author_name as current user's nicename to get correct posts
$posts_query->set('author_name', $the_user->user_nicename);
// Set the displayed user global to this user
bbpress()->displayed_user = $the_user;
// View Page
} elseif (!empty($bbp_view)) {
// Check if the view exists by checking if there are query args are set
$view_args = bbp_get_view_query_args($bbp_view);
// Bail if view args is false (view isn't registered)
if (false === $view_args) {
$posts_query->set_404();
return;
}
// Correct is_home variable
$posts_query->is_home = false;
// We are in a custom topic view
$posts_query->bbp_is_view = true;
// Search Page
} elseif (isset($posts_query->query_vars[bbp_get_search_rewrite_id()])) {
// Check if there are search query args set
$search_terms = bbp_get_search_terms();
if (!empty($search_terms)) {
$posts_query->bbp_search_terms = $search_terms;
}
// Correct is_home variable
$posts_query->is_home = false;
// We are in a search query
$posts_query->bbp_is_search = true;
// Forum/Topic/Reply Edit Page
} elseif (!empty($is_edit)) {
// Get the post type from the main query loop
$post_type = $posts_query->get('post_type');
// Check which post_type we are editing, if any
if (!empty($post_type)) {
switch ($post_type) {
// We are editing a forum
case bbp_get_forum_post_type():
$posts_query->bbp_is_forum_edit = true;
$posts_query->bbp_is_edit = true;
break;
// We are editing a topic
// We are editing a topic
case bbp_get_topic_post_type():
$posts_query->bbp_is_topic_edit = true;
$posts_query->bbp_is_edit = true;
break;
// We are editing a reply
// We are editing a reply
case bbp_get_reply_post_type():
$posts_query->bbp_is_reply_edit = true;
$posts_query->bbp_is_edit = true;
break;
}
// We are editing a topic tag
} elseif (bbp_is_topic_tag()) {
$posts_query->bbp_is_topic_tag_edit = true;
$posts_query->bbp_is_edit = true;
}
// We save post revisions on our own
remove_action('pre_post_update', 'wp_save_post_revision');
// Topic tag page
} elseif (bbp_is_topic_tag()) {
$posts_query->set('bbp_topic_tag', get_query_var('term'));
$posts_query->set('post_type', bbp_get_topic_post_type());
$posts_query->set('posts_per_page', bbp_get_topics_per_page());
// Do topics on forums root
} elseif (is_post_type_archive(array(bbp_get_forum_post_type(), bbp_get_topic_post_type())) && 'topics' === bbp_show_on_root()) {
$posts_query->bbp_show_topics_on_root = true;
}
}
/**
* Reset main query vars and filter 'the_content' to output a bbPress
* template part as needed.
*
* @since 2.0.0 bbPress (r3032)
*
* @param string $template
* @uses bbp_is_single_user() To check if page is single user
* @uses bbp_get_single_user_template() To get user template
* @uses bbp_is_single_user_edit() To check if page is single user edit
* @uses bbp_get_single_user_edit_template() To get user edit template
* @uses bbp_is_single_view() To check if page is single view
* @uses bbp_get_single_view_template() To get view template
* @uses bbp_is_search() To check if page is search
* @uses bbp_get_search_template() To get search template
* @uses bbp_is_forum_edit() To check if page is forum edit
* @uses bbp_get_forum_edit_template() To get forum edit template
* @uses bbp_is_topic_merge() To check if page is topic merge
* @uses bbp_get_topic_merge_template() To get topic merge template
* @uses bbp_is_topic_split() To check if page is topic split
* @uses bbp_get_topic_split_template() To get topic split template
* @uses bbp_is_topic_edit() To check if page is topic edit
* @uses bbp_get_topic_edit_template() To get topic edit template
* @uses bbp_is_reply_move() To check if page is reply move
* @uses bbp_get_reply_move_template() To get reply move template
* @uses bbp_is_reply_edit() To check if page is reply edit
* @uses bbp_get_reply_edit_template() To get reply edit template
* @uses bbp_set_theme_compat_template() To set the global theme compat template
*/
function bbp_template_include_theme_compat($template = '')
{
/**
* Bail if a root template was already found. This prevents unintended
* recursive filtering of 'the_content'.
*
* @link https://bbpress.trac.wordpress.org/ticket/2429
*/
if (bbp_is_template_included()) {
return $template;
}
/**
* If BuddyPress is activated at a network level, the action order is
* reversed, which causes the template integration to fail. If we're looking
* at a BuddyPress page here, bail to prevent the extra processing.
*
* This is a bit more brute-force than is probably necessary, but gets the
* job done while we work towards something more elegant.
*/
if (function_exists('is_buddypress') && is_buddypress()) {
return $template;
}
// Define local variable(s)
$bbp_shortcodes = bbpress()->shortcodes;
// Bail if shortcodes are unset somehow
if (!is_a($bbp_shortcodes, 'BBP_Shortcodes')) {
return $template;
}
/** Users *************************************************************/
if (bbp_is_single_user_edit() || bbp_is_single_user()) {
// Reset post
bbp_theme_compat_reset_post(array('ID' => 0, 'post_author' => 0, 'post_date' => 0, 'post_content' => bbp_buffer_template_part('content', 'single-user', false), 'post_type' => '', 'post_title' => bbp_get_displayed_user_field('display_name'), 'post_status' => bbp_get_public_status_id(), 'is_single' => true, 'is_archive' => false, 'comment_status' => 'closed'));
/** Forums ************************************************************/
// Forum archive
} elseif (bbp_is_forum_archive()) {
// Page exists where this archive should be
$page = bbp_get_page_by_path(bbp_get_root_slug());
// Should we replace the content...
if (empty($page->post_content)) {
// Use the topics archive
if ('topics' === bbp_show_on_root()) {
$new_content = $bbp_shortcodes->display_topic_index();
// No page so show the archive
} else {
$new_content = $bbp_shortcodes->display_forum_index();
}
// ...or use the existing page content?
} else {
$new_content = apply_filters('the_content', $page->post_content);
}
// Should we replace the title...
if (empty($page->post_title)) {
// Use the topics archive
if ('topics' === bbp_show_on_root()) {
$new_title = bbp_get_topic_archive_title();
// No page so show the archive
} else {
$new_title = bbp_get_forum_archive_title();
}
// ...or use the existing page title?
} else {
$new_title = apply_filters('the_title', $page->post_title);
}
// Reset post
bbp_theme_compat_reset_post(array('ID' => !empty($page->ID) ? $page->ID : 0, 'post_title' => $new_title, 'post_author' => 0, 'post_date' => 0, 'post_content' => $new_content, 'post_type' => bbp_get_forum_post_type(), 'post_status' => bbp_get_public_status_id(), 'is_archive' => true, 'comment_status' => 'closed'));
// Single Forum
} elseif (bbp_is_forum_edit()) {
// Reset post
bbp_theme_compat_reset_post(array('ID' => bbp_get_forum_id(), 'post_title' => bbp_get_forum_title(), 'post_author' => bbp_get_forum_author_id(), 'post_date' => 0, 'post_content' => $bbp_shortcodes->display_forum_form(), 'post_type' => bbp_get_forum_post_type(), 'post_status' => bbp_get_forum_visibility(), 'is_single' => true, 'comment_status' => 'closed'));
} elseif (bbp_is_single_forum()) {
// Reset post
bbp_theme_compat_reset_post(array('ID' => bbp_get_forum_id(), 'post_title' => bbp_get_forum_title(), 'post_author' => bbp_get_forum_author_id(), 'post_date' => 0, 'post_content' => $bbp_shortcodes->display_forum(array('id' => bbp_get_forum_id())), 'post_type' => bbp_get_forum_post_type(), 'post_status' => bbp_get_forum_visibility(), 'is_single' => true, 'comment_status' => 'closed'));
/** Topics ************************************************************/
// Topic archive
} elseif (bbp_is_topic_archive()) {
// Page exists where this archive should be
$page = bbp_get_page_by_path(bbp_get_topic_archive_slug());
// Should we replace the content...
if (empty($page->post_content)) {
$new_content = $bbp_shortcodes->display_topic_index();
// ...or use the existing page content?
} else {
$new_content = apply_filters('the_content', $page->post_content);
}
// Should we replace the title...
if (empty($page->post_title)) {
$new_title = bbp_get_topic_archive_title();
// ...or use the existing page title?
} else {
$new_title = apply_filters('the_title', $page->post_title);
}
// Reset post
bbp_theme_compat_reset_post(array('ID' => !empty($page->ID) ? $page->ID : 0, 'post_title' => bbp_get_topic_archive_title(), 'post_author' => 0, 'post_date' => 0, 'post_content' => $new_content, 'post_type' => bbp_get_topic_post_type(), 'post_status' => bbp_get_public_status_id(), 'is_archive' => true, 'comment_status' => 'closed'));
// Single Topic
} elseif (bbp_is_topic_edit() || bbp_is_single_topic()) {
// Split
if (bbp_is_topic_split()) {
$new_content = bbp_buffer_template_part('form', 'topic-split', false);
// Merge
} elseif (bbp_is_topic_merge()) {
$new_content = bbp_buffer_template_part('form', 'topic-merge', false);
// Edit
} elseif (bbp_is_topic_edit()) {
$new_content = $bbp_shortcodes->display_topic_form();
// Single
} else {
$new_content = $bbp_shortcodes->display_topic(array('id' => bbp_get_topic_id()));
}
// Reset post
bbp_theme_compat_reset_post(array('ID' => bbp_get_topic_id(), 'post_title' => bbp_get_topic_title(), 'post_author' => bbp_get_topic_author_id(), 'post_date' => 0, 'post_content' => $new_content, 'post_type' => bbp_get_topic_post_type(), 'post_status' => bbp_get_topic_status(), 'is_single' => true, 'comment_status' => 'closed'));
/** Replies ***********************************************************/
// Reply archive
} elseif (is_post_type_archive(bbp_get_reply_post_type())) {
// Reset post
bbp_theme_compat_reset_post(array('ID' => 0, 'post_title' => __('Replies', 'bbpress'), 'post_author' => 0, 'post_date' => 0, 'post_content' => $bbp_shortcodes->display_reply_index(), 'post_type' => bbp_get_reply_post_type(), 'post_status' => bbp_get_public_status_id(), 'comment_status' => 'closed'));
// Single Reply
} elseif (bbp_is_reply_edit() || bbp_is_single_reply()) {
// Move
if (bbp_is_reply_move()) {
$new_content = bbp_buffer_template_part('form', 'reply-move', false);
// Edit
} elseif (bbp_is_reply_edit()) {
$new_content = $bbp_shortcodes->display_reply_form();
// Single
} else {
$new_content = $bbp_shortcodes->display_reply(array('id' => get_the_ID()));
}
// Reset post
bbp_theme_compat_reset_post(array('ID' => bbp_get_reply_id(), 'post_title' => bbp_get_reply_title(), 'post_author' => bbp_get_reply_author_id(), 'post_date' => 0, 'post_content' => $new_content, 'post_type' => bbp_get_reply_post_type(), 'post_status' => bbp_get_reply_status(), 'comment_status' => 'closed'));
/** Views *************************************************************/
} elseif (bbp_is_single_view()) {
// Reset post
bbp_theme_compat_reset_post(array('ID' => 0, 'post_title' => bbp_get_view_title(), 'post_author' => 0, 'post_date' => 0, 'post_content' => $bbp_shortcodes->display_view(array('id' => get_query_var(bbp_get_view_rewrite_id()))), 'post_type' => '', 'post_status' => bbp_get_public_status_id(), 'comment_status' => 'closed'));
/** Search ************************************************************/
} elseif (bbp_is_search()) {
// Reset post
bbp_theme_compat_reset_post(array('ID' => 0, 'post_title' => bbp_get_search_title(), 'post_author' => 0, 'post_date' => 0, 'post_content' => $bbp_shortcodes->display_search(array('search' => get_query_var(bbp_get_search_rewrite_id()))), 'post_type' => '', 'post_status' => bbp_get_public_status_id(), 'comment_status' => 'closed'));
/** Topic Tags ********************************************************/
// Topic Tag Edit
} elseif (bbp_is_topic_tag_edit() || bbp_is_topic_tag()) {
// Stash the current term in a new var
set_query_var('bbp_topic_tag', get_query_var('term'));
// Show topics of tag
if (bbp_is_topic_tag()) {
$new_content = $bbp_shortcodes->display_topics_of_tag(array('id' => bbp_get_topic_tag_id()));
// Edit topic tag
} elseif (bbp_is_topic_tag_edit()) {
$new_content = $bbp_shortcodes->display_topic_tag_form();
}
// Reset the post with our new title
bbp_theme_compat_reset_post(array('ID' => 0, 'post_author' => 0, 'post_date' => 0, 'post_content' => $new_content, 'post_type' => '', 'post_title' => sprintf(__('Topic Tag: %s', 'bbpress'), '<span>' . bbp_get_topic_tag_name() . '</span>'), 'post_status' => bbp_get_public_status_id(), 'comment_status' => 'closed', 'is_tax' => true));
}
/**
* Bail if the template already matches a bbPress template. This includes
* archive-* and single-* WordPress post_type matches (allowing
* themes to use the expected format) as well as all bbPress-specific
* template files for users, topics, forums, etc...
*
* We do this after the above checks to prevent incorrect 404 body classes
* and header statuses, as well as to set the post global as needed.
*
* @see https://bbpress.trac.wordpress.org/ticket/1478/
*/
if (bbp_is_template_included()) {
return $template;
/**
* If we are relying on bbPress's built in theme compatibility to load
* the proper content, we need to intercept the_content, replace the
* output, and display ours instead.
*
* To do this, we first remove all filters from 'the_content' and hook
* our own function into it, which runs a series of checks to determine
* the context, and then uses the built in shortcodes to output the
* correct results from inside an output buffer.
*
* Uses bbp_get_theme_compat_templates() to provide fall-backs that
* should be coded without superfluous mark-up and logic (prev/next
* navigation, comments, date/time, etc...)
*
* Hook into the 'bbp_get_bbpress_template' to override the array of
* possible templates, or 'bbp_bbpress_template' to override the result.
*/
} elseif (bbp_is_theme_compat_active()) {
bbp_remove_all_filters('the_content');
$template = bbp_get_theme_compat_templates();
}
return apply_filters('bbp_template_include_theme_compat', $template);
}
