/**
* Check the main WordPress query to match WP Idea Stream conditions
* Eventually Override query vars and set global template conditions / vars
*
* This the key function of the plugin, it is definining the templates
* to load and is setting the displayed user.
*
* Inspired by bbPress 's bbp_parse_query()
*
* @package WP Idea Stream
* @subpackage core/template-functions
*
* @since 2.0.0
*
* @param WP_Query $posts_query The WP_Query instance
* @uses WP_Query->is_main_query() to check it's the main query
* @uses WP_Query->get() to get a query var
* @uses wp_idea_stream_is_admin() to check if in IdeaStream's Admin territory
* @uses wp_idea_stream_is_sticky_enabled() to check if sticky feature is available
* @uses WP_Query->set() to set a query var
* @uses wp_idea_stream_is_rating_disabled() to check if ratings feature are available
* @uses wp_idea_stream_set_idea_var() to globalize a var
* @uses is_admin() to check for WordPress administration
* @uses wp_idea_stream_get_post_type() to get the ideas post type identifier
* @uses wp_idea_stream_user_rewrite_id() to get the user rewrite id
* @uses wp_idea_stream_users_get_user_data() to get a specific user's data
* @uses WP_Query->set_404() to set a 404
* @uses wp_idea_stream_user_rates_rewrite_id() to get the user rates rewrite id
* @uses wp_idea_stream_user_comments_rewrite_id() to get the user comments rewrite id
* @uses wp_idea_stream_action_rewrite_id() to get the action rewrite id
* @uses wp_idea_stream_addnew_slug() to get the add new slug
* @uses wp_idea_stream_edit_slug() to get the edit slug
* @uses has_action() to check if the action 'wp_idea_stream_custom_action' is used by any plugins
* @uses do_action() Calls 'wp_idea_stream_custom_action' to perform actions relative to ideas
* @uses wp_idea_stream_get_category() to get the ideas category identifier
* @uses wp_idea_stream_get_tag() to get the ideas tag identifier
* @uses wp_idea_stream_search_rewrite_id() to get the search rewrite id
*/
function wp_idea_stream_parse_query($posts_query = null)
{
// 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;
}
// Handle the specific queries in IdeaStream Admin
if (wp_idea_stream_is_admin()) {
// Display sticky ideas if requested
if (wp_idea_stream_is_sticky_enabled() && !empty($_GET['sticky_ideas'])) {
$posts_query->set('post__in', wp_idea_stream_ideas_get_stickies());
}
// Build meta_query if orderby rates is set
if (!wp_idea_stream_is_rating_disabled() && !empty($_GET['orderby']) && 'rates_count' == $_GET['orderby']) {
$posts_query->set('meta_query', array(array('key' => '_ideastream_average_rate', 'compare' => 'EXISTS')));
// Set the orderby idea var
wp_idea_stream_set_idea_var('orderby', 'rates_count');
}
do_action('wp_idea_stream_admin_request', $posts_query);
return;
}
// Bail if else where in admin
if (is_admin()) {
return;
}
// Ideas post type for a later use
$idea_post_type = wp_idea_stream_get_post_type();
/** User's profile ************************************************************/
// Are we requesting the user-profile template ?
$user = $posts_query->get(wp_idea_stream_user_rewrite_id());
$embed_page = wp_idea_stream_is_embed_profile();
if (!empty($user)) {
if (!is_numeric($user)) {
// Get user by his username
$user = wp_idea_stream_users_get_user_data('slug', $user);
} else {
// Get user by his id
$user = wp_idea_stream_users_get_user_data('id', $user);
}
// No user id: no profile!
if (empty($user->ID) || true === apply_filters('wp_idea_stream_users_is_spammy', is_multisite() && is_user_spammy($user), $user)) {
$posts_query->set_404();
// Make sure the WordPress Embed Template will be used
if ('true' === get_query_var('embed') || true === get_query_var('embed')) {
$posts_query->is_embed = true;
$posts_query->set('p', -1);
}
return;
}
// Set the displayed user id
wp_idea_stream_set_idea_var('is_user', absint($user->ID));
// Make sure the post_type is set to ideas.
$posts_query->set('post_type', $idea_post_type);
// Are we requesting user rates
$user_rates = $posts_query->get(wp_idea_stream_user_rates_rewrite_id());
// Or user comments ?
$user_comments = $posts_query->get(wp_idea_stream_user_comments_rewrite_id());
if (!empty($user_rates) && !wp_idea_stream_is_rating_disabled()) {
// We are viewing user's rates
wp_idea_stream_set_idea_var('is_user_rates', true);
// Define the Meta Query to get his rates
$posts_query->set('meta_query', array(array('key' => '_ideastream_rates', 'value' => ';i:' . $user->ID . ';', 'compare' => 'LIKE')));
} else {
if (!empty($user_comments)) {
// We are viewing user's comments
wp_idea_stream_set_idea_var('is_user_comments', true);
/**
* Make sure no result.
* Query will be built later in user comments loop
*/
$posts_query->set('p', -1);
} else {
if ('true' === get_query_var('embed') || true === get_query_var('embed')) {
$posts_query->is_embed = true;
$posts_query->set('p', -1);
if ($embed_page) {
wp_idea_stream_set_idea_var('is_user_embed', true);
} else {
$posts_query->set_404();
return;
}
}
// Default to the ideas the user submitted
$posts_query->set('author', $user->ID);
}
}
// No stickies on user's profile
$posts_query->set('ignore_sticky_posts', true);
// Make sure no 404
$posts_query->is_404 = false;
// Set the displayed user.
wp_idea_stream_set_idea_var('displayed_user', $user);
}
/** Actions (New Idea) ********************************************************/
$action = $posts_query->get(wp_idea_stream_action_rewrite_id());
if (!empty($action)) {
// Make sure the post type is set to ideas
$posts_query->set('post_type', $idea_post_type);
// Define a global to inform we're dealing with an action
wp_idea_stream_set_idea_var('is_action', true);
// Is the new idea form requested ?
if (wp_idea_stream_addnew_slug() == $action) {
// Yes so set the corresponding var
wp_idea_stream_set_idea_var('is_new', true);
/**
* Make sure no result.
* We are not querying any content, but creating one
*/
$posts_query->set('p', -1);
// Edit action ?
} else {
if (wp_idea_stream_edit_slug() == $action) {
// Yes so set the corresponding var
wp_idea_stream_set_idea_var('is_edit', true);
// Signup support
} else {
if (wp_idea_stream_signup_slug() == $action && wp_idea_stream_is_signup_allowed_for_current_blog()) {
// Set the signup global var
wp_idea_stream_set_idea_var('is_signup', true);
/**
* Make sure no result.
* We are not querying any content, but creating one
*/
$posts_query->set('p', -1);
} else {
if (has_action('wp_idea_stream_custom_action')) {
/**
* Allow plugins to other custom idea actions
*
* @param string $action The requested action
* @param WP_Query $posts_query The WP_Query instance
*/
do_action('wp_idea_stream_custom_action', $action, $posts_query);
} else {
$posts_query->set_404();
return;
}
}
}
}
}
/** Ideas by category *********************************************************/
$category = $posts_query->get(wp_idea_stream_get_category());
if (!empty($category)) {
// Make sure the post type is set to ideas
$posts_query->set('post_type', $idea_post_type);
// Define the current category
wp_idea_stream_set_idea_var('is_category', $category);
}
/** Ideas by tag **************************************************************/
$tag = $posts_query->get(wp_idea_stream_get_tag());
if (!empty($tag)) {
// Make sure the post type is set to ideas
$posts_query->set('post_type', $idea_post_type);
// Define the current tag
wp_idea_stream_set_idea_var('is_tag', $tag);
}
/** Searching ideas ***********************************************************/
$search = $posts_query->get(wp_idea_stream_search_rewrite_id());
if (!empty($search)) {
// Make sure the post type is set to ideas
$posts_query->set('post_type', $idea_post_type);
// Define the query as a search one
$posts_query->set('is_search', true);
/**
* Temporarly set the 's' parameter of WP Query
* This will be reset while building ideas main_query args
* @see wp_idea_stream_set_template()
*/
$posts_query->set('s', $search);
// Set the search conditionnal var
wp_idea_stream_set_idea_var('is_search', true);
}
/** Changing order ************************************************************/
// Here we're using built-in var
$orderby = $posts_query->get('orderby');
// Make sure we are ordering ideas
if (!empty($orderby) && $idea_post_type == $posts_query->get('post_type')) {
if (!wp_idea_stream_is_rating_disabled() && 'rates_count' == $orderby) {
/**
* It's an order by rates request, set the meta query to achieve this.
* Here we're not ordering yet, we simply make sure to get ideas that
* have been rated.
* Order will happen thanks to wp_idea_stream_set_rates_count_orderby()
* filter.
*/
$posts_query->set('meta_query', array(array('key' => '_ideastream_average_rate', 'compare' => 'EXISTS')));
}
// Set the order by var
wp_idea_stream_set_idea_var('orderby', $orderby);
}
// Set the idea archive var if viewing ideas archive
if ($posts_query->is_post_type_archive()) {
wp_idea_stream_set_idea_var('is_idea_archive', true);
}
/**
* Finally if post_type is ideas, then we're in IdeaStream's
* territory so set this
*/
if ($idea_post_type === $posts_query->get('post_type')) {
wp_idea_stream_set_idea_var('is_ideastream', true);
// Reset the pagination
if (-1 !== $posts_query->get('p')) {
$posts_query->set('posts_per_page', wp_idea_stream_ideas_per_page());
}
}
}
/**
* Setup the rewrite ids and slugs
*
* @package WP Idea Stream
* @subpackage core/classes
*
* @since 2.0.0
*
* @uses wp_idea_stream_user_rewrite_id()
* @uses wp_idea_stream_user_rates_rewrite_id()
* @uses wp_idea_stream_user_comments_rewrite_id()
* @uses wp_idea_stream_cpage_rewrite_id()
* @uses wp_idea_stream_action_rewrite_id()
* @uses wp_idea_stream_search_rewrite_id()
* @uses wp_idea_stream_user_slug()
* @uses wp_idea_stream_user_rates_slug()
* @uses wp_idea_stream_user_comments_slug()
* @uses wp_idea_stream_cpage_slug()
* @uses wp_idea_stream_action_slug()
*/
private function setup_globals()
{
/** Rewrite ids ***************************************************************/
$this->page_rid = 'paged';
// WordPress built-in global var
$this->user_rid = wp_idea_stream_user_rewrite_id();
$this->user_rates_rid = wp_idea_stream_user_rates_rewrite_id();
$this->user_comments_rid = wp_idea_stream_user_comments_rewrite_id();
$this->cpage_rid = wp_idea_stream_cpage_rewrite_id();
$this->action_rid = wp_idea_stream_action_rewrite_id();
$this->search_rid = wp_idea_stream_search_rewrite_id();
/** Rewrite slugs *************************************************************/
$this->user_slug = wp_idea_stream_user_slug();
$this->user_rates_slug = wp_idea_stream_user_rates_slug();
$this->user_comments_slug = wp_idea_stream_user_comments_slug();
$this->cpage_slug = wp_idea_stream_cpage_slug();
$this->action_slug = wp_idea_stream_action_slug();
}
/**
* Gets the url to the form to submit new ideas
*
* So far only adding new ideas is supported, but
* there will surely be an edit action to allow users
* to edit their ideas. Reason of the $type param
*
* @package WP Idea Stream
* @subpackage core/functions
*
* @since 2.0.0
*
* @global $wp_rewrite
* @param string $type action (defaults to new)
* @param string $idea_name the post name of the idea to edit
* @uses wp_idea_stream_addnew_slug() can be customized through plugin's settings
* @uses apply_filters() call 'wp_idea_stream_pre_get_form_url' to customize the form url before it has been built
* @uses wp_idea_stream_action_slug()
* @uses wp_idea_stream_action_rewrite_id()
* @uses home_url()
* @uses user_trailingslashit()
* @uses wp_idea_stream_edit_slug() to get the edit slug
* @uses apply_filters() call 'wp_idea_stream_get_form_url' to customize the form url after it has been built
* @return string the url of the form to add ideas
*/
function wp_idea_stream_get_form_url($type = '', $idea_name = '')
{
global $wp_rewrite;
if (empty($type)) {
$type = wp_idea_stream_addnew_slug();
}
/**
* Early filter to override form url before being built
*
* @param mixed false or url to override
* @param string $type (only add new for now)
*/
$early_form_url = apply_filters('wp_idea_stream_pre_get_form_url', false, $type, $idea_name);
if (!empty($early_form_url)) {
return $early_form_url;
}
// Pretty permalinks
if ($wp_rewrite->using_permalinks()) {
$url = $wp_rewrite->root . wp_idea_stream_action_slug() . '/%' . wp_idea_stream_action_rewrite_id() . '%';
$url = str_replace('%' . wp_idea_stream_action_rewrite_id() . '%', $type, $url);
$url = home_url(user_trailingslashit($url));
// Unpretty permalinks
} else {
$url = add_query_arg(array(wp_idea_stream_action_rewrite_id() => $type), home_url('/'));
}
if ($type == wp_idea_stream_edit_slug() && !empty($idea_name)) {
$url = add_query_arg(wp_idea_stream_get_post_type(), $idea_name, $url);
}
/**
* Filter to override form url after being built
*
* @param string url to override
* @param string $type add new or edit
* @param string $idea_name the post name of the idea to edit
*/
return apply_filters('wp_idea_stream_get_form_url', $url, $type, $idea_name);
}
/**
* Gets the signup url
*
* @package WP Idea Stream
* @subpackage users/functions
*
* @since 2.1.0
*
* @global $wp_rewrite
* @return string signup url
*/
function wp_idea_stream_users_get_signup_url()
{
global $wp_rewrite;
/**
* Early filter to override form url before being built
*
* @param mixed false or url to override
*/
$early_signup_url = apply_filters('wp_idea_stream_users_pre_get_signup_url', false);
if (!empty($early_signup_url)) {
return $early_signup_url;
}
// Pretty permalinks
if ($wp_rewrite->using_permalinks()) {
$signup_url = $wp_rewrite->root . wp_idea_stream_action_slug() . '/%' . wp_idea_stream_action_rewrite_id() . '%';
$signup_url = str_replace('%' . wp_idea_stream_action_rewrite_id() . '%', wp_idea_stream_signup_slug(), $signup_url);
$signup_url = home_url(user_trailingslashit($signup_url));
// Unpretty permalinks
} else {
$signup_url = add_query_arg(array(wp_idea_stream_action_rewrite_id() => wp_idea_stream_signup_slug()), home_url('/'));
}
/**
* Filter to override form url after being built
*
* @param string url to override
*/
return apply_filters('wp_idea_stream_get_form_url', $signup_url);
}
