/**
* Builds the template hierarchy for the plugin. This function figures out what the current page
* is and returns an array of possible templates to use. Note that this function only returns
* the templates name and not a full paths. It is meant to be used within other functions that actually
* locate/load the templates.
*
* @since 1.0.0
* @access public
* @return array
*/
function mb_get_template_hierarchy()
{
$hierarchy = array();
/* If viewing a single forum page. */
if (mb_is_single_forum()) {
$hierarchy[] = 'single-forum.php';
/* If viewing the forum archive (default forum front). */
} elseif (mb_is_forum_archive()) {
$hierarchy[] = 'archive-forum.php';
/* If viewing a single topic. */
} elseif (mb_is_single_topic()) {
$hierarchy[] = "single-topic.php";
/* If viewing the topic archive (possible forum front page). */
} elseif (mb_is_topic_archive()) {
$hierarchy[] = 'archive-topic.php';
/* If viewing a single reply. */
} elseif (mb_is_single_reply()) {
$hierarchy[] = "single-reply.php";
/* If viewing the reply archive. */
} elseif (mb_is_reply_archive()) {
$hierarchy[] = 'archive-reply.php';
} elseif (mb_is_role_archive()) {
$hierarchy[] = 'archive-role.php';
} elseif (mb_is_single_role()) {
$hierarchy[] = 'single-role.php';
/* If viewing a user sub-page. */
} elseif (mb_is_user_page()) {
$page = sanitize_key(get_query_var('mb_user_page'));
$hierarchy[] = "single-user-{$page}.php";
$hierarchy[] = 'single-user.php';
/* If viewing a user profile page. */
} elseif (mb_is_single_user()) {
$hierarchy[] = 'single-user.php';
/* If viewing the user archive. */
} elseif (mb_is_user_archive()) {
$hierarchy[] = 'archive-user.php';
/* If viewing a search results page. */
} elseif (mb_is_search_results()) {
$hierarchy[] = 'search-results.php';
/* If viewing the advanced search page. */
} elseif (mb_is_search()) {
$hierarchy[] = 'search.php';
/* If viewing the forum login page. */
} elseif (mb_is_forum_login()) {
$hierarchy[] = 'login.php';
/* If viewing an edit page. */
} elseif (mb_is_edit()) {
if (mb_is_forum_edit()) {
$hierarchy[] = 'edit-forum.php';
} elseif (mb_is_topic_edit()) {
$hierarchy[] = 'edit-topic.php';
} elseif (mb_is_reply_edit()) {
$hierarchy[] = 'edit-reply.php';
} elseif (mb_is_user_edit()) {
$hierarchy[] = 'edit-user.php';
}
$hierarchy[] = 'edit.php';
}
/* Add the fallback template. */
$hierarchy[] = 'board.php';
return apply_filters('mb_get_template_hierarchy', $hierarchy);
}
/**
* Filters `wp_title` to handle the title on the forum front page since this is a non-standard WP page.
*
* @since 1.0.0
* @access public
* @param string $title
* @return string
*/
function mb_wp_title($title)
{
if (!mb_is_message_board()) {
return $title;
}
if (mb_is_single_forum()) {
$title = mb_get_single_forum_title();
} elseif (mb_is_forum_archive()) {
$title = mb_get_forum_archive_title();
} elseif (mb_is_single_topic()) {
$title = mb_get_single_topic_title();
} elseif (mb_is_topic_archive()) {
$title = mb_get_topic_archive_title();
} elseif (mb_is_single_reply()) {
$title = mb_get_single_reply_title();
} elseif (mb_is_reply_archive()) {
$title = mb_get_reply_archive_title();
} elseif (mb_is_single_role()) {
$title = mb_get_single_role_title();
} elseif (mb_is_role_archive()) {
$title = mb_get_role_archive_title();
} elseif (mb_is_user_page()) {
$title = mb_get_user_page_title();
} elseif (mb_is_single_user()) {
$title = mb_get_single_user_title();
} elseif (mb_is_user_archive()) {
$title = mb_get_user_archive_title();
} elseif (mb_is_search()) {
$title = mb_get_search_page_title();
} elseif (mb_is_forum_login()) {
$title = mb_get_login_page_title();
} else {
$title = __('Board', 'message-board');
}
return apply_filters('mb_wp_title', $title);
}
/**
* Checks if viewing one of the Message Board plugin pages.
*
* @since 1.0.0
* @access public
* @return bool
*/
function mb_is_message_board()
{
$is_message_board = false;
if (mb_is_search() || mb_is_search_results() || mb_is_forum_login() || mb_is_edit() || mb_is_forum_archive() || mb_is_topic_archive() || mb_is_reply_archive() || mb_is_user_archive() || mb_is_single_forum() || mb_is_single_topic() || mb_is_single_reply() || mb_is_single_user() || mb_is_role_archive() || mb_is_single_role()) {
$is_message_board = true;
}
return apply_filters('mb_is_message_board', $is_message_board);
}
/**
* Checks if viewing the forum search page.
*
* @since 1.0.0
* @access public
* @return bool
*/
function mb_is_search_results()
{
global $wp;
return is_search() && mb_is_search() ? true : false;
}
