version; } /** * Output the bbPress database version * * @since bbPress (r3468) * @uses bbp_get_version() To get the bbPress version */ function bbp_db_version() { echo bbp_get_db_version(); } /** * Return the bbPress database version * * @since bbPress (r3468) * @global bbPress $bbp * @retrun string The bbPress version */ function bbp_get_db_version() { global $bbp; return $bbp->db_version; } /** Post Meta *****************************************************************/ /** * Update a posts forum meta ID * * @since bbPress (r3181) * * @param int $post_id The post to update * @param int $forum_id The forum */ function bbp_update_forum_id( $post_id, $forum_id ) { // Allow the forum ID to be updated 'just in time' before save $forum_id = apply_filters( 'bbp_update_forum_id', $forum_id, $post_id ); // Update the post meta forum ID update_post_meta( $post_id, '_bbp_forum_id', (int) $forum_id ); } /** * Update a posts topic meta ID * * @since bbPress (r3181) * * @param int $post_id The post to update * @param int $forum_id The forum */ function bbp_update_topic_id( $post_id, $topic_id ) { // Allow the topic ID to be updated 'just in time' before save $topic_id = apply_filters( 'bbp_update_topic_id', $topic_id, $post_id ); // Update the post meta topic ID update_post_meta( $post_id, '_bbp_topic_id', (int) $topic_id ); } /** * Update a posts reply meta ID * * @since bbPress (r3181) * * @param int $post_id The post to update * @param int $forum_id The forum */ function bbp_update_reply_id( $post_id, $reply_id ) { // Allow the reply ID to be updated 'just in time' before save $reply_id = apply_filters( 'bbp_update_reply_id', $reply_id, $post_id ); // Update the post meta reply ID update_post_meta( $post_id, '_bbp_reply_id',(int) $reply_id ); } /** Formatting ****************************************************************/ /** * A bbPress specific method of formatting numeric values * * @since bbPress (r2486) * * @param string $number Number to format * @param string $decimals Optional. Display decimals * @uses apply_filters() Calls 'bbp_number_format' with the formatted values, * number and display decimals bool * @return string Formatted string */ function bbp_number_format( $number, $decimals = false ) { // If empty, set $number to '0' if ( empty( $number ) || !is_numeric( $number ) ) $number = '0'; return apply_filters( 'bbp_number_format', number_format( $number, $decimals ), $number, $decimals ); } /** * Convert time supplied from database query into specified date format. * * @since bbPress (r2455) * * @param int|object $post Optional. Default is global post object. A post_id or * post object * @param string $d Optional. Default is 'U'. Either 'G', 'U', or php date * format * @param bool $translate Optional. Default is false. Whether to translate the * result * @uses mysql2date() To convert the format * @uses apply_filters() Calls 'bbp_convert_date' with the time, date format * and translate bool * @return string Returns timestamp */ function bbp_convert_date( $time, $d = 'U', $translate = false ) { $time = mysql2date( $d, $time, $translate ); return apply_filters( 'bbp_convert_date', $time, $d, $translate ); } /** * Output formatted time to display human readable time difference. * * @since bbPress (r2544) * * @param $time Unix timestamp from which the difference begins. * @uses bbp_get_time_since() To get the formatted time */ function bbp_time_since( $time ) { echo bbp_get_time_since( $time ); } /** * Return formatted time to display human readable time difference. * * @since bbPress (r2544) * * @param $time Unix timestamp from which the difference begins. * @uses current_time() To get the current time in mysql format * @uses human_time_diff() To get the time differene in since format * @uses apply_filters() Calls 'bbp_get_time_since' with the time * difference and time * @return string Formatted time */ function bbp_get_time_since( $time ) { return apply_filters( 'bbp_get_time_since', human_time_diff( $time, current_time( 'timestamp' ) ), $time ); } /** * Formats the reason for editing the topic/reply. * * Does these things: * - Trimming * - Removing periods from the end of the string * - Trimming again * * @since bbPress (r2782) * * @param int $topic_id Optional. Topic id * @return string Status of topic */ function bbp_format_revision_reason( $reason = '' ) { $reason = (string) $reason; // Format reason for proper display if ( empty( $reason ) ) return $reason; // Trimming $reason = trim( $reason ); // We add our own full stop. while ( substr( $reason, -1 ) == '.' ) $reason = substr( $reason, 0, -1 ); // Trim again $reason = trim( $reason ); return $reason; } /** Misc **********************************************************************/ /** * The plugin version of bbPress comes with two topic display options: * - Traditional: Topics are included in the reply loop (default) * - New Style: Topics appear as "lead" posts, ahead of replies * * @since bbPress (r2954) * * @param $show_lead Optional. Default false * @return bool Yes if the topic appears as a lead, otherwise false */ function bbp_show_lead_topic( $show_lead = false ) { return apply_filters( 'bbp_show_lead_topic', (bool) $show_lead ); } /** * Append 'view=all' to query string if it's already there from referer * * @since bbPress (r3325) * * @param string $original_link Original Link to be modified * @param bool $force Override bbp_get_view_all() check * @uses current_user_can() To check if the current user can moderate * @uses add_query_arg() To add args to the url * @uses apply_filters() Calls 'bbp_add_view_all' with the link and original link * @return string The link with 'view=all' appended if necessary */ function bbp_add_view_all( $original_link = '', $force = false ) { // Are we appending the view=all vars? if ( bbp_get_view_all() || !empty( $force ) ) $link = add_query_arg( array( 'view' => 'all' ), $original_link ); else $link = $original_link; return apply_filters( 'bbp_add_view_all', $link, $original_link ); } /** * Remove 'view=all' from query string * * @since bbPress (r3325) * * @param string $original_link Original Link to be modified * @uses current_user_can() To check if the current user can moderate * @uses add_query_arg() To add args to the url * @uses apply_filters() Calls 'bbp_add_view_all' with the link and original link * @return string The link with 'view=all' appended if necessary */ function bbp_remove_view_all( $original_link = '' ) { // Are we appending the view=all vars? $link = remove_query_arg( 'view', $original_link ); return apply_filters( 'bbp_add_view_all', $link, $original_link ); } /** * If current user can and is vewing all topics/replies * * @since bbPress (r3325) * * @uses current_user_can() To check if the current user can moderate * @uses apply_filters() Calls 'bbp_get_view_all' with the link and original link * @return bool Whether current user can and is viewing all */ function bbp_get_view_all( $cap = 'moderate' ) { $retval = ( ( !empty( $_GET['view'] ) && ( 'all' == $_GET['view'] ) && current_user_can( $cap ) ) ); return apply_filters( 'bbp_get_view_all', (bool) $retval ); } /** * Assist pagination by returning correct page number * * @since bbPress (r2628) * * @uses get_query_var() To get the 'paged' value * @return int Current page number */ function bbp_get_paged() { global $wp_query; // Make sure to not paginate widget queries if ( !bbp_is_query_name( 'bbp_widget' ) ) { // Check the query var if ( get_query_var( 'paged' ) ) { $paged = get_query_var( 'paged' ); // Check query paged } elseif ( !empty( $wp_query->query['paged'] ) ) { $paged = $wp_query->query['paged']; } // Paged found if ( !empty( $paged ) ) { return (int) $paged; } } // Default to first page return 1; } /** * Fix post author id on post save * * When a logged in user changes the status of an anonymous reply or topic, or * edits it, the post_author field is set to the logged in user's id. This * function fixes that. * * @since bbPress (r2734) * * @param array $data Post data * @param array $postarr Original post array (includes post id) * @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 bbp_is_topic_anonymous() To check if the topic is by an anonymous user * @uses bbp_is_reply_anonymous() To check if the reply is by an anonymous user * @return array Data */ function bbp_fix_post_author( $data = array(), $postarr = array() ) { // Post is not being updated or the post_author is already 0, return if ( empty( $postarr['ID'] ) || empty( $data['post_author'] ) ) return $data; // Post is not a topic or reply, return if ( !in_array( $data['post_type'], array( bbp_get_topic_post_type(), bbp_get_reply_post_type() ) ) ) return $data; // Is the post by an anonymous user? if ( ( bbp_get_topic_post_type() == $data['post_type'] && !bbp_is_topic_anonymous( $postarr['ID'] ) ) || ( bbp_get_reply_post_type() == $data['post_type'] && !bbp_is_reply_anonymous( $postarr['ID'] ) ) ) return $data; // The post is being updated. It is a topic or a reply and is written by an anonymous user. // Set the post_author back to 0 $data['post_author'] = 0; return $data; } /** * Check the date against the _bbp_edit_lock setting. * * @since bbPress (r3133) * * @param string $post_date_gmt * * @uses get_option() Get the edit lock time * @uses current_time() Get the current time * @uses strtotime() Convert strings to time * @uses apply_filters() Allow output to be manipulated * * @return bool */ function bbp_past_edit_lock( $post_date_gmt ) { // Assume editing is allowed $retval = false; // Bail if empty date if ( ! empty( $post_date_gmt ) ) { // Period of time $lockable = '+' . get_option( '_bbp_edit_lock', '5' ) . ' minutes'; // Now $cur_time = current_time( 'timestamp', true ); // Add lockable time to post time $lock_time = strtotime( $lockable, strtotime( $post_date_gmt ) ); // Compare if ( $cur_time >= $lock_time ) { $retval = true; } } return apply_filters( 'bbp_past_edit_lock', (bool) $retval, $cur_time, $lock_time, $post_date_gmt ); } /** Statistics ****************************************************************/ /** * Get the forum statistics * * @since bbPress (r2769) * * @param mixed $args Optional. The function supports these arguments (all * default to true): * - count_users: Count users? * - count_forums: Count forums? * - count_topics: Count topics? If set to false, private, spammed and trashed * topics are also not counted. * - count_private_topics: Count private topics? (only counted if the current * user has read_private_topics cap) * - count_spammed_topics: Count spammed topics? (only counted if the current * user has edit_others_topics cap) * - count_trashed_topics: Count trashed topics? (only counted if the current * user has view_trash cap) * - count_replies: Count replies? If set to false, private, spammed and * trashed replies are also not counted. * - count_private_replies: Count private replies? (only counted if the current * user has read_private_replies cap) * - count_spammed_replies: Count spammed replies? (only counted if the current * user has edit_others_replies cap) * - count_trashed_replies: Count trashed replies? (only counted if the current * user has view_trash cap) * - count_tags: Count tags? If set to false, empty tags are also not counted * - count_empty_tags: Count empty tags? * @uses bbp_count_users() To count the number of registered users * @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 wp_count_posts() To count the number of forums, topics and replies * @uses wp_count_terms() To count the number of topic tags * @uses current_user_can() To check if the user is capable of doing things * @uses number_format_i18n() To format the number * @uses apply_filters() Calls 'bbp_get_statistics' with the statistics and args * @return object Walked forum tree */ function bbp_get_statistics( $args = '' ) { $defaults = array ( 'count_users' => true, 'count_forums' => true, 'count_topics' => true, 'count_private_topics' => true, 'count_spammed_topics' => true, 'count_trashed_topics' => true, 'count_replies' => true, 'count_private_replies' => true, 'count_spammed_replies' => true, 'count_trashed_replies' => true, 'count_tags' => true, 'count_empty_tags' => true ); $r = wp_parse_args( $args, $defaults ); extract( $r ); // Users if ( !empty( $count_users ) ) $user_count = bbp_get_total_users(); // Forums if ( !empty( $count_forums ) ) { $forum_count = wp_count_posts( bbp_get_forum_post_type() ); $forum_count = $forum_count->publish; } // Post statuses $private = bbp_get_private_status_id(); $spam = bbp_get_spam_status_id(); $trash = bbp_get_trash_status_id(); $closed = bbp_get_closed_status_id(); // Topics if ( !empty( $count_topics ) ) { $all_topics = wp_count_posts( bbp_get_topic_post_type() ); // Published (publish + closed) $topic_count = $all_topics->publish + $all_topics->{$closed}; if ( current_user_can( 'read_private_topics' ) || current_user_can( 'edit_others_topics' ) || current_user_can( 'view_trash' ) ) { // Private $topics['private'] = ( !empty( $count_private_topics ) && current_user_can( 'read_private_topics' ) ) ? (int) $all_topics->{$private} : 0; // Spam $topics['spammed'] = ( !empty( $count_spammed_topics ) && current_user_can( 'edit_others_topics' ) ) ? (int) $all_topics->{$spam} : 0; // Trash $topics['trashed'] = ( !empty( $count_trashed_topics ) && current_user_can( 'view_trash' ) ) ? (int) $all_topics->{$trash} : 0; // Total hidden (private + spam + trash) $topic_count_hidden = $topics['private'] + $topics['spammed'] + $topics['trashed']; // Generate the hidden topic count's title attribute $topic_titles[] = !empty( $topics['private'] ) ? sprintf( __( 'Private: %s', 'bbpress' ), number_format_i18n( $topics['private'] ) ) : ''; $topic_titles[] = !empty( $topics['spammed'] ) ? sprintf( __( 'Spammed: %s', 'bbpress' ), number_format_i18n( $topics['spammed'] ) ) : ''; $topic_titles[] = !empty( $topics['trashed'] ) ? sprintf( __( 'Trashed: %s', 'bbpress' ), number_format_i18n( $topics['trashed'] ) ) : ''; // Compile the hidden topic title $hidden_topic_title = implode( ' | ', array_filter( $topic_titles ) ); } } // Replies if ( !empty( $count_replies ) ) { $all_replies = wp_count_posts( bbp_get_reply_post_type() ); // Published $reply_count = $all_replies->publish; if ( current_user_can( 'read_private_replies' ) || current_user_can( 'edit_others_replies' ) || current_user_can( 'view_trash' ) ) { // Private $replies['private'] = ( !empty( $count_private_replies ) && current_user_can( 'read_private_replies' ) ) ? (int) $all_replies->{$private} : 0; // Spam $replies['spammed'] = ( !empty( $count_spammed_replies ) && current_user_can( 'edit_others_replies' ) ) ? (int) $all_replies->{$spam} : 0; // Trash $replies['trashed'] = ( !empty( $count_trashed_replies ) && current_user_can( 'view_trash' ) ) ? (int) $all_replies->{$trash} : 0; // Total hidden (private + spam + trash) $reply_count_hidden = $replies['private'] + $replies['spammed'] + $replies['trashed']; // Generate the hidden topic count's title attribute $reply_titles[] = !empty( $replies['private'] ) ? sprintf( __( 'Private: %s', 'bbpress' ), number_format_i18n( $replies['private'] ) ) : ''; $reply_titles[] = !empty( $replies['spammed'] ) ? sprintf( __( 'Spammed: %s', 'bbpress' ), number_format_i18n( $replies['spammed'] ) ) : ''; $reply_titles[] = !empty( $replies['trashed'] ) ? sprintf( __( 'Trashed: %s', 'bbpress' ), number_format_i18n( $replies['trashed'] ) ) : ''; // Compile the hidden replies title $hidden_reply_title = implode( ' | ', array_filter( $reply_titles ) ); } } // Topic Tags if ( !empty( $count_tags ) ) { // Get the count $topic_tag_count = wp_count_terms( bbp_get_topic_tag_tax_id(), array( 'hide_empty' => true ) ); // Empty tags if ( !empty( $count_empty_tags ) && current_user_can( 'edit_topic_tags' ) ) { $empty_topic_tag_count = wp_count_terms( bbp_get_topic_tag_tax_id() ) - $topic_tag_count; } } // Tally the tallies $statistics = compact( 'user_count', 'forum_count', 'topic_count', 'topic_count_hidden', 'reply_count', 'reply_count_hidden', 'topic_tag_count', 'empty_topic_tag_count' ); $statistics = array_map( 'absint', $statistics ); $statistics = array_map( 'number_format_i18n', $statistics ); // Add the hidden (topic/reply) count title attribute strings because we don't need to run the math functions on these (see above) if ( isset( $hidden_topic_title ) ) $statistics['hidden_topic_title'] = $hidden_topic_title; if ( isset( $hidden_reply_title ) ) $statistics['hidden_reply_title'] = $hidden_reply_title; return apply_filters( 'bbp_get_statistics', $statistics, $args ); } /** Views *********************************************************************/ /** * Get the registered views * * Does nothing much other than return the {@link $bbp->views} variable * * @since bbPress (r2789) * * @return array Views */ function bbp_get_views() { global $bbp; return $bbp->views; } /** * Register a bbPress view * * @todo Implement feeds - See {@link http://trac.bbpress.org/ticket/1422} * * @since bbPress (r2789) * * @param string $view View name * @param string $title View title * @param mixed $query_args {@link bbp_has_topics()} arguments. * @param bool $feed Have a feed for the view? Defaults to true. NOT IMPLEMENTED * @uses sanitize_title() To sanitize the view name * @uses esc_html() To sanitize the view title * @return array The just registered (but processed) view */ function bbp_register_view( $view, $title, $query_args = '', $feed = true ) { global $bbp; $view = sanitize_title( $view ); $title = esc_html( $title ); if ( empty( $view ) || empty( $title ) ) return false; $query_args = wp_parse_args( $query_args ); // Set exclude_stickies to true if it wasn't supplied if ( !isset( $query_args['show_stickies'] ) ) $query_args['show_stickies'] = false; $bbp->views[$view]['title'] = $title; $bbp->views[$view]['query'] = $query_args; $bbp->views[$view]['feed'] = $feed; return $bbp->views[$view]; } /** * Deregister a bbPress view * * @since bbPress (r2789) * * @param string $view View name * @uses sanitize_title() To sanitize the view name * @return bool False if the view doesn't exist, true on success */ function bbp_deregister_view( $view ) { global $bbp; $view = sanitize_title( $view ); if ( !isset( $bbp->views[$view] ) ) return false; unset( $bbp->views[$view] ); return true; } /** * Run the view's query * * @since bbPress (r2789) * * @param string $view Optional. View id * @param mixed $new_args New arguments. See {@link bbp_has_topics()} * @uses bbp_get_view_id() To get the view id * @uses bbp_get_view_query_args() To get the view query args * @uses sanitize_title() To sanitize the view name * @uses bbp_has_topics() To make the topics query * @return bool False if the view doesn't exist, otherwise if topics are there */ function bbp_view_query( $view = '', $new_args = '' ) { if ( !$view = bbp_get_view_id( $view ) ) return false; $query_args = bbp_get_view_query_args( $view ); if ( !empty( $new_args ) ) { $new_args = wp_parse_args( $new_args ); $query_args = array_merge( $query_args, $new_args ); } return bbp_has_topics( $query_args ); } /** * Run the view's query's arguments * * @since bbPress (r2789) * * @param string $view View name * @uses bbp_get_view_id() To get the view id * @uses sanitize_title() To sanitize the view name * @return array Query arguments */ function bbp_get_view_query_args( $view ) { global $bbp; $views = bbp_get_view_id( $view ); if ( empty( $views ) ) return false; return $bbp->views[$view]['query']; } /** New/edit topic/reply helpers **********************************************/ /** * Filter anonymous post data * * We use REMOTE_ADDR here directly. If you are behind a proxy, you should * ensure that it is properly set, such as in wp-config.php, for your * environment. See {@link http://core.trac.wordpress.org/ticket/9235} * * If there are any errors, those are directly added to {@link bbPress:errors} * * @since bbPress (r2734) * * @param mixed $args Optional. If no args are there, then $_POST values are * used. * @param bool $is_edit Optional. Is the topic/reply being edited? There are no * IP checks then. * @uses apply_filters() Calls 'bbp_pre_anonymous_post_author_name' with the * anonymous user name * @uses apply_filters() Calls 'bbp_pre_anonymous_post_author_email' with the * anonymous user email * @uses apply_filters() Calls 'bbp_pre_anonymous_post_author_ip' with the * anonymous user's ip address * @uses apply_filters() Calls 'bbp_pre_anonymous_post_author_website' with the * anonymous user website * @return bool|array False on errors, values in an array on success */ function bbp_filter_anonymous_post_data( $args = '', $is_edit = false ) { // Assign variables $defaults = array ( 'bbp_anonymous_name' => !empty( $_POST['bbp_anonymous_name'] ) ? $_POST['bbp_anonymous_name'] : false, 'bbp_anonymous_email' => !empty( $_POST['bbp_anonymous_email'] ) ? $_POST['bbp_anonymous_email'] : false, 'bbp_anonymous_website' => !empty( $_POST['bbp_anonymous_website'] ) ? $_POST['bbp_anonymous_website'] : false, ); $r = wp_parse_args( $args, $defaults ); extract( $r ); // Filter variables and add errors if necessary if ( !$bbp_anonymous_name = apply_filters( 'bbp_pre_anonymous_post_author_name', $bbp_anonymous_name ) ) bbp_add_error( 'bbp_anonymous_name', __( 'ERROR: Invalid author name submitted!', 'bbpress' ) ); if ( !$bbp_anonymous_email = apply_filters( 'bbp_pre_anonymous_post_author_email', $bbp_anonymous_email ) ) bbp_add_error( 'bbp_anonymous_email', __( 'ERROR: Invalid email address submitted!', 'bbpress' ) ); // Website is optional $bbp_anonymous_website = apply_filters( 'bbp_pre_anonymous_post_author_website', $bbp_anonymous_website ); if ( !bbp_has_errors() ) $retval = compact( 'bbp_anonymous_name', 'bbp_anonymous_email', 'bbp_anonymous_website' ); else $retval = false; // Finally, return sanitized data or false return apply_filters( 'bbp_filter_anonymous_post_data', $retval, $args ); } /** * Check for duplicate topics/replies * * Check to make sure that a user is not making a duplicate post * * @since bbPress (r2763) * * @param array $post_data Contains information about the comment * @uses current_user_can() To check if the current user can throttle * @uses get_meta_sql() To generate the meta sql for checking anonymous email * @uses apply_filters() Calls 'bbp_check_for_duplicate_query' with the * duplicate check query and post data * @uses wpdb::get_var() To execute our query and get the var back * @uses get_post_meta() To get the anonymous user email post meta * @uses do_action() Calls 'bbp_post_duplicate_trigger' with the post data when * it is found that it is a duplicate * @return bool True if it is not a duplicate, false if it is */ function bbp_check_for_duplicate( $post_data ) { // No duplicate checks for those who can throttle if ( current_user_can( 'throttle' ) ) return true; global $wpdb; extract( $post_data, EXTR_SKIP ); // Check for anonymous post if ( empty( $post_author ) && !empty( $anonymous_data['bbp_anonymous_email'] ) ) { // WP 3.2 if ( function_exists( 'get_meta_sql' ) ) $clauses = get_meta_sql( array( array( 'key' => '_bbp_anonymous_email', 'value' => $anonymous_data['bbp_anonymous_email'] ) ), 'post', $wpdb->posts, 'ID' ); // WP 3.1 elseif ( function_exists( '_get_meta_sql' ) ) $clauses = _get_meta_sql( array( array( 'key' => '_bbp_anonymous_email', 'value' => $anonymous_data['bbp_anonymous_email'] ) ), 'post', $wpdb->posts, 'ID' ); $join = $clauses['join']; $where = $clauses['where']; } else{ $join = $where = ''; } // Simple duplicate check // Expected slashed ($post_type, $post_parent, $post_author, $post_content, $anonymous_data) $status = bbp_get_trash_status_id(); $dupe = "SELECT ID FROM {$wpdb->posts} {$join} WHERE post_type = '{$post_type}' AND post_status != '{$status}' AND post_author = {$post_author} AND post_content = '{$post_content}' {$where}"; $dupe .= !empty( $post_parent ) ? " AND post_parent = '{$post_parent}'" : ''; $dupe .= " LIMIT 1"; $dupe = apply_filters( 'bbp_check_for_duplicate_query', $dupe, $post_data ); if ( $wpdb->get_var( $dupe ) ) { do_action( 'bbp_check_for_duplicate_trigger', $post_data ); return false; } return true; } /** * Check for flooding * * Check to make sure that a user is not making too many posts in a short amount * of time. * * @since bbPress (r2734) * * @param false|array $anonymous_data Optional - if it's an anonymous post. Do * not supply if supplying $author_id. * Should have key 'bbp_author_ip'. * Should be sanitized (see * {@link bbp_filter_anonymous_post_data()} * for sanitization) * @param int $author_id Optional. Supply if it's a post by a logged in user. * Do not supply if supplying $anonymous_data. * @uses get_option() To get the throttle time * @uses get_transient() To get the last posted transient of the ip * @uses get_user_meta() To get the last posted meta of the user * @uses current_user_can() To check if the current user can throttle * @return bool True if there is no flooding, true if there is */ function bbp_check_for_flood( $anonymous_data = false, $author_id = 0 ) { // Option disabled. No flood checks. if ( !$throttle_time = get_option( '_bbp_throttle_time' ) ) return true; if ( !empty( $anonymous_data ) && is_array( $anonymous_data ) ) { $last_posted = get_transient( '_bbp_' . bbp_current_author_ip() . '_last_posted' ); if ( !empty( $last_posted ) && time() < $last_posted + $throttle_time ) return false; } elseif ( !empty( $author_id ) ) { $author_id = (int) $author_id; $last_posted = get_user_meta( $author_id, '_bbp_last_posted', true ); if ( isset( $last_posted ) && time() < $last_posted + $throttle_time && !current_user_can( 'throttle' ) ) return false; } else { return false; } return true; } /** * Checks topics and replies against the discussion blacklist of blocked keys * * @since bbPress (r3446) * * @param array $anonymous_data Anonymous user data * @param int $author_id Topic or reply author ID * @param string $title The title of the content * @param string $content The content being posted * @uses is_super_admin() Allow super admins to bypass blacklist * @uses bbp_current_author_ip() To get current user IP address * @uses bbp_current_author_ua() To get current user agent * @return bool True if test is passed, false if fail */ function bbp_check_for_blacklist( $anonymous_data = false, $author_id = 0, $title = '', $content = '' ) { // Bail if super admin is author if ( is_super_admin( $author_id ) ) return true; // Define local variable $post = array(); /** Blacklist *************************************************************/ // Get the moderation keys $blacklist = trim( get_option( 'blacklist_keys' ) ); // Bail if blacklist is empty if ( empty( $blacklist ) ) return true; /** User Data *************************************************************/ // Map anonymous user data if ( !empty( $anonymous_data ) ) { $post['author'] = $anonymous_data['bbp_anonymous_name']; $post['email'] = $anonymous_data['bbp_anonymous_email']; $post['url'] = $anonymous_data['bbp_anonymous_website']; // Map current user data } elseif ( !empty( $author_id ) ) { // Get author data $user = get_userdata( $author_id ); // If data exists, map it if ( !empty( $user ) ) { $post['author'] = $user->display_name; $post['email'] = $user->user_email; $post['url'] = $user->user_url; } } // Current user IP and user agent $post['user_ip'] = bbp_current_author_ip(); $post['user_ua'] = bbp_current_author_ua(); // Post title and content $post['title'] = $title; $post['content'] = $content; /** Words *****************************************************************/ // Get words separated by new lines $words = explode( "\n", $blacklist ); // Loop through words foreach ( (array) $words as $word ) { // Trim the whitespace from the word $word = trim( $word ); // Skip empty lines if ( empty( $word ) ) { continue; } // Do some escaping magic so that '#' chars in the // spam words don't break things: $word = preg_quote( $word, '#' ); $pattern = "#$word#i"; // Loop through post data foreach( $post as $post_data ) { // Check each user data for current word if ( preg_match( $pattern, $post_data ) ) { // Post does not pass return false; } } } // Check passed successfully return true; } /** Subscriptions *************************************************************/ /** * Sends notification emails for new posts * * Gets new post's ID and check if there are subscribed users to that topic, and * if there are, send notifications * * @since bbPress (r2668) * * @param int $reply_id ID of the newly made reply * @uses bbp_is_subscriptions_active() To check if the subscriptions are active * @uses bbp_get_reply_id() To validate the reply ID * @uses bbp_get_reply() To get the reply * @uses bbp_get_reply_topic_id() To get the topic ID of the reply * @uses bbp_is_reply_published() To make sure the reply is published * @uses bbp_get_topic_id() To validate the topic ID * @uses bbp_get_topic() To get the reply's topic * @uses bbp_is_topic_published() To make sure the topic is published * @uses get_the_author_meta() To get the author's display name * @uses do_action() Calls 'bbp_pre_notify_subscribers' with the reply id and * topic id * @uses bbp_get_topic_subscribers() To get the topic subscribers * @uses apply_filters() Calls 'bbp_subscription_mail_message' with the * message, reply id, topic id and user id * @uses get_userdata() To get the user data * @uses wp_mail() To send the mail * @uses do_action() Calls 'bbp_post_notify_subscribers' with the reply id * and topic id * @return bool True on success, false on failure */ function bbp_notify_subscribers( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = false, $reply_author = 0 ) { global $wpdb; // Bail if subscriptions are turned off if ( !bbp_is_subscriptions_active() ) return false; /** Validation ************************************************************/ $reply_id = bbp_get_reply_id( $reply_id ); $topic_id = bbp_get_topic_id( $topic_id ); $forum_id = bbp_get_reply_id( $forum_id ); /** Reply *****************************************************************/ // Bail if reply is not published if ( !bbp_is_reply_published( $reply_id ) ) return false; /** Topic *****************************************************************/ // Bail if topic is not published if ( !bbp_is_topic_published( $topic_id ) ) return false; /** User ******************************************************************/ // Get subscribers and bail if empty $user_ids = bbp_get_topic_subscribers( $topic_id, true ); if ( empty( $user_ids ) ) return false; // Poster name $reply_author_name = bbp_get_reply_author_display_name( $reply_id ); /** Mail ******************************************************************/ do_action( 'bbp_pre_notify_subscribers', $reply_id, $topic_id, $user_ids ); // Loop through users foreach ( (array) $user_ids as $user_id ) { // Don't send notifications to the person who made the post if ( !empty( $reply_author ) && (int) $user_id == (int) $reply_author ) continue; // For plugins to filter messages per reply/topic/user $message = __( "%1\$s wrote:\n\n%2\$s\n\nPost Link: %3\$s\n\nYou are recieving this email because you subscribed to it. Login and visit the topic to unsubscribe from these emails.", 'bbpress' ); $message = apply_filters( 'bbp_subscription_mail_message', sprintf( $message, $reply_author_name, strip_tags( bbp_get_reply_content( $reply_id ) ), bbp_get_reply_url( $reply_id ) ), $reply_id, $topic_id, $user_id ); if ( empty( $message ) ) continue; // For plugins to filter titles per reply/topic/user $subject = apply_filters( 'bbp_subscription_mail_title', '[' . get_option( 'blogname' ) . '] ' . bbp_get_topic_title( $topic_id ), $reply_id, $topic_id, $user_id ); if ( empty( $subject ) ) continue; // Get user data of this user $user = get_userdata( $user_id ); // Send notification email wp_mail( $user->user_email, $subject, $message ); } do_action( 'bbp_post_notify_subscribers', $reply_id, $topic_id, $user_ids ); return true; } /** Login *********************************************************************/ /** * Return a clean and reliable logout URL * * @param string $url URL * @param string $redirect_to Where to redirect to? * @uses add_query_arg() To add args to the url * @uses apply_filters() Calls 'bbp_logout_url' with the url and redirect to * @return string The url */ function bbp_logout_url( $url = '', $redirect_to = '' ) { // Make sure we are directing somewhere if ( empty( $redirect_to ) && !strstr( $url, 'redirect_to' ) ) { // Rejig the $redirect_to if ( !isset( $_SERVER['REDIRECT_URL'] ) || ( $redirect_to != home_url( $_SERVER['REDIRECT_URL'] ) ) ) { $redirect_to = isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : ''; } $redirect_to = home_url( isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '' ); // Sanitize $redirect_to and add it to full $url $redirect_to = add_query_arg( array( 'loggedout' => 'true' ), esc_url( $redirect_to ) ); $url = add_query_arg( array( 'redirect_to' => urlencode( $redirect_to ) ), $url ); } // Filter and return return apply_filters( 'bbp_logout_url', $url, $redirect_to ); } /** Queries *******************************************************************/ /** * Adds ability to include or exclude specific post_parent ID's * * @since bbPress (r2996) * * @global DB $wpdb * @global WP $wp * @param string $where * @param WP_Query $object * @return string */ function bbp_query_post_parent__in( $where, $object = '' ) { global $wpdb, $wp; // Noop if WP core supports this already if ( in_array( 'post_parent__in', $wp->private_query_vars ) ) return $where; // Bail if no object passed if ( empty( $object ) ) return $where; // Only 1 post_parent so return $where if ( is_numeric( $object->query_vars['post_parent'] ) ) return $where; // Including specific post_parent's if ( ! empty( $object->query_vars['post_parent__in'] ) ) { $ids = implode( ',', array_map( 'absint', $object->query_vars['post_parent__in'][0] ) ); $where .= " AND $wpdb->posts.post_parent IN ($ids)"; // Excluding specific post_parent's } elseif ( ! empty( $object->query_vars['post_parent__not_in'] ) ) { $ids = implode( ',', array_map( 'absint', $object->query_vars['post_parent__not_in'][0] ) ); $where .= " AND $wpdb->posts.post_parent NOT IN ($ids)"; } // Return possibly modified $where return $where; } //add_filter( 'posts_where', 'bbp_query_post_parent__in', 10, 2 ); /** * Query the DB and get the last public post_id that has parent_id as post_parent * * @param int $parent_id Parent id * @param string $post_type Post type. Defaults to 'post' * @uses bbp_get_topic_post_type() To get the topic post type * @uses wp_cache_get() To check if there is a cache of the last child id * @uses wpdb::prepare() To prepare the query * @uses wpdb::get_var() To get the result of the query in a variable * @uses wp_cache_set() To set the cache for future use * @uses apply_filters() Calls 'bbp_get_public_child_last_id' with the child * id, parent id and post type * @return int The last active post_id */ function bbp_get_public_child_last_id( $parent_id = 0, $post_type = 'post' ) { global $wpdb; // Bail if nothing passed if ( empty( $parent_id ) ) return false; // The ID of the cached query $cache_id = 'bbp_parent_' . $parent_id . '_type_' . $post_type . '_child_last_id'; $post_status = array( bbp_get_public_status_id() ); // Add closed status if topic post type if ( $post_type == bbp_get_topic_post_type() ) $post_status[] = bbp_get_closed_status_id(); // Join post statuses together $post_status = "'" . join( "', '", $post_status ) . "'"; // Check for cache and set if needed if ( !$child_id = wp_cache_get( $cache_id, 'bbpress' ) ) { $child_id = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_parent = %d AND post_status IN ( {$post_status} ) AND post_type = '%s' ORDER BY ID DESC LIMIT 1;", $parent_id, $post_type ) ); wp_cache_set( $cache_id, $child_id, 'bbpress' ); } // Filter and return return apply_filters( 'bbp_get_public_child_last_id', (int) $child_id, (int) $parent_id, $post_type ); } /** * Query the DB and get a count of public children * * @param int $parent_id Parent id * @param string $post_type Post type. Defaults to 'post' * @uses bbp_get_topic_post_type() To get the topic post type * @uses wp_cache_get() To check if there is a cache of the children count * @uses wpdb::prepare() To prepare the query * @uses wpdb::get_var() To get the result of the query in a variable * @uses wp_cache_set() To set the cache for future use * @uses apply_filters() Calls 'bbp_get_public_child_count' with the child * count, parent id and post type * @return int The number of children */ function bbp_get_public_child_count( $parent_id = 0, $post_type = 'post' ) { global $wpdb; // Bail if nothing passed if ( empty( $parent_id ) ) return false; // The ID of the cached query $cache_id = 'bbp_parent_' . $parent_id . '_type_' . $post_type . '_child_count'; $post_status = array( bbp_get_public_status_id() ); // Add closed status if topic post type if ( $post_type == bbp_get_topic_post_type() ) $post_status[] = bbp_get_closed_status_id(); // Join post statuses together $post_status = "'" . join( "', '", $post_status ) . "'"; // Check for cache and set if needed if ( !$child_count = wp_cache_get( $cache_id, 'bbpress' ) ) { $child_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(ID) FROM {$wpdb->posts} WHERE post_parent = %d AND post_status IN ( {$post_status} ) AND post_type = '%s';", $parent_id, $post_type ) ); wp_cache_set( $cache_id, $child_count, 'bbpress' ); } // Filter and return return apply_filters( 'bbp_get_public_child_count', (int) $child_count, (int) $parent_id, $post_type ); } /** * Query the DB and get a the child id's of public children * * @param int $parent_id Parent id * @param string $post_type Post type. Defaults to 'post' * @uses bbp_get_topic_post_type() To get the topic post type * @uses wp_cache_get() To check if there is a cache of the children * @uses wpdb::prepare() To prepare the query * @uses wpdb::get_col() To get the result of the query in an array * @uses wp_cache_set() To set the cache for future use * @uses apply_filters() Calls 'bbp_get_public_child_ids' with the child ids, * parent id and post type * @return array The array of children */ function bbp_get_public_child_ids( $parent_id = 0, $post_type = 'post' ) { global $wpdb; // Bail if nothing passed if ( empty( $parent_id ) ) return false; // The ID of the cached query $cache_id = 'bbp_parent_public_' . $parent_id . '_type_' . $post_type . '_child_ids'; $post_status = array( bbp_get_public_status_id() ); // Add closed status if topic post type if ( $post_type == bbp_get_topic_post_type() ) $post_status[] = bbp_get_closed_status_id(); // Join post statuses together $post_status = "'" . join( "', '", $post_status ) . "'"; // Check for cache and set if needed if ( !$child_ids = wp_cache_get( $cache_id, 'bbpress' ) ) { $child_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_parent = %d AND post_status IN ( {$post_status} ) AND post_type = '%s' ORDER BY ID DESC;", $parent_id, $post_type ) ); wp_cache_set( $cache_id, $child_ids, 'bbpress' ); } // Filter and return return apply_filters( 'bbp_get_public_child_ids', $child_ids, (int) $parent_id, $post_type ); } /** * Query the DB and get a the child id's of all children * * @param int $parent_id Parent id * @param string $post_type Post type. Defaults to 'post' * @uses bbp_get_topic_post_type() To get the topic post type * @uses wp_cache_get() To check if there is a cache of the children * @uses wpdb::prepare() To prepare the query * @uses wpdb::get_col() To get the result of the query in an array * @uses wp_cache_set() To set the cache for future use * @uses apply_filters() Calls 'bbp_get_public_child_ids' with the child ids, * parent id and post type * @return array The array of children */ function bbp_get_all_child_ids( $parent_id = 0, $post_type = 'post' ) { global $wpdb; // Bail if nothing passed if ( empty( $parent_id ) ) return false; // The ID of the cached query $cache_id = 'bbp_parent_all_' . $parent_id . '_type_' . $post_type . '_child_ids'; $post_status = array( bbp_get_public_status_id() ); // Extra post statuses based on post type switch ( $post_type ) { // Forum case bbp_get_forum_post_type() : $post_status[] = bbp_get_private_status_id(); $post_status[] = bbp_get_hidden_status_id(); break; // Topic case bbp_get_topic_post_type() : $post_status[] = bbp_get_closed_status_id(); $post_status[] = bbp_get_trash_status_id(); $post_status[] = bbp_get_spam_status_id(); break; // Reply case bbp_get_reply_post_type() : $post_status[] = bbp_get_trash_status_id(); $post_status[] = bbp_get_spam_status_id(); break; } // Join post statuses together $post_status = "'" . join( "', '", $post_status ) . "'"; // Check for cache and set if needed if ( !$child_ids = wp_cache_get( $cache_id, 'bbpress' ) ) { $child_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_parent = %d AND post_status IN ( {$post_status} ) AND post_type = '%s' ORDER BY ID DESC;", $parent_id, $post_type ) ); wp_cache_set( $cache_id, $child_ids, 'bbpress' ); } // Filter and return return apply_filters( 'bbp_get_all_child_ids', $child_ids, (int) $parent_id, $post_type ); } /** Feeds *********************************************************************/ /** * This function is hooked into the WordPress 'request' action and is * responsible for sniffing out the query vars and serving up RSS2 feeds if * the stars align and the user has requested a feed of any bbPress type. * * @since bbPress (r3171) * * @global WP_Query $wp_query * @param array $query_vars * @return array */ function bbp_request_feed_trap( $query_vars ) { global $wp_query; // Looking at a feed if ( isset( $query_vars['feed'] ) ) { // Forum Feed if ( isset( $query_vars['post_type'] ) ) { // What bbPress post type are we looking for feeds on? switch ( $query_vars['post_type'] ) { // Forum case bbp_get_forum_post_type() : // Declare local variable(s) $meta_query = array(); // Single forum if ( isset( $query_vars[bbp_get_forum_post_type()] ) ) { // Get the forum by the path $forum = get_page_by_path( $query_vars[bbp_get_forum_post_type()], OBJECT, bbp_get_forum_post_type() ); $forum_id = $forum->ID; // Load up our own query $wp_query = new WP_Query( array( 'post_type' => bbp_get_forum_post_type(), 'ID' => $forum_id ) ); // Restrict to specific forum ID $meta_query = array( array( 'key' => '_bbp_forum_id', 'value' => $forum_id, 'compare' => '=' ) ); } // Only forum replies if ( !empty( $_GET['type'] ) && ( bbp_get_reply_post_type() == $_GET['type'] ) ) { // The query $the_query = array( 'author' => 0, 'post_type' => bbp_get_reply_post_type(), 'post_parent' => 'any', 'post_status' => join( ',', array( bbp_get_public_status_id(), bbp_get_closed_status_id() ) ), 'posts_per_page' => bbp_get_replies_per_rss_page(), 'order' => 'DESC', 'meta_query' => $meta_query ); // Output the feed bbp_display_replies_feed_rss2( $the_query ); // Only forum topics } elseif ( !empty( $_GET['type'] ) && ( bbp_get_topic_post_type() == $_GET['type'] ) ) { // The query $the_query = array( 'author' => 0, 'post_type' => bbp_get_topic_post_type(), 'post_parent' => 'any', 'post_status' => join( ',', array( bbp_get_public_status_id(), bbp_get_closed_status_id() ) ), 'posts_per_page' => bbp_get_topics_per_rss_page(), 'order' => 'DESC', 'meta_query' => $meta_query ); // Output the feed bbp_display_topics_feed_rss2( $the_query ); // All forum topics and replies } else { // The query $the_query = array( 'author' => 0, 'post_type' => array( bbp_get_reply_post_type(), bbp_get_topic_post_type() ), 'post_parent' => 'any', 'post_status' => join( ',', array( bbp_get_public_status_id(), bbp_get_closed_status_id() ) ), 'posts_per_page' => bbp_get_replies_per_rss_page(), 'order' => 'DESC', 'meta_query' => $meta_query ); // Output the feed bbp_display_replies_feed_rss2( $the_query ); } break; // Topic feed - Show replies case bbp_get_topic_post_type() : // Single topic if ( isset( $query_vars[bbp_get_topic_post_type()] ) ) { // Load up our own query $wp_query = new WP_Query( array( 'post_type' => bbp_get_topic_post_type(), 'name' => $query_vars[bbp_get_topic_post_type()] ) ); // Output the feed bbp_display_replies_feed_rss2(); // All topics } else { // The query $the_query = array( 'author' => 0, 'post_parent' => 'any', 'posts_per_page' => bbp_get_topics_per_rss_page(), 'show_stickies' => false, ); // Output the feed bbp_display_topics_feed_rss2( $the_query ); } break; // Replies case bbp_get_reply_post_type() : // The query $the_query = array( 'posts_per_page' => bbp_get_replies_per_rss_page(), 'meta_query' => array( array( ) ) ); // All replies if ( !isset( $query_vars[bbp_get_reply_post_type()] ) ) { bbp_display_replies_feed_rss2( $the_query ); } break; } } } // No feed so continue on return $query_vars; } /** Errors ********************************************************************/ /** * Adds an error message to later be output in the theme * * @since bbPress (r3381) * * @global bbPress $bbp * * @see WP_Error() * @uses WP_Error::add(); * * @param string $code Unique code for the error message * @param string $message Translated error message * @param string $data Any additional data passed with the error message */ function bbp_add_error( $code = '', $message = '', $data = '' ) { global $bbp; $bbp->errors->add( $code, $message, $data ); } /** * Check if error messages exist in queue * * @since bbPress (r3381) * * @global bbPress $bbp * * @see WP_Error() * * @uses is_wp_error() * @usese WP_Error::get_error_codes() */ function bbp_has_errors() { global $bbp; // Assume no errors $has_errors = false; // Check for errors if ( $bbp->errors->get_error_codes() ) $has_errors = true; // Filter return value $has_errors = apply_filters( 'bbp_has_errors', $has_errors, $bbp->errors ); return $has_errors; } /** Post Statuses *************************************************************/ /** * Return the public post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_public_status_id() { global $bbp; return $bbp->public_status_id; } /** * Return the private post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_private_status_id() { global $bbp; return $bbp->private_status_id; } /** * Return the hidden post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_hidden_status_id() { global $bbp; return $bbp->hidden_status_id; } /** * Return the closed post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_closed_status_id() { global $bbp; return $bbp->closed_status_id; } /** * Return the spam post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_spam_status_id() { global $bbp; return $bbp->spam_status_id; } /** * Return the trash post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_trash_status_id() { global $bbp; return $bbp->trash_status_id; } /** * Return the orphan post status ID * * @since bbPress (r3504) * * @global bbPress $bbp * @return string */ function bbp_get_orphan_status_id() { global $bbp; return $bbp->orphan_status_id; } ?>