/**
* Set the template to use, buffers the needed template parts
* and resets post vars.
*
* @package WP Idea Stream
* @subpackage core/template-loader
*
* @since 2.0.0
*
* @global $wp_query
* @param string $template name of the template to use
* @uses is_buddypress() to bail early if it's this plugin's territory
* @uses wp_idea_stream_get_idea_var() to get a globalized var
* @uses is_404() to check for a 404
* @uses get_query_template() to get a specific template
* @uses get_index_template() to get the index template
* @uses wp_idea_stream_set_idea_var() to set a globalized var
* @uses is_post_type_archive() to check if it's ideas post type archive
* @uses wp_idea_stream_get_post_type() to get ideas post type identifier
* @uses set_query_var() to get a query var
* @uses remove_all_filters() to remove all filters on a specific hook
* @uses wp_idea_stream_reset_post() to reset WordPress $post global and avoid notices
* @uses wp_idea_stream_reset_post_title() to reset the title depending on the context
* @uses wp_idea_stream_buffer_template_part() to buffer the content to display
* @uses wp_idea_stream_is_edit() to check if the idea is to be edited
* @uses wp_idea_stream_ideas_lock_idea() to check if the idea to edit is not currently edited by another user
* @uses wp_idea_stream_add_message() to give a user some feedback
* @uses wp_idea_stream_ideas_can_edit() to check current user can edit an idea
* @uses wp_safe_redirect() to safely redirect the user
* @uses wp_idea_stream_get_redirect_url() to get the default redirect url
* @uses wp_idea_stream_buffer_single_idea() to buffer the idea content to display
* @uses do_action() Calls 'wp_idea_stream_set_core_template' to perform actions once a core template is set
* Calls 'wp_idea_stream_set_single_template' to perform actions relative to the single idea template
* Calls 'wp_idea_stream_set_template' to perform actions when no template matched
* @uses apply_filters() Calls 'wp_idea_stream_template_args' to override template args in case of custom idea action
* Calls 'wp_idea_stream_single_template_args' to override single template args
* @return string $template.
*/
function wp_idea_stream_set_template($template = '')
{
global $wp_query;
/**
* Bail if BuddyPress, we'll use its theme compatibility
* feature.
*/
if (function_exists('is_buddypress') && is_buddypress()) {
return $template;
}
if (wp_idea_stream_get_idea_var('is_ideastream') && !is_404()) {
// Try to see if the theme has a specific template for WP Idea Stream
$template = get_query_template('ideastream');
if (empty($template)) {
// else Try the page template
$template = get_query_template('page', array('page.php'));
}
if (empty($template)) {
// finally fall back to the index template
$template = get_index_template();
}
// Define it into plugin's vars
wp_idea_stream_set_idea_var('template_file', $template);
/**
* First get results of the main query if not on a single idea.
* and build plugin's main_query var.
*/
if (!wp_idea_stream_is_single_idea()) {
wp_idea_stream_set_idea_var('main_query', array('ideas' => $wp_query->posts, 'total' => $wp_query->found_posts, 'query_vars' => array('author' => $wp_query->query_vars['author'], 'per_page' => $wp_query->query_vars['posts_per_page'], 'page' => !empty($wp_query->query_vars['paged']) ? $wp_query->query_vars['paged'] : 1, 'search' => $wp_query->query_vars['s'], 'exclude' => $wp_query->query_vars['post__not_in'], 'include' => $wp_query->query_vars['post__in'], 'orderby' => !empty($wp_query->query_vars['orderby']) ? $wp_query->query_vars['orderby'] : 'date', 'order' => $wp_query->query_vars['order'], 'meta_query' => $wp_query->meta_query->queries, 'tax_query' => $wp_query->tax_query->queries)));
// Resetting the 's' query var now we got main query's result.
set_query_var('s', '');
// Init template args
$template_args = array('post_title' => '', 'comment_status' => 'closed', 'is_archive' => true, 'is_tax' => false, 'template_slug' => 'archive', 'template_name' => '', 'context' => '');
// Main plugin's archive page
if (is_post_type_archive(wp_idea_stream_get_post_type())) {
$template_args['context'] = 'archive';
}
// Category / tag archive pages
if (wp_idea_stream_get_idea_var('is_category') || wp_idea_stream_get_idea_var('is_tag')) {
$template_args['is_tax'] = true;
$template_args['context'] = 'taxonomy';
}
// User's profile pages
if (wp_idea_stream_get_idea_var('is_user')) {
$template_args['template_slug'] = 'user';
$template_args['template_name'] = 'profile';
$template_args['context'] = 'user-profile';
}
if (wp_idea_stream_get_idea_var('is_action')) {
$template_args['is_archive'] = false;
// New idea form
if (wp_idea_stream_is_addnew()) {
$template_args['template_slug'] = 'idea';
$template_args['template_name'] = 'form';
$template_args['context'] = 'new-idea';
} else {
if (wp_idea_stream_is_signup()) {
$template_args['template_slug'] = 'signup';
$template_args['context'] = 'signup';
// Allow plugins to add custom action
} else {
if (has_filter('wp_idea_stream_template_args')) {
/**
* Custom action ?
*
* @param array $template_args the template arguments used to reset the post
*/
$template_args = apply_filters('wp_idea_stream_template_args', $template_args);
}
}
}
}
// Reset WordPress $post global.
wp_idea_stream_reset_post(array('ID' => 0, 'post_title' => wp_idea_stream_reset_post_title($template_args['context']), 'post_author' => 0, 'post_date' => 0, 'post_type' => 'ideas', 'post_status' => 'publish', 'is_archive' => $template_args['is_archive'], 'comment_status' => $template_args['comment_status'], 'post_password' => false, 'is_tax' => $template_args['is_tax']));
/**
* Internally used to redirect to BuddyPress member's profile
* if needed
*
* @param string $context to help choosing the best template to use
*/
do_action('wp_idea_stream_set_core_template', $template_args['context'], $template_args);
} else {
$query_loop = new stdClass();
$query_loop->idea = $wp_query->post;
// Should we use a custom template for single ideas ?
$specific_single_template = get_query_template('single-ideastream');
if (!empty($specific_single_template)) {
$template = $specific_single_template;
}
// Populate the global query loop with current idea
wp_idea_stream_set_idea_var('query_loop', $query_loop);
// Add the id to globals
wp_idea_stream_set_idea_var('single_idea_id', $wp_query->post->ID);
// Are we editing an idea ?
if (wp_idea_stream_is_edit()) {
// Check if the idea is currently being edited by someone else
$user_is_editing = wp_idea_stream_ideas_lock_idea($query_loop->idea->ID);
if (!empty($user_is_editing)) {
wp_idea_stream_add_message(array('type' => 'info', 'content' => sprintf(__('The idea: "%s" is already being edited by another user.', 'wp-idea-stream'), $query_loop->idea->post_title)));
// Redirect the user
wp_safe_redirect(wp_idea_stream_get_redirect_url());
exit;
}
// Bail if user can't edit the idea
if (!wp_idea_stream_ideas_can_edit($query_loop->idea)) {
wp_idea_stream_add_message(array('type' => 'error', 'content' => __('You are not allowed to edit this idea.', 'wp-idea-stream')));
// Redirect the user
wp_safe_redirect(wp_idea_stream_get_redirect_url());
exit;
}
// Inform the idea is to display in an edit form
$query_loop->idea->is_edit = true;
$template_args = array('template_slug' => 'idea', 'template_name' => 'form', 'context' => 'edit-idea');
$single_args = array('ID' => 0, 'post_title' => wp_idea_stream_reset_post_title($template_args['context']), 'post_author' => 0, 'post_date' => 0, 'post_type' => 'ideas', 'post_status' => 'publish', 'is_archive' => false, 'comment_status' => false, 'post_password' => false);
// Or simply viewing one ?
} else {
$template_args = array('context' => 'single-idea');
$single_args = array('is_single' => true);
}
/**
* @param array $single_args the single arguments used to reset the post
*/
wp_idea_stream_reset_post(apply_filters('wp_idea_stream_single_template_args', $single_args));
/**
* Internally used to redirect to Buddypress Group's
* single idea template if needed
*
* @param WP_Post $query_loop->idea the idea to display
*/
do_action('wp_idea_stream_set_single_template', $query_loop->idea, $template_args);
}
}
/**
* No IdeaStream template matched
*/
do_action('wp_idea_stream_set_template');
return $template;
}
/**
* Constructor
*
* @package WP Idea Stream
* @subpackage idea/tags
*
* @since 2.0.0
*
* @param array $args the loop args
* @uses get_query_var()
* @uses wp_idea_stream_get_idea_var() to get the globalized query loop
* @uses wp_idea_stream_ideas_get_idea_by_name() to get the idea object thanks to its post_name
* @uses wp_idea_stream_reset_post() to reset the $wp_query->post data
* @uses wp_idea_stream_set_idea_var() to globalized the need for a reset postdata
* @uses wp_idea_stream_ideas_get_ideas() get all matching ideas
* @uses wp_idea_stream_is_pretty_links() do we have a custom permalink structure ?
* @uses add_query_arg() to build the url in case default permalink is set
* @uses wp_idea_stream_is_idea_archive() to check an idea archive page is being displayed
* @uses wp_idea_stream_get_root_url() to get ideas archive url
* @uses wp_idea_stream_is_category() to check a category page is being displayed
* @uses wp_idea_stream_get_category_url() to get the category url
* @uses wp_idea_stream_is_tag() to check a tag page is being displayed
* @uses wp_idea_stream_get_tag_url() to get the category url
* @uses wp_idea_stream_is_user_profile_rates() to check the rates user's profile page is displayed
* @uses wp_idea_stream_users_get_displayed_profile_url() to get user's profile url
* @uses wp_idea_stream_is_user_profile_ideas() to check the main user's profile page is displayed
* @uses wp_idea_stream_paged_slug() to get the pagination slug
* @uses wp_idea_stream_search_rewrite_id() to get the search rewrite id
* @uses WP_Idea_Stream_Loop::start() to launch the loop
* @uses apply_filters() call 'wp_idea_stream_ideas_pagination_args' to override paginate args
*/
public function __construct($args = array())
{
if (!empty($args) && empty($args['is_widget'])) {
$paged = get_query_var('paged');
// Set which pagination page
if (!empty($paged)) {
$args['page'] = $paged;
// Checking query string just in case
} else {
if (!empty($_GET['paged'])) {
$args['page'] = absint($_GET['paged']);
// Checking in page args
} else {
if (!empty($args['page'])) {
$args['page'] = absint($args['page']);
// Default to first page
} else {
$args['page'] = 1;
}
}
}
}
// Only get the idea requested
if (!empty($args['idea_name'])) {
$query_loop = wp_idea_stream_get_idea_var('query_loop');
if (empty($query_loop->idea)) {
$idea = wp_idea_stream_ideas_get_idea_by_name($args['idea_name']);
} else {
$idea = $query_loop->idea;
}
// can't do this too ealy
$reset_data = array_merge((array) $idea, array('is_page' => true));
wp_idea_stream_reset_post($reset_data);
// this needs a "reset postdata"!
wp_idea_stream_set_idea_var('needs_reset', true);
$ideas = array('ideas' => array($idea), 'total' => 1, 'get_args' => array('page' => 1, 'per_page' => 1));
// Get the ideas
} else {
$ideas = wp_idea_stream_ideas_get_ideas($args);
}
if (!empty($ideas['get_args'])) {
foreach ($ideas['get_args'] as $key => $value) {
$this->{$key} = $value;
}
} else {
return false;
}
$params = array('plugin_prefix' => 'wp_idea_stream', 'item_name' => 'idea', 'item_name_plural' => 'ideas', 'items' => $ideas['ideas'], 'total_item_count' => $ideas['total'], 'page' => $this->page, 'per_page' => $this->per_page);
$paginate_args = array();
// No pretty links
if (!wp_idea_stream_is_pretty_links()) {
$paginate_args['base'] = add_query_arg('paged', '%#%');
} else {
// Is it the main archive page ?
if (wp_idea_stream_is_idea_archive()) {
$base = trailingslashit(wp_idea_stream_get_root_url()) . '%_%';
// Or the category archive page ?
} else {
if (wp_idea_stream_is_category()) {
$base = trailingslashit(wp_idea_stream_get_category_url()) . '%_%';
// Or the tag archive page ?
} else {
if (wp_idea_stream_is_tag()) {
$base = trailingslashit(wp_idea_stream_get_tag_url()) . '%_%';
// Or the displayed user rated ideas ?
} else {
if (wp_idea_stream_is_user_profile_rates()) {
$base = trailingslashit(wp_idea_stream_users_get_displayed_profile_url('rates')) . '%_%';
// Or the displayed user published ideas ?
} else {
if (wp_idea_stream_is_user_profile_ideas()) {
$base = trailingslashit(wp_idea_stream_users_get_displayed_profile_url()) . '%_%';
// Or nothing i've planed ?
} else {
/**
* Create your own pagination base if not handled by the plugin
*
* @param string empty string
*/
$base = apply_filters('wp_idea_stream_ideas_pagination_base', '');
}
}
}
}
}
$paginate_args['base'] = $base;
$paginate_args['format'] = wp_idea_stream_paged_slug() . '/%#%/';
}
// Is this a search ?
if (wp_idea_stream_get_idea_var('is_search')) {
$paginate_args['add_args'] = array(wp_idea_stream_search_rewrite_id() => $_GET[wp_idea_stream_search_rewrite_id()]);
}
// Do we have a specific order to use ?
$orderby = wp_idea_stream_get_idea_var('orderby');
if (!empty($orderby) && 'date' != $orderby) {
$merge = array();
if (!empty($paginate_args['add_args'])) {
$merge = $paginate_args['add_args'];
}
$paginate_args['add_args'] = array_merge($merge, array('orderby' => $orderby));
}
/**
* Use this filter to override the pagination
*
* @param array $paginate_args the pagination arguments
*/
parent::start($params, apply_filters('wp_idea_stream_ideas_pagination_args', $paginate_args));
}
