Current File : /var/www/html/itworks/wp-content/plugins/bbpress/includes/forums/template.php
<?php
/**
* bbPress Forum Template Tags
*
* @package bbPress
* @subpackage TemplateTags
*/
// Exit if accessed directly
if ( !defined( 'ABSPATH' ) ) exit;
/** Post Type *****************************************************************/
/**
* Output the unique id of the custom post type for forums
*
* @since bbPress (r2857)
* @uses bbp_get_forum_post_type() To get the forum post type
*/
function bbp_forum_post_type() {
echo bbp_get_forum_post_type();
}
/**
* Return the unique id of the custom post type for forums
*
* @since bbPress (r2857)
*
* @uses apply_filters() Calls 'bbp_get_forum_post_type' with the forum
* post type id
* @return string The unique forum post type id
*/
function bbp_get_forum_post_type() {
return apply_filters( 'bbp_get_forum_post_type', bbpress()->forum_post_type );
}
/**
* Return array of labels used by the forum post type
*
* @since bbPress (r5129)
*
* @return array
*/
function bbp_get_forum_post_type_labels() {
return apply_filters( 'bbp_get_forum_post_type_labels', array(
'name' => __( 'Forums', 'bbpress' ),
'menu_name' => __( 'Forums', 'bbpress' ),
'singular_name' => __( 'Forum', 'bbpress' ),
'all_items' => __( 'All Forums', 'bbpress' ),
'add_new' => __( 'New Forum', 'bbpress' ),
'add_new_item' => __( 'Create New Forum', 'bbpress' ),
'edit' => __( 'Edit', 'bbpress' ),
'edit_item' => __( 'Edit Forum', 'bbpress' ),
'new_item' => __( 'New Forum', 'bbpress' ),
'view' => __( 'View Forum', 'bbpress' ),
'view_item' => __( 'View Forum', 'bbpress' ),
'search_items' => __( 'Search Forums', 'bbpress' ),
'not_found' => __( 'No forums found', 'bbpress' ),
'not_found_in_trash' => __( 'No forums found in Trash', 'bbpress' ),
'parent_item_colon' => __( 'Parent Forum:', 'bbpress' )
) );
}
/**
* Return array of forum post type rewrite settings
*
* @since bbPress (r5129)
*
* @return array
*/
function bbp_get_forum_post_type_rewrite() {
return apply_filters( 'bbp_get_forum_post_type_rewrite', array(
'slug' => bbp_get_forum_slug(),
'with_front' => false
) );
}
/**
* Return array of features the forum post type supports
*
* @since bbPress (r5129)
*
* @return array
*/
function bbp_get_forum_post_type_supports() {
return apply_filters( 'bbp_get_forum_post_type_supports', array(
'title',
'editor',
'revisions'
) );
}
/** Forum Loop ****************************************************************/
/**
* The main forum loop.
*
* WordPress makes this easy for us.
*
* @since bbPress (r2464)
*
* @param mixed $args All the arguments supported by {@link WP_Query}
* @uses WP_Query To make query and get the forums
* @uses bbp_get_forum_post_type() To get the forum post type id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_option() To get the forums per page option
* @uses current_user_can() To check if the current user is capable of editing
* others' forums
* @uses apply_filters() Calls 'bbp_has_forums' with
* bbPres::forum_query::have_posts()
* and bbPres::forum_query
* @return object Multidimensional array of forum information
*/
function bbp_has_forums( $args = '' ) {
// Forum archive only shows root
if ( bbp_is_forum_archive() ) {
$default_post_parent = 0;
// User subscriptions shows any
} elseif ( bbp_is_subscriptions() ) {
$default_post_parent = 'any';
// Could be anything, so look for possible parent ID
} else {
$default_post_parent = bbp_get_forum_id();
}
// Parse arguments with default forum query for most circumstances
$bbp_f = bbp_parse_args( $args, array(
'post_type' => bbp_get_forum_post_type(),
'post_parent' => $default_post_parent,
'post_status' => bbp_get_public_status_id(),
'posts_per_page' => get_option( '_bbp_forums_per_page', 50 ),
'ignore_sticky_posts' => true,
'orderby' => 'menu_order title',
'order' => 'ASC'
), 'has_forums' );
// Run the query
$bbp = bbpress();
$bbp->forum_query = new WP_Query( $bbp_f );
return apply_filters( 'bbp_has_forums', $bbp->forum_query->have_posts(), $bbp->forum_query );
}
/**
* Whether there are more forums available in the loop
*
* @since bbPress (r2464)
*
* @uses bbPress:forum_query::have_posts() To check if there are more forums
* available
* @return object Forum information
*/
function bbp_forums() {
// Put into variable to check against next
$have_posts = bbpress()->forum_query->have_posts();
// Reset the post data when finished
if ( empty( $have_posts ) )
wp_reset_postdata();
return $have_posts;
}
/**
* Loads up the current forum in the loop
*
* @since bbPress (r2464)
*
* @uses bbPress:forum_query::the_post() To get the current forum
* @return object Forum information
*/
function bbp_the_forum() {
return bbpress()->forum_query->the_post();
}
/** Forum *********************************************************************/
/**
* Output forum id
*
* @since bbPress (r2464)
*
* @param $forum_id Optional. Used to check emptiness
* @uses bbp_get_forum_id() To get the forum id
*/
function bbp_forum_id( $forum_id = 0 ) {
echo bbp_get_forum_id( $forum_id );
}
/**
* Return the forum id
*
* @since bbPress (r2464)
*
* @param $forum_id Optional. Used to check emptiness
* @uses bbPress::forum_query::in_the_loop To check if we're in the loop
* @uses bbPress::forum_query::post::ID To get the forum id
* @uses WP_Query::post::ID To get the forum id
* @uses bbp_is_forum() To check if the search result is a forum
* @uses bbp_is_single_forum() To check if it's a forum page
* @uses bbp_is_single_topic() To check if it's a topic page
* @uses bbp_get_topic_forum_id() To get the topic forum id
* @uses get_post_field() To get the post's post type
* @uses apply_filters() Calls 'bbp_get_forum_id' with the forum id and
* supplied forum id
* @return int The forum id
*/
function bbp_get_forum_id( $forum_id = 0 ) {
global $wp_query;
$bbp = bbpress();
// Easy empty checking
if ( !empty( $forum_id ) && is_numeric( $forum_id ) ) {
$bbp_forum_id = $forum_id;
// Currently inside a forum loop
} elseif ( !empty( $bbp->forum_query->in_the_loop ) && isset( $bbp->forum_query->post->ID ) ) {
$bbp_forum_id = $bbp->forum_query->post->ID;
// Currently inside a search loop
} elseif ( !empty( $bbp->search_query->in_the_loop ) && isset( $bbp->search_query->post->ID ) && bbp_is_forum( $bbp->search_query->post->ID ) ) {
$bbp_forum_id = $bbp->search_query->post->ID;
// Currently viewing a forum
} elseif ( ( bbp_is_single_forum() || bbp_is_forum_edit() ) && !empty( $bbp->current_forum_id ) ) {
$bbp_forum_id = $bbp->current_forum_id;
// Currently viewing a forum
} elseif ( ( bbp_is_single_forum() || bbp_is_forum_edit() ) && isset( $wp_query->post->ID ) ) {
$bbp_forum_id = $wp_query->post->ID;
// Currently viewing a topic
} elseif ( bbp_is_single_topic() ) {
$bbp_forum_id = bbp_get_topic_forum_id();
// Fallback
} else {
$bbp_forum_id = 0;
}
return (int) apply_filters( 'bbp_get_forum_id', (int) $bbp_forum_id, $forum_id );
}
/**
* Gets a forum
*
* @since bbPress (r2787)
*
* @param int|object $forum forum id or forum object
* @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT
* @param string $filter Optional Sanitation filter. See {@link sanitize_post()}
* @uses get_post() To get the forum
* @uses apply_filters() Calls 'bbp_get_forum' with the forum, output type and
* sanitation filter
* @return mixed Null if error or forum (in specified form) if success
*/
function bbp_get_forum( $forum, $output = OBJECT, $filter = 'raw' ) {
// Use forum ID
if ( empty( $forum ) || is_numeric( $forum ) )
$forum = bbp_get_forum_id( $forum );
// Attempt to load the forum
$forum = get_post( $forum, OBJECT, $filter );
if ( empty( $forum ) )
return $forum;
// Bail if post_type is not a forum
if ( $forum->post_type !== bbp_get_forum_post_type() )
return null;
// Tweak the data type to return
if ( $output === OBJECT ) {
return $forum;
} elseif ( $output === ARRAY_A ) {
$_forum = get_object_vars( $forum );
return $_forum;
} elseif ( $output === ARRAY_N ) {
$_forum = array_values( get_object_vars( $forum ) );
return $_forum;
}
return apply_filters( 'bbp_get_forum', $forum, $output, $filter );
}
/**
* Output the link to the forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_permalink() To get the permalink
*/
function bbp_forum_permalink( $forum_id = 0 ) {
echo esc_url( bbp_get_forum_permalink( $forum_id ) );
}
/**
* Return the link to the forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @param $string $redirect_to Optional. Pass a redirect value for use with
* shortcodes and other fun things.
* @uses bbp_get_forum_id() To get the forum id
* @uses get_permalink() Get the permalink of the forum
* @uses apply_filters() Calls 'bbp_get_forum_permalink' with the forum
* link
* @return string Permanent link to forum
*/
function bbp_get_forum_permalink( $forum_id = 0, $redirect_to = '' ) {
$forum_id = bbp_get_forum_id( $forum_id );
// Use the redirect address
if ( !empty( $redirect_to ) ) {
$forum_permalink = esc_url_raw( $redirect_to );
// Use the topic permalink
} else {
$forum_permalink = get_permalink( $forum_id );
}
return apply_filters( 'bbp_get_forum_permalink', $forum_permalink, $forum_id );
}
/**
* Output the title of the forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_title() To get the forum title
*/
function bbp_forum_title( $forum_id = 0 ) {
echo bbp_get_forum_title( $forum_id );
}
/**
* Return the title of the forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_the_title() To get the forum title
* @uses apply_filters() Calls 'bbp_get_forum_title' with the title
* @return string Title of forum
*/
function bbp_get_forum_title( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$title = get_the_title( $forum_id );
return apply_filters( 'bbp_get_forum_title', $title, $forum_id );
}
/**
* Output the forum archive title
*
* @since bbPress (r3249)
*
* @param string $title Default text to use as title
*/
function bbp_forum_archive_title( $title = '' ) {
echo bbp_get_forum_archive_title( $title );
}
/**
* Return the forum archive title
*
* @since bbPress (r3249)
*
* @param string $title Default text to use as title
*
* @uses bbp_get_page_by_path() Check if page exists at root path
* @uses get_the_title() Use the page title at the root path
* @uses get_post_type_object() Load the post type object
* @uses bbp_get_forum_post_type() Get the forum post type ID
* @uses get_post_type_labels() Get labels for forum post type
* @uses apply_filters() Allow output to be manipulated
*
* @return string The forum archive title
*/
function bbp_get_forum_archive_title( $title = '' ) {
// If no title was passed
if ( empty( $title ) ) {
// Set root text to page title
$page = bbp_get_page_by_path( bbp_get_root_slug() );
if ( !empty( $page ) ) {
$title = get_the_title( $page->ID );
// Default to forum post type name label
} else {
$fto = get_post_type_object( bbp_get_forum_post_type() );
$title = $fto->labels->name;
}
}
return apply_filters( 'bbp_get_forum_archive_title', $title );
}
/**
* Output the content of the forum
*
* @since bbPress (r2780)
*
* @param int $forum_id Optional. Topic id
* @uses bbp_get_forum_content() To get the forum content
*/
function bbp_forum_content( $forum_id = 0 ) {
echo bbp_get_forum_content( $forum_id );
}
/**
* Return the content of the forum
*
* @since bbPress (r2780)
*
* @param int $forum_id Optional. Topic id
* @uses bbp_get_forum_id() To get the forum id
* @uses post_password_required() To check if the forum requires pass
* @uses get_the_password_form() To get the password form
* @uses get_post_field() To get the content post field
* @uses apply_filters() Calls 'bbp_get_forum_content' with the content
* and forum id
* @return string Content of the forum
*/
function bbp_get_forum_content( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
// Check if password is required
if ( post_password_required( $forum_id ) )
return get_the_password_form();
$content = get_post_field( 'post_content', $forum_id );
return apply_filters( 'bbp_get_forum_content', $content, $forum_id );
}
/**
* Allow forum rows to have adminstrative actions
*
* @since bbPress (r3653)
* @uses do_action()
* @todo Links and filter
*/
function bbp_forum_row_actions() {
do_action( 'bbp_forum_row_actions' );
}
/**
* Output the forums last active ID
*
* @since bbPress (r2860)
*
* @uses bbp_get_forum_last_active_id() To get the forum's last active id
* @param int $forum_id Optional. Forum id
*/
function bbp_forum_last_active_id( $forum_id = 0 ) {
echo bbp_get_forum_last_active_id( $forum_id );
}
/**
* Return the forums last active ID
*
* @since bbPress (r2860)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the forum's last active id
* @uses apply_filters() Calls 'bbp_get_forum_last_active_id' with
* the last active id and forum id
* @return int Forum's last active id
*/
function bbp_get_forum_last_active_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$active_id = get_post_meta( $forum_id, '_bbp_last_active_id', true );
return (int) apply_filters( 'bbp_get_forum_last_active_id', (int) $active_id, $forum_id );
}
/**
* Output the forums last update date/time (aka freshness)
*
* @since bbPress (r2464)
*
* @uses bbp_get_forum_last_active_time() To get the forum freshness
* @param int $forum_id Optional. Forum id
*/
function bbp_forum_last_active_time( $forum_id = 0 ) {
echo bbp_get_forum_last_active_time( $forum_id );
}
/**
* Return the forums last update date/time (aka freshness)
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To retrieve forum last active meta
* @uses bbp_get_forum_last_reply_id() To get forum's last reply id
* @uses get_post_field() To get the post date of the reply
* @uses bbp_get_forum_last_topic_id() To get forum's last topic id
* @uses bbp_get_topic_last_active_time() To get time when the topic was
* last active
* @uses bbp_convert_date() To convert the date
* @uses bbp_get_time_since() To get time in since format
* @uses apply_filters() Calls 'bbp_get_forum_last_active' with last
* active time and forum id
* @return string Forum last update date/time (freshness)
*/
function bbp_get_forum_last_active_time( $forum_id = 0 ) {
// Verify forum and get last active meta
$forum_id = bbp_get_forum_id( $forum_id );
$last_active = get_post_meta( $forum_id, '_bbp_last_active_time', true );
if ( empty( $last_active ) ) {
$reply_id = bbp_get_forum_last_reply_id( $forum_id );
if ( !empty( $reply_id ) ) {
$last_active = get_post_field( 'post_date', $reply_id );
} else {
$topic_id = bbp_get_forum_last_topic_id( $forum_id );
if ( !empty( $topic_id ) ) {
$last_active = bbp_get_topic_last_active_time( $topic_id );
}
}
}
$active_time = !empty( $last_active ) ? bbp_get_time_since( bbp_convert_date( $last_active ) ) : '';
return apply_filters( 'bbp_get_forum_last_active', $active_time, $forum_id );
}
/**
* Output link to the most recent activity inside a forum.
*
* Outputs a complete link with attributes and content.
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_freshness_link() To get the forum freshness link
*/
function bbp_forum_freshness_link( $forum_id = 0) {
echo bbp_get_forum_freshness_link( $forum_id );
}
/**
* Returns link to the most recent activity inside a forum.
*
* Returns a complete link with attributes and content.
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_active_id() To get the forum last active id
* @uses bbp_get_forum_last_reply_id() To get the forum last reply id
* @uses bbp_get_forum_last_topic_id() To get the forum last topic id
* @uses bbp_get_forum_last_reply_url() To get the forum last reply url
* @uses bbp_get_forum_last_reply_title() To get the forum last reply
* title
* @uses bbp_get_forum_last_topic_permalink() To get the forum last
* topic permalink
* @uses bbp_get_forum_last_topic_title() To get the forum last topic
* title
* @uses bbp_get_forum_last_active_time() To get the time when the forum
* was last active
* @uses apply_filters() Calls 'bbp_get_forum_freshness_link' with the
* link and forum id
*/
function bbp_get_forum_freshness_link( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$active_id = bbp_get_forum_last_active_id( $forum_id );
$link_url = $title = '';
if ( empty( $active_id ) )
$active_id = bbp_get_forum_last_reply_id( $forum_id );
if ( empty( $active_id ) )
$active_id = bbp_get_forum_last_topic_id( $forum_id );
if ( bbp_is_topic( $active_id ) ) {
$link_url = bbp_get_forum_last_topic_permalink( $forum_id );
$title = bbp_get_forum_last_topic_title( $forum_id );
} elseif ( bbp_is_reply( $active_id ) ) {
$link_url = bbp_get_forum_last_reply_url( $forum_id );
$title = bbp_get_forum_last_reply_title( $forum_id );
}
$time_since = bbp_get_forum_last_active_time( $forum_id );
if ( !empty( $time_since ) && !empty( $link_url ) )
$anchor = '<a href="' . esc_url( $link_url ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $time_since ) . '</a>';
else
$anchor = esc_html__( 'No Topics', 'bbpress' );
return apply_filters( 'bbp_get_forum_freshness_link', $anchor, $forum_id, $time_since, $link_url, $title, $active_id );
}
/**
* Output parent ID of a forum, if exists
*
* @since bbPress (r3675)
*
* @param int $forum_id Forum ID
* @uses bbp_get_forum_parent_id() To get the forum's parent ID
*/
function bbp_forum_parent_id( $forum_id = 0 ) {
echo bbp_get_forum_parent_id( $forum_id );
}
/**
* Return ID of forum parent, if exists
*
* @since bbPress (r3675)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_field() To get the forum parent
* @uses apply_filters() Calls 'bbp_get_forum_parent' with the parent & forum id
* @return int Forum parent
*/
function bbp_get_forum_parent_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$parent_id = get_post_field( 'post_parent', $forum_id );
return (int) apply_filters( 'bbp_get_forum_parent_id', (int) $parent_id, $forum_id );
}
/**
* Return array of parent forums
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum() To get the forum
* @uses apply_filters() Calls 'bbp_get_forum_ancestors' with the ancestors
* and forum id
* @return array Forum ancestors
*/
function bbp_get_forum_ancestors( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$ancestors = array();
$forum = bbp_get_forum( $forum_id );
if ( !empty( $forum ) ) {
while ( 0 !== (int) $forum->post_parent ) {
$ancestors[] = $forum->post_parent;
$forum = bbp_get_forum( $forum->post_parent );
}
}
return apply_filters( 'bbp_get_forum_ancestors', $ancestors, $forum_id );
}
/**
* Return subforums of given forum
*
* @since bbPress (r2747)
*
* @param mixed $args All the arguments supported by {@link WP_Query}
* @uses bbp_get_forum_id() To get the forum id
* @uses current_user_can() To check if the current user is capable of
* reading private forums
* @uses get_posts() To get the subforums
* @uses apply_filters() Calls 'bbp_forum_get_subforums' with the subforums
* and the args
* @return mixed false if none, array of subs if yes
*/
function bbp_forum_get_subforums( $args = '' ) {
// Use passed integer as post_parent
if ( is_numeric( $args ) )
$args = array( 'post_parent' => $args );
// Setup possible post__not_in array
$post_stati = array( bbp_get_public_status_id() );
// Super admin get whitelisted post statuses
if ( bbp_is_user_keymaster() ) {
$post_stati = array( bbp_get_public_status_id(), bbp_get_private_status_id(), bbp_get_hidden_status_id() );
// Not a keymaster, so check caps
} else {
// Check if user can read private forums
if ( current_user_can( 'read_private_forums' ) ) {
$post_stati[] = bbp_get_private_status_id();
}
// Check if user can read hidden forums
if ( current_user_can( 'read_hidden_forums' ) ) {
$post_stati[] = bbp_get_hidden_status_id();
}
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'post_parent' => 0,
'post_type' => bbp_get_forum_post_type(),
'post_status' => implode( ',', $post_stati ),
'posts_per_page' => get_option( '_bbp_forums_per_page', 50 ),
'orderby' => 'menu_order title',
'order' => 'ASC',
'ignore_sticky_posts' => true,
'no_found_rows' => true
), 'forum_get_subforums' );
$r['post_parent'] = bbp_get_forum_id( $r['post_parent'] );
// Create a new query for the subforums
$get_posts = new WP_Query();
// No forum passed
$sub_forums = !empty( $r['post_parent'] ) ? $get_posts->query( $r ) : array();
return (array) apply_filters( 'bbp_forum_get_subforums', $sub_forums, $r );
}
/**
* Output a list of forums (can be used to list subforums)
*
* @param mixed $args The function supports these args:
* - before: To put before the output. Defaults to '<ul class="bbp-forums">'
* - after: To put after the output. Defaults to '</ul>'
* - link_before: To put before every link. Defaults to '<li class="bbp-forum">'
* - link_after: To put after every link. Defaults to '</li>'
* - separator: Separator. Defaults to ', '
* - forum_id: Forum id. Defaults to ''
* - show_topic_count - To show forum topic count or not. Defaults to true
* - show_reply_count - To show forum reply count or not. Defaults to true
* @uses bbp_forum_get_subforums() To check if the forum has subforums or not
* @uses bbp_get_forum_permalink() To get forum permalink
* @uses bbp_get_forum_title() To get forum title
* @uses bbp_is_forum_category() To check if a forum is a category
* @uses bbp_get_forum_topic_count() To get forum topic count
* @uses bbp_get_forum_reply_count() To get forum reply count
*/
function bbp_list_forums( $args = '' ) {
// Define used variables
$output = $sub_forums = $topic_count = $reply_count = $counts = '';
$i = 0;
$count = array();
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'before' => '<ul class="bbp-forums-list">',
'after' => '</ul>',
'link_before' => '<li class="bbp-forum">',
'link_after' => '</li>',
'count_before' => ' (',
'count_after' => ')',
'count_sep' => ', ',
'separator' => ', ',
'forum_id' => '',
'show_topic_count' => true,
'show_reply_count' => true,
), 'list_forums' );
// Loop through forums and create a list
$sub_forums = bbp_forum_get_subforums( $r['forum_id'] );
if ( !empty( $sub_forums ) ) {
// Total count (for separator)
$total_subs = count( $sub_forums );
foreach ( $sub_forums as $sub_forum ) {
$i++; // Separator count
// Get forum details
$count = array();
$show_sep = $total_subs > $i ? $r['separator'] : '';
$permalink = bbp_get_forum_permalink( $sub_forum->ID );
$title = bbp_get_forum_title( $sub_forum->ID );
// Show topic count
if ( !empty( $r['show_topic_count'] ) && !bbp_is_forum_category( $sub_forum->ID ) ) {
$count['topic'] = bbp_get_forum_topic_count( $sub_forum->ID );
}
// Show reply count
if ( !empty( $r['show_reply_count'] ) && !bbp_is_forum_category( $sub_forum->ID ) ) {
$count['reply'] = bbp_get_forum_reply_count( $sub_forum->ID );
}
// Counts to show
if ( !empty( $count ) ) {
$counts = $r['count_before'] . implode( $r['count_sep'], $count ) . $r['count_after'];
}
// Build this sub forums link
$output .= $r['link_before'] . '<a href="' . esc_url( $permalink ) . '" class="bbp-forum-link">' . $title . $counts . '</a>' . $show_sep . $r['link_after'];
}
// Output the list
echo apply_filters( 'bbp_list_forums', $r['before'] . $output . $r['after'], $r );
}
}
/** Forum Subscriptions *******************************************************/
/**
* Output the forum subscription link
*
* @since bbPress (r5156)
*
* @uses bbp_get_forum_subscription_link()
*/
function bbp_forum_subscription_link( $args = array() ) {
echo bbp_get_forum_subscription_link( $args );
}
/**
* Get the forum subscription link
*
* A custom wrapper for bbp_get_user_subscribe_link()
*
* @since bbPress (r5156)
*
* @uses bbp_parse_args()
* @uses bbp_get_user_subscribe_link()
* @uses apply_filters() Calls 'bbp_get_forum_subscribe_link'
*/
function bbp_get_forum_subscription_link( $args = array() ) {
// No link
$retval = false;
// Parse the arguments
$r = bbp_parse_args( $args, array(
'forum_id' => 0,
'user_id' => 0,
'before' => '',
'after' => '',
'subscribe' => __( 'Subscribe', 'bbpress' ),
'unsubscribe' => __( 'Unsubscribe', 'bbpress' )
), 'get_forum_subscribe_link' );
// No link for categories until we support subscription hierarchy
// @see http://bbpress.trac.wordpress.org/ticket/2475
if ( ! bbp_is_forum_category() ) {
$retval = bbp_get_user_subscribe_link( $r );
}
return apply_filters( 'bbp_get_forum_subscribe_link', $retval, $r );
}
/** Forum Last Topic **********************************************************/
/**
* Output the forum's last topic id
*
* @since bbPress (r2464)
*
* @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
* @param int $forum_id Optional. Forum id
*/
function bbp_forum_last_topic_id( $forum_id = 0 ) {
echo bbp_get_forum_last_topic_id( $forum_id );
}
/**
* Return the forum's last topic id
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the forum's last topic id
* @uses apply_filters() Calls 'bbp_get_forum_last_topic_id' with the
* forum and topic id
* @return int Forum's last topic id
*/
function bbp_get_forum_last_topic_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$topic_id = get_post_meta( $forum_id, '_bbp_last_topic_id', true );
return (int) apply_filters( 'bbp_get_forum_last_topic_id', (int) $topic_id, $forum_id );
}
/**
* Output the title of the last topic inside a forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_topic_title() To get the forum's last topic's title
*/
function bbp_forum_last_topic_title( $forum_id = 0 ) {
echo bbp_get_forum_last_topic_title( $forum_id );
}
/**
* Return the title of the last topic inside a forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
* @uses bbp_get_topic_title() To get the topic's title
* @uses apply_filters() Calls 'bbp_get_forum_last_topic_title' with the
* topic title and forum id
* @return string Forum's last topic's title
*/
function bbp_get_forum_last_topic_title( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$topic_id = bbp_get_forum_last_topic_id( $forum_id );
$title = !empty( $topic_id ) ? bbp_get_topic_title( $topic_id ) : '';
return apply_filters( 'bbp_get_forum_last_topic_title', $title, $forum_id );
}
/**
* Output the link to the last topic in a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_topic_permalink() To get the forum's last topic's
* permanent link
*/
function bbp_forum_last_topic_permalink( $forum_id = 0 ) {
echo esc_url( bbp_get_forum_last_topic_permalink( $forum_id ) );
}
/**
* Return the link to the last topic in a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
* @uses bbp_get_topic_permalink() To get the topic's permalink
* @uses apply_filters() Calls 'bbp_get_forum_last_topic_permalink' with
* the topic link and forum id
* @return string Permanent link to topic
*/
function bbp_get_forum_last_topic_permalink( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
return apply_filters( 'bbp_get_forum_last_topic_permalink', bbp_get_topic_permalink( bbp_get_forum_last_topic_id( $forum_id ) ), $forum_id );
}
/**
* Return the author ID of the last topic of a forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
* @uses bbp_get_topic_author_id() To get the topic's author id
* @uses apply_filters() Calls 'bbp_get_forum_last_topic_author' with the author
* id and forum id
* @return int Forum's last topic's author id
*/
function bbp_get_forum_last_topic_author_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$author_id = bbp_get_topic_author_id( bbp_get_forum_last_topic_id( $forum_id ) );
return (int) apply_filters( 'bbp_get_forum_last_topic_author_id', (int) $author_id, $forum_id );
}
/**
* Output link to author of last topic of forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_topic_author_link() To get the forum's last topic's
* author link
*/
function bbp_forum_last_topic_author_link( $forum_id = 0 ) {
echo bbp_get_forum_last_topic_author_link( $forum_id );
}
/**
* Return link to author of last topic of forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_topic_author_id() To get the forum's last
* topic's author id
* @uses bbp_get_user_profile_link() To get the author's profile link
* @uses apply_filters() Calls 'bbp_get_forum_last_topic_author_link'
* with the author link and forum id
* @return string Forum's last topic's author link
*/
function bbp_get_forum_last_topic_author_link( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$author_id = bbp_get_forum_last_topic_author_id( $forum_id );
$author_link = bbp_get_user_profile_link( $author_id );
return apply_filters( 'bbp_get_forum_last_topic_author_link', $author_link, $forum_id );
}
/** Forum Last Reply **********************************************************/
/**
* Output the forums last reply id
*
* @since bbPress (r2464)
*
* @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
* @param int $forum_id Optional. Forum id
*/
function bbp_forum_last_reply_id( $forum_id = 0 ) {
echo bbp_get_forum_last_reply_id( $forum_id );
}
/**
* Return the forums last reply id
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the forum's last reply id
* @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
* @uses apply_filters() Calls 'bbp_get_forum_last_reply_id' with
* the last reply id and forum id
* @return int Forum's last reply id
*/
function bbp_get_forum_last_reply_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$reply_id = get_post_meta( $forum_id, '_bbp_last_reply_id', true );
if ( empty( $reply_id ) )
$reply_id = bbp_get_forum_last_topic_id( $forum_id );
return (int) apply_filters( 'bbp_get_forum_last_reply_id', (int) $reply_id, $forum_id );
}
/**
* Output the title of the last reply inside a forum
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_reply_title() To get the forum's last reply's title
*/
function bbp_forum_last_reply_title( $forum_id = 0 ) {
echo bbp_get_forum_last_reply_title( $forum_id );
}
/**
* Return the title of the last reply inside a forum
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
* @uses bbp_get_reply_title() To get the reply title
* @uses apply_filters() Calls 'bbp_get_forum_last_reply_title' with the
* reply title and forum id
* @return string
*/
function bbp_get_forum_last_reply_title( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
return apply_filters( 'bbp_get_forum_last_reply_title', bbp_get_reply_title( bbp_get_forum_last_reply_id( $forum_id ) ), $forum_id );
}
/**
* Output the link to the last reply in a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_reply_permalink() To get the forum last reply link
*/
function bbp_forum_last_reply_permalink( $forum_id = 0 ) {
echo esc_url( bbp_get_forum_last_reply_permalink( $forum_id ) );
}
/**
* Return the link to the last reply in a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
* @uses bbp_get_reply_permalink() To get the reply permalink
* @uses apply_filters() Calls 'bbp_get_forum_last_reply_permalink' with
* the reply link and forum id
* @return string Permanent link to the forum's last reply
*/
function bbp_get_forum_last_reply_permalink( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
return apply_filters( 'bbp_get_forum_last_reply_permalink', bbp_get_reply_permalink( bbp_get_forum_last_reply_id( $forum_id ) ), $forum_id );
}
/**
* Output the url to the last reply in a forum
*
* @since bbPress (r2683)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_reply_url() To get the forum last reply url
*/
function bbp_forum_last_reply_url( $forum_id = 0 ) {
echo esc_url( bbp_get_forum_last_reply_url( $forum_id ) );
}
/**
* Return the url to the last reply in a forum
*
* @since bbPress (r2683)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
* @uses bbp_get_reply_url() To get the reply url
* @uses bbp_get_forum_last_topic_permalink() To get the forum's last
* topic's permalink
* @uses apply_filters() Calls 'bbp_get_forum_last_reply_url' with the
* reply url and forum id
* @return string Paginated URL to latest reply
*/
function bbp_get_forum_last_reply_url( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
// If forum has replies, get the last reply and use its url
$reply_id = bbp_get_forum_last_reply_id( $forum_id );
if ( !empty( $reply_id ) ) {
$reply_url = bbp_get_reply_url( $reply_id );
// No replies, so look for topics and use last permalink
} else {
$reply_url = bbp_get_forum_last_topic_permalink( $forum_id );
// No topics either, so set $reply_url as empty string
if ( empty( $reply_url ) ) {
$reply_url = '';
}
}
// Filter and return
return apply_filters( 'bbp_get_forum_last_reply_url', $reply_url, $forum_id );
}
/**
* Output author ID of last reply of forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_reply_author_id() To get the forum's last reply
* author id
*/
function bbp_forum_last_reply_author_id( $forum_id = 0 ) {
echo bbp_get_forum_last_reply_author_id( $forum_id );
}
/**
* Return author ID of last reply of forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_reply_author_id() To get the forum's last
* reply's author id
* @uses bbp_get_reply_author_id() To get the reply's author id
* @uses apply_filters() Calls 'bbp_get_forum_last_reply_author_id' with
* the author id and forum id
* @return int Forum's last reply author id
*/
function bbp_get_forum_last_reply_author_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$author_id = bbp_get_reply_author_id( bbp_get_forum_last_reply_id( $forum_id ) );
return apply_filters( 'bbp_get_forum_last_reply_author_id', $author_id, $forum_id );
}
/**
* Output link to author of last reply of forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_last_reply_author_link() To get the forum's last reply's
* author link
*/
function bbp_forum_last_reply_author_link( $forum_id = 0 ) {
echo bbp_get_forum_last_reply_author_link( $forum_id );
}
/**
* Return link to author of last reply of forum
*
* @since bbPress (r2625)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_last_reply_author_id() To get the forum's last
* reply's author id
* @uses bbp_get_user_profile_link() To get the reply's author's profile
* link
* @uses apply_filters() Calls 'bbp_get_forum_last_reply_author_link'
* with the author link and forum id
* @return string Link to author of last reply of forum
*/
function bbp_get_forum_last_reply_author_link( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$author_id = bbp_get_forum_last_reply_author_id( $forum_id );
$author_link = bbp_get_user_profile_link( $author_id );
return apply_filters( 'bbp_get_forum_last_reply_author_link', $author_link, $forum_id );
}
/** Forum Counts **************************************************************/
/**
* Output the topics link of the forum
*
* @since bbPress (r2883)
*
* @param int $forum_id Optional. Topic id
* @uses bbp_get_forum_topics_link() To get the forum topics link
*/
function bbp_forum_topics_link( $forum_id = 0 ) {
echo bbp_get_forum_topics_link( $forum_id );
}
/**
* Return the topics link of the forum
*
* @since bbPress (r2883)
*
* @param int $forum_id Optional. Topic id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum() To get the forum
* @uses bbp_get_forum_topic_count() To get the forum topic count
* @uses bbp_get_forum_permalink() To get the forum permalink
* @uses bbp_get_forum_topic_count_hidden() To get the forum hidden
* topic count
* @uses current_user_can() To check if the current user can edit others
* topics
* @uses add_query_arg() To add custom args to the url
* @uses apply_filters() Calls 'bbp_get_forum_topics_link' with the
* topics link and forum id
*/
function bbp_get_forum_topics_link( $forum_id = 0 ) {
$forum = bbp_get_forum( $forum_id );
$forum_id = $forum->ID;
$topics = sprintf( _n( '%s topic', '%s topics', bbp_get_forum_topic_count( $forum_id, true, false ), 'bbpress' ), bbp_get_forum_topic_count( $forum_id ) );
$retval = '';
// First link never has view=all
if ( bbp_get_view_all( 'edit_others_topics' ) )
$retval .= "<a href='" . esc_url( bbp_remove_view_all( bbp_get_forum_permalink( $forum_id ) ) ) . "'>" . esc_html( $topics ) . "</a>";
else
$retval .= esc_html( $topics );
// Get deleted topics
$deleted = bbp_get_forum_topic_count_hidden( $forum_id );
// This forum has hidden topics
if ( !empty( $deleted ) && current_user_can( 'edit_others_topics' ) ) {
// Extra text
$extra = sprintf( __( ' (+ %d hidden)', 'bbpress' ), $deleted );
// No link
if ( bbp_get_view_all() ) {
$retval .= " $extra";
// Link
} else {
$retval .= " <a href='" . esc_url( bbp_add_view_all( bbp_get_forum_permalink( $forum_id ), true ) ) . "'>" . esc_html( $extra ) . "</a>";
}
}
return apply_filters( 'bbp_get_forum_topics_link', $retval, $forum_id );
}
/**
* Output total sub-forum count of a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id to check
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_subforum_count() To get the forum's subforum count
*/
function bbp_forum_subforum_count( $forum_id = 0, $integer = false ) {
echo bbp_get_forum_subforum_count( $forum_id, $integer );
}
/**
* Return total subforum count of a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the subforum count
* @uses apply_filters() Calls 'bbp_get_forum_subforum_count' with the
* subforum count and forum id
* @return int Forum's subforum count
*/
function bbp_get_forum_subforum_count( $forum_id = 0, $integer = false ) {
$forum_id = bbp_get_forum_id( $forum_id );
$forum_count = (int) get_post_meta( $forum_id, '_bbp_forum_subforum_count', true );
$filter = ( true === $integer ) ? 'bbp_get_forum_subforum_count_int' : 'bbp_get_forum_subforum_count';
return apply_filters( $filter, $forum_count, $forum_id );
}
/**
* Output total topic count of a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @param bool $total_count Optional. To get the total count or normal count?
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_topic_count() To get the forum topic count
*/
function bbp_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false ) {
echo bbp_get_forum_topic_count( $forum_id, $total_count, $integer );
}
/**
* Return total topic count of a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @param bool $total_count Optional. To get the total count or normal
* count? Defaults to total.
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the forum topic count
* @uses apply_filters() Calls 'bbp_get_forum_topic_count' with the
* topic count and forum id
* @return int Forum topic count
*/
function bbp_get_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false ) {
$forum_id = bbp_get_forum_id( $forum_id );
$meta_key = empty( $total_count ) ? '_bbp_topic_count' : '_bbp_total_topic_count';
$topics = (int) get_post_meta( $forum_id, $meta_key, true );
$filter = ( true === $integer ) ? 'bbp_get_forum_topic_count_int' : 'bbp_get_forum_topic_count';
return apply_filters( $filter, $topics, $forum_id );
}
/**
* Output total reply count of a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @param bool $total_count Optional. To get the total count or normal count?
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_reply_count() To get the forum reply count
*/
function bbp_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false ) {
echo bbp_get_forum_reply_count( $forum_id, $total_count, $integer );
}
/**
* Return total post count of a forum
*
* @since bbPress (r2464)
*
* @param int $forum_id Optional. Forum id
* @param bool $total_count Optional. To get the total count or normal
* count?
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the forum reply count
* @uses apply_filters() Calls 'bbp_get_forum_reply_count' with the
* reply count and forum id
* @return int Forum reply count
*/
function bbp_get_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false ) {
$forum_id = bbp_get_forum_id( $forum_id );
$meta_key = empty( $total_count ) ? '_bbp_reply_count' : '_bbp_total_reply_count';
$replies = (int) get_post_meta( $forum_id, $meta_key, true );
$filter = ( true === $integer ) ? 'bbp_get_forum_reply_count_int' : 'bbp_get_forum_reply_count';
return apply_filters( $filter, $replies, $forum_id );
}
/**
* Output total post count of a forum
*
* @since bbPress (r2954)
*
* @param int $forum_id Optional. Forum id
* @param bool $total_count Optional. To get the total count or normal count?
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_post_count() To get the forum post count
*/
function bbp_forum_post_count( $forum_id = 0, $total_count = true, $integer = false ) {
echo bbp_get_forum_post_count( $forum_id, $total_count, $integer );
}
/**
* Return total post count of a forum
*
* @since bbPress (r2954)
*
* @param int $forum_id Optional. Forum id
* @param bool $total_count Optional. To get the total count or normal
* count?
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the forum post count
* @uses apply_filters() Calls 'bbp_get_forum_post_count' with the
* post count and forum id
* @return int Forum post count
*/
function bbp_get_forum_post_count( $forum_id = 0, $total_count = true, $integer = false ) {
$forum_id = bbp_get_forum_id( $forum_id );
$topics = bbp_get_forum_topic_count( $forum_id, $total_count, true );
$meta_key = empty( $total_count ) ? '_bbp_reply_count' : '_bbp_total_reply_count';
$replies = (int) get_post_meta( $forum_id, $meta_key, true );
$retval = $replies + $topics;
$filter = ( true === $integer ) ? 'bbp_get_forum_post_count_int' : 'bbp_get_forum_post_count';
return apply_filters( $filter, $retval, $forum_id );
}
/**
* Output total hidden topic count of a forum (hidden includes trashed and
* spammed topics)
*
* @since bbPress (r2883)
*
* @param int $forum_id Optional. Topic id
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_topic_count_hidden() To get the forum hidden topic count
*/
function bbp_forum_topic_count_hidden( $forum_id = 0, $integer = false ) {
echo bbp_get_forum_topic_count_hidden( $forum_id, $integer );
}
/**
* Return total hidden topic count of a forum (hidden includes trashed
* and spammed topics)
*
* @since bbPress (r2883)
*
* @param int $forum_id Optional. Topic id
* @param boolean $integer Optional. Whether or not to format the result
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_meta() To get the hidden topic count
* @uses apply_filters() Calls 'bbp_get_forum_topic_count_hidden' with
* the hidden topic count and forum id
* @return int Topic hidden topic count
*/
function bbp_get_forum_topic_count_hidden( $forum_id = 0, $integer = false ) {
$forum_id = bbp_get_forum_id( $forum_id );
$topics = (int) get_post_meta( $forum_id, '_bbp_topic_count_hidden', true );
$filter = ( true === $integer ) ? 'bbp_get_forum_topic_count_hidden_int' : 'bbp_get_forum_topic_count_hidden';
return apply_filters( $filter, $topics, $forum_id );
}
/**
* Output the status of the forum
*
* @since bbPress (r2667)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_status() To get the forum status
*/
function bbp_forum_status( $forum_id = 0 ) {
echo bbp_get_forum_status( $forum_id );
}
/**
* Return the status of the forum
*
* @since bbPress (r2667)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_status() To get the forum's status
* @uses apply_filters() Calls 'bbp_get_forum_status' with the status
* and forum id
* @return string Status of forum
*/
function bbp_get_forum_status( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$status = get_post_meta( $forum_id, '_bbp_status', true );
if ( empty( $status ) )
$status = 'open';
return apply_filters( 'bbp_get_forum_status', $status, $forum_id );
}
/**
* Output the visibility of the forum
*
* @since bbPress (r2997)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_visibility() To get the forum visibility
*/
function bbp_forum_visibility( $forum_id = 0 ) {
echo bbp_get_forum_visibility( $forum_id );
}
/**
* Return the visibility of the forum
*
* @since bbPress (r2997)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_visibility() To get the forum's visibility
* @uses apply_filters() Calls 'bbp_get_forum_visibility' with the visibility
* and forum id
* @return string Status of forum
*/
function bbp_get_forum_visibility( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
return apply_filters( 'bbp_get_forum_visibility', get_post_status( $forum_id ), $forum_id );
}
/**
* Output the type of the forum
*
* @since bbPress (r3563)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_type() To get the forum type
*/
function bbp_forum_type( $forum_id = 0 ) {
echo bbp_get_forum_type( $forum_id );
}
/**
* Return the type of forum (category/forum/etc...)
*
* @since bbPress (r3563)
*
* @param int $forum_id Optional. Forum id
* @uses get_post_meta() To get the forum category meta
* @return bool Whether the forum is a category or not
*/
function bbp_get_forum_type( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$retval = get_post_meta( $forum_id, '_bbp_forum_type', true );
if ( empty( $retval ) )
$retval = 'forum';
return apply_filters( 'bbp_get_forum_type', $retval, $forum_id );
}
/**
* Is the forum a category?
*
* @since bbPress (r2746)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_type() To get the forum type
* @return bool Whether the forum is a category or not
*/
function bbp_is_forum_category( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$type = bbp_get_forum_type( $forum_id );
$retval = ( !empty( $type ) && 'category' === $type );
return (bool) apply_filters( 'bbp_is_forum_category', (bool) $retval, $forum_id );
}
/**
* Is the forum open?
*
* @since bbPress (r2746)
* @param int $forum_id Optional. Forum id
*
* @param int $forum_id Optional. Forum id
* @uses bbp_is_forum_closed() To check if the forum is closed or not
* @return bool Whether the forum is open or not
*/
function bbp_is_forum_open( $forum_id = 0 ) {
return !bbp_is_forum_closed( $forum_id );
}
/**
* Is the forum closed?
*
* @since bbPress (r2746)
*
* @param int $forum_id Optional. Forum id
* @param bool $check_ancestors Check if the ancestors are closed (only
* if they're a category)
* @uses bbp_get_forum_status() To get the forum status
* @uses bbp_get_forum_ancestors() To get the forum ancestors
* @uses bbp_is_forum_category() To check if the forum is a category
* @uses bbp_is_forum_closed() To check if the forum is closed
* @return bool True if closed, false if not
*/
function bbp_is_forum_closed( $forum_id = 0, $check_ancestors = true ) {
$forum_id = bbp_get_forum_id( $forum_id );
$retval = ( bbp_get_closed_status_id() === bbp_get_forum_status( $forum_id ) );
if ( !empty( $check_ancestors ) ) {
$ancestors = bbp_get_forum_ancestors( $forum_id );
foreach ( (array) $ancestors as $ancestor ) {
if ( bbp_is_forum_category( $ancestor, false ) && bbp_is_forum_closed( $ancestor, false ) ) {
$retval = true;
}
}
}
return (bool) apply_filters( 'bbp_is_forum_closed', (bool) $retval, $forum_id, $check_ancestors );
}
/**
* Is the forum public?
*
* @since bbPress (r2997)
*
* @param int $forum_id Optional. Forum id
* @param bool $check_ancestors Check if the ancestors are public (only if
* they're a category)
* @uses get_post_meta() To get the forum public meta
* @uses bbp_get_forum_ancestors() To get the forum ancestors
* @uses bbp_is_forum_category() To check if the forum is a category
* @uses bbp_is_forum_closed() To check if the forum is closed
* @return bool True if closed, false if not
*/
function bbp_is_forum_public( $forum_id = 0, $check_ancestors = true ) {
$forum_id = bbp_get_forum_id( $forum_id );
$visibility = bbp_get_forum_visibility( $forum_id );
// If post status is public, return true
$retval = ( bbp_get_public_status_id() === $visibility );
// Check ancestors and inherit their privacy setting for display
if ( !empty( $check_ancestors ) ) {
$ancestors = bbp_get_forum_ancestors( $forum_id );
foreach ( (array) $ancestors as $ancestor ) {
if ( bbp_is_forum( $ancestor ) && bbp_is_forum_public( $ancestor, false ) ) {
$retval = true;
}
}
}
return (bool) apply_filters( 'bbp_is_forum_public', (bool) $retval, $forum_id, $check_ancestors );
}
/**
* Is the forum private?
*
* @since bbPress (r2746)
*
* @param int $forum_id Optional. Forum id
* @param bool $check_ancestors Check if the ancestors are private (only if
* they're a category)
* @uses get_post_meta() To get the forum private meta
* @uses bbp_get_forum_ancestors() To get the forum ancestors
* @uses bbp_is_forum_category() To check if the forum is a category
* @uses bbp_is_forum_closed() To check if the forum is closed
* @return bool True if closed, false if not
*/
function bbp_is_forum_private( $forum_id = 0, $check_ancestors = true ) {
$forum_id = bbp_get_forum_id( $forum_id );
$visibility = bbp_get_forum_visibility( $forum_id );
// If post status is private, return true
$retval = ( bbp_get_private_status_id() === $visibility );
// Check ancestors and inherit their privacy setting for display
if ( !empty( $check_ancestors ) ) {
$ancestors = bbp_get_forum_ancestors( $forum_id );
foreach ( (array) $ancestors as $ancestor ) {
if ( bbp_is_forum( $ancestor ) && bbp_is_forum_private( $ancestor, false ) ) {
$retval = true;
}
}
}
return (bool) apply_filters( 'bbp_is_forum_private', (bool) $retval, $forum_id, $check_ancestors );
}
/**
* Is the forum hidden?
*
* @since bbPress (r2997)
*
* @param int $forum_id Optional. Forum id
* @param bool $check_ancestors Check if the ancestors are private (only if
* they're a category)
* @uses get_post_meta() To get the forum private meta
* @uses bbp_get_forum_ancestors() To get the forum ancestors
* @uses bbp_is_forum_category() To check if the forum is a category
* @uses bbp_is_forum_closed() To check if the forum is closed
* @return bool True if closed, false if not
*/
function bbp_is_forum_hidden( $forum_id = 0, $check_ancestors = true ) {
$forum_id = bbp_get_forum_id( $forum_id );
$visibility = bbp_get_forum_visibility( $forum_id );
// If post status is private, return true
$retval = ( bbp_get_hidden_status_id() === $visibility );
// Check ancestors and inherit their privacy setting for display
if ( !empty( $check_ancestors ) ) {
$ancestors = bbp_get_forum_ancestors( $forum_id );
foreach ( (array) $ancestors as $ancestor ) {
if ( bbp_is_forum( $ancestor ) && bbp_is_forum_hidden( $ancestor, false ) ) {
$retval = true;
}
}
}
return (bool) apply_filters( 'bbp_is_forum_hidden', (bool) $retval, $forum_id, $check_ancestors );
}
/**
* Output the author of the forum
*
* @since bbPress (r3675)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_author() To get the forum author
*/
function bbp_forum_author_display_name( $forum_id = 0 ) {
echo bbp_get_forum_author_display_name( $forum_id );
}
/**
* Return the author of the forum
*
* @since bbPress (r3675)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_author_id() To get the forum author id
* @uses get_the_author_meta() To get the display name of the author
* @uses apply_filters() Calls 'bbp_get_forum_author' with the author
* and forum id
* @return string Author of forum
*/
function bbp_get_forum_author_display_name( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$author = get_the_author_meta( 'display_name', bbp_get_forum_author_id( $forum_id ) );
return apply_filters( 'bbp_get_forum_author_display_name', $author, $forum_id );
}
/**
* Output the author ID of the forum
*
* @since bbPress (r3675)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_author_id() To get the forum author id
*/
function bbp_forum_author_id( $forum_id = 0 ) {
echo bbp_get_forum_author_id( $forum_id );
}
/**
* Return the author ID of the forum
*
* @since bbPress (r3675)
*
* @param int $forum_id Optional. Forum id
* @uses bbp_get_forum_id() To get the forum id
* @uses get_post_field() To get the forum author id
* @uses apply_filters() Calls 'bbp_get_forum_author_id' with the author
* id and forum id
* @return string Author of forum
*/
function bbp_get_forum_author_id( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
$author_id = get_post_field( 'post_author', $forum_id );
return (int) apply_filters( 'bbp_get_forum_author_id', (int) $author_id, $forum_id );
}
/**
* Replace forum meta details for users that cannot view them.
*
* @since bbPress (r3162)
*
* @param string $retval
* @param int $forum_id
*
* @uses bbp_is_forum_private()
* @uses current_user_can()
*
* @return string
*/
function bbp_suppress_private_forum_meta( $retval, $forum_id ) {
if ( bbp_is_forum_private( $forum_id, false ) && !current_user_can( 'read_private_forums' ) )
$retval = '-';
return apply_filters( 'bbp_suppress_private_forum_meta', $retval );
}
/**
* Replace forum author details for users that cannot view them.
*
* @since bbPress (r3162)
*
* @param string $retval
* @param int $forum_id
*
* @uses bbp_is_forum_private()
* @uses get_post_field()
* @uses bbp_get_topic_post_type()
* @uses bbp_is_forum_private()
* @uses bbp_get_topic_forum_id()
* @uses bbp_get_reply_post_type()
* @uses bbp_get_reply_forum_id()
*
* @return string
*/
function bbp_suppress_private_author_link( $author_link, $args ) {
// Assume the author link is the return value
$retval = $author_link;
// Show the normal author link
if ( !empty( $args['post_id'] ) && !current_user_can( 'read_private_forums' ) ) {
// What post type are we looking at?
$post_type = get_post_field( 'post_type', $args['post_id'] );
switch ( $post_type ) {
// Topic
case bbp_get_topic_post_type() :
if ( bbp_is_forum_private( bbp_get_topic_forum_id( $args['post_id'] ) ) )
$retval = '';
break;
// Reply
case bbp_get_reply_post_type() :
if ( bbp_is_forum_private( bbp_get_reply_forum_id( $args['post_id'] ) ) )
$retval = '';
break;
// Post
default :
if ( bbp_is_forum_private( $args['post_id'] ) )
$retval = '';
break;
}
}
return apply_filters( 'bbp_suppress_private_author_link', $retval );
}
/**
* Output the row class of a forum
*
* @since bbPress (r2667)
*
* @param int $forum_id Optional. Forum ID.
* @param array Extra classes you can pass when calling this function
* @uses bbp_get_forum_class() To get the row class of the forum
*/
function bbp_forum_class( $forum_id = 0, $classes = array() ) {
echo bbp_get_forum_class( $forum_id, $classes );
}
/**
* Return the row class of a forum
*
* @since bbPress (r2667)
*
* @param int $forum_id Optional. Forum ID
* @param array Extra classes you can pass when calling this function
* @uses bbp_get_forum_id() To validate the forum id
* @uses bbp_is_forum_category() To see if forum is a category
* @uses bbp_get_forum_status() To get the forum status
* @uses bbp_get_forum_visibility() To get the forum visibility
* @uses bbp_get_forum_parent_id() To get the forum parent id
* @uses get_post_class() To get all the classes including ours
* @uses apply_filters() Calls 'bbp_get_forum_class' with the classes
* @return string Row class of the forum
*/
function bbp_get_forum_class( $forum_id = 0, $classes = array() ) {
$bbp = bbpress();
$forum_id = bbp_get_forum_id( $forum_id );
$count = isset( $bbp->forum_query->current_post ) ? $bbp->forum_query->current_post : 1;
$classes = (array) $classes;
// Get some classes
$classes[] = 'loop-item-' . $count;
$classes[] = ( (int) $count % 2 ) ? 'even' : 'odd';
$classes[] = bbp_is_forum_category( $forum_id ) ? 'status-category' : '';
$classes[] = bbp_get_forum_subforum_count( $forum_id ) ? 'bbp-has-subforums' : '';
$classes[] = bbp_get_forum_parent_id( $forum_id ) ? 'bbp-parent-forum-' . bbp_get_forum_parent_id( $forum_id ) : '';
$classes[] = 'bbp-forum-status-' . bbp_get_forum_status( $forum_id );
$classes[] = 'bbp-forum-visibility-' . bbp_get_forum_visibility( $forum_id );
// Ditch the empties
$classes = array_filter( $classes );
$classes = get_post_class( $classes, $forum_id );
// Filter the results
$classes = apply_filters( 'bbp_get_forum_class', $classes, $forum_id );
$retval = 'class="' . implode( ' ', $classes ) . '"';
return $retval;
}
/** Single Forum **************************************************************/
/**
* Output a fancy description of the current forum, including total topics,
* total replies, and last activity.
*
* @since bbPress (r2860)
*
* @param array $args Arguments passed to alter output
* @uses bbp_get_single_forum_description() Return the eventual output
*/
function bbp_single_forum_description( $args = '' ) {
echo bbp_get_single_forum_description( $args );
}
/**
* Return a fancy description of the current forum, including total
* topics, total replies, and last activity.
*
* @since bbPress (r2860)
*
* @param mixed $args This function supports these arguments:
* - forum_id: Forum id
* - before: Before the text
* - after: After the text
* - size: Size of the avatar
* @uses bbp_get_forum_id() To get the forum id
* @uses bbp_get_forum_topic_count() To get the forum topic count
* @uses bbp_get_forum_reply_count() To get the forum reply count
* @uses bbp_get_forum_freshness_link() To get the forum freshness link
* @uses bbp_get_forum_last_active_id() To get the forum last active id
* @uses bbp_get_author_link() To get the author link
* @uses add_filter() To add the 'view all' filter back
* @uses apply_filters() Calls 'bbp_get_single_forum_description' with
* the description and args
* @return string Filtered forum description
*/
function bbp_get_single_forum_description( $args = '' ) {
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'forum_id' => 0,
'before' => '<div class="bbp-template-notice info"><p class="bbp-forum-description">',
'after' => '</p></div>',
'size' => 14,
'feed' => true
), 'get_single_forum_description' );
// Validate forum_id
$forum_id = bbp_get_forum_id( $r['forum_id'] );
// Unhook the 'view all' query var adder
remove_filter( 'bbp_get_forum_permalink', 'bbp_add_view_all' );
// Get some forum data
$tc_int = bbp_get_forum_topic_count( $forum_id, false );
$rc_int = bbp_get_forum_reply_count( $forum_id, false );
$topic_count = bbp_get_forum_topic_count( $forum_id );
$reply_count = bbp_get_forum_reply_count( $forum_id );
$last_active = bbp_get_forum_last_active_id( $forum_id );
// Has replies
if ( !empty( $reply_count ) ) {
$reply_text = sprintf( _n( '%s reply', '%s replies', $rc_int, 'bbpress' ), $reply_count );
}
// Forum has active data
if ( !empty( $last_active ) ) {
$topic_text = bbp_get_forum_topics_link( $forum_id );
$time_since = bbp_get_forum_freshness_link( $forum_id );
$last_updated_by = bbp_get_author_link( array( 'post_id' => $last_active, 'size' => $r['size'] ) );
// Forum has no last active data
} else {
$topic_text = sprintf( _n( '%s topic', '%s topics', $tc_int, 'bbpress' ), $topic_count );
}
// Forum has active data
if ( !empty( $last_active ) ) {
if ( !empty( $reply_count ) ) {
if ( bbp_is_forum_category( $forum_id ) ) {
$retstr = sprintf( esc_html__( 'This category contains %1$s and %2$s, and was last updated by %3$s %4$s.', 'bbpress' ), $topic_text, $reply_text, $last_updated_by, $time_since );
} else {
$retstr = sprintf( esc_html__( 'This forum contains %1$s and %2$s, and was last updated by %3$s %4$s.', 'bbpress' ), $topic_text, $reply_text, $last_updated_by, $time_since );
}
} else {
if ( bbp_is_forum_category( $forum_id ) ) {
$retstr = sprintf( esc_html__( 'This category contains %1$s, and was last updated by %2$s %3$s.', 'bbpress' ), $topic_text, $last_updated_by, $time_since );
} else {
$retstr = sprintf( esc_html__( 'This forum contains %1$s, and was last updated by %2$s %3$s.', 'bbpress' ), $topic_text, $last_updated_by, $time_since );
}
}
// Forum has no last active data
} else {
if ( !empty( $reply_count ) ) {
if ( bbp_is_forum_category( $forum_id ) ) {
$retstr = sprintf( esc_html__( 'This category contains %1$s and %2$s.', 'bbpress' ), $topic_text, $reply_text );
} else {
$retstr = sprintf( esc_html__( 'This forum contains %1$s and %2$s.', 'bbpress' ), $topic_text, $reply_text );
}
} else {
if ( !empty( $topic_count ) ) {
if ( bbp_is_forum_category( $forum_id ) ) {
$retstr = sprintf( esc_html__( 'This category contains %1$s.', 'bbpress' ), $topic_text );
} else {
$retstr = sprintf( esc_html__( 'This forum contains %1$s.', 'bbpress' ), $topic_text );
}
} else {
$retstr = esc_html__( 'This forum is empty.', 'bbpress' );
}
}
}
// Add feeds
//$feed_links = ( !empty( $r['feed'] ) ) ? bbp_get_forum_topics_feed_link ( $forum_id ) . bbp_get_forum_replies_feed_link( $forum_id ) : '';
// Add the 'view all' filter back
add_filter( 'bbp_get_forum_permalink', 'bbp_add_view_all' );
// Combine the elements together
$retstr = $r['before'] . $retstr . $r['after'];
// Return filtered result
return apply_filters( 'bbp_get_single_forum_description', $retstr, $r );
}
/** Forms *********************************************************************/
/**
* Output the value of forum title field
*
* @since bbPress (r3551)
*
* @uses bbp_get_form_forum_title() To get the value of forum title field
*/
function bbp_form_forum_title() {
echo bbp_get_form_forum_title();
}
/**
* Return the value of forum title field
*
* @since bbPress (r3551)
*
* @uses bbp_is_forum_edit() To check if it's forum edit page
* @uses apply_filters() Calls 'bbp_get_form_forum_title' with the title
* @return string Value of forum title field
*/
function bbp_get_form_forum_title() {
// Get _POST data
if ( bbp_is_post_request() && isset( $_POST['bbp_forum_title'] ) ) {
$forum_title = $_POST['bbp_forum_title'];
// Get edit data
} elseif ( bbp_is_forum_edit() ) {
$forum_title = bbp_get_global_post_field( 'post_title', 'raw' );
// No data
} else {
$forum_title = '';
}
return apply_filters( 'bbp_get_form_forum_title', esc_attr( $forum_title ) );
}
/**
* Output the value of forum content field
*
* @since bbPress (r3551)
*
* @uses bbp_get_form_forum_content() To get value of forum content field
*/
function bbp_form_forum_content() {
echo bbp_get_form_forum_content();
}
/**
* Return the value of forum content field
*
* @since bbPress (r3551)
*
* @uses bbp_is_forum_edit() To check if it's the forum edit page
* @uses apply_filters() Calls 'bbp_get_form_forum_content' with the content
* @return string Value of forum content field
*/
function bbp_get_form_forum_content() {
// Get _POST data
if ( bbp_is_post_request() && isset( $_POST['bbp_forum_content'] ) ) {
$forum_content = stripslashes( $_POST['bbp_forum_content'] );
// Get edit data
} elseif ( bbp_is_forum_edit() ) {
$forum_content = bbp_get_global_post_field( 'post_content', 'raw' );
// No data
} else {
$forum_content = '';
}
return apply_filters( 'bbp_get_form_forum_content', $forum_content );
}
/**
* Output value of forum parent
*
* @since bbPress (r3551)
*
* @uses bbp_get_form_forum_parent() To get the topic's forum id
*/
function bbp_form_forum_parent() {
echo bbp_get_form_forum_parent();
}
/**
* Return value of forum parent
*
* @since bbPress (r3551)
*
* @uses bbp_is_topic_edit() To check if it's the topic edit page
* @uses bbp_get_forum_parent_id() To get the topic forum id
* @uses apply_filters() Calls 'bbp_get_form_forum_parent' with the forum
* @return string Value of topic content field
*/
function bbp_get_form_forum_parent() {
// Get _POST data
if ( bbp_is_post_request() && isset( $_POST['bbp_forum_id'] ) ) {
$forum_parent = $_POST['bbp_forum_id'];
// Get edit data
} elseif ( bbp_is_forum_edit() ) {
$forum_parent = bbp_get_forum_parent_id();
// No data
} else {
$forum_parent = 0;
}
return apply_filters( 'bbp_get_form_forum_parent', esc_attr( $forum_parent ) );
}
/**
* Output value of forum type
*
* @since bbPress (r3563)
*
* @uses bbp_get_form_forum_type() To get the topic's forum id
*/
function bbp_form_forum_type() {
echo bbp_get_form_forum_type();
}
/**
* Return value of forum type
*
* @since bbPress (r3563)
*
* @uses bbp_is_topic_edit() To check if it's the topic edit page
* @uses bbp_get_forum_type_id() To get the topic forum id
* @uses apply_filters() Calls 'bbp_get_form_forum_type' with the forum
* @return string Value of topic content field
*/
function bbp_get_form_forum_type() {
// Get _POST data
if ( bbp_is_post_request() && isset( $_POST['bbp_forum_type'] ) ) {
$forum_type = $_POST['bbp_forum_type'];
// Get edit data
} elseif ( bbp_is_forum_edit() ) {
$forum_type = bbp_get_forum_type();
// No data
} else {
$forum_type = 'forum';
}
return apply_filters( 'bbp_get_form_forum_type', esc_attr( $forum_type ) );
}
/**
* Output value of forum visibility
*
* @since bbPress (r3563)
*
* @uses bbp_get_form_forum_visibility() To get the topic's forum id
*/
function bbp_form_forum_visibility() {
echo bbp_get_form_forum_visibility();
}
/**
* Return value of forum visibility
*
* @since bbPress (r3563)
*
* @uses bbp_is_topic_edit() To check if it's the topic edit page
* @uses bbp_get_forum_visibility_id() To get the topic forum id
* @uses apply_filters() Calls 'bbp_get_form_forum_visibility' with the forum
* @return string Value of topic content field
*/
function bbp_get_form_forum_visibility() {
// Get _POST data
if ( bbp_is_post_request() && isset( $_POST['bbp_forum_visibility'] ) ) {
$forum_visibility = $_POST['bbp_forum_visibility'];
// Get edit data
} elseif ( bbp_is_forum_edit() ) {
$forum_visibility = bbp_get_forum_visibility();
// No data
} else {
$forum_visibility = bbpress()->public_status_id;
}
return apply_filters( 'bbp_get_form_forum_visibility', esc_attr( $forum_visibility ) );
}
/**
* Output checked value of forum subscription
*
* @since bbPress (r5156)
*
* @uses bbp_get_form_forum_subscribed() To get the subscribed checkbox value
*/
function bbp_form_forum_subscribed() {
echo bbp_get_form_forum_subscribed();
}
/**
* Return checked value of forum subscription
*
* @since bbPress (r5156)
*
* @uses bbp_is_forum_edit() To check if it's the forum edit page
* @uses bbp_get_global_post_field() To get current post author
* @uses bbp_get_current_user_id() To get the current user id
* @uses bbp_is_user_subscribed_to_forum() To check if the user is
* subscribed to the forum
* @uses apply_filters() Calls 'bbp_get_form_forum_subscribed' with the
* option
* @return string Checked value of forum subscription
*/
function bbp_get_form_forum_subscribed() {
// Get _POST data
if ( bbp_is_post_request() && isset( $_POST['bbp_forum_subscription'] ) ) {
$forum_subscribed = (bool) $_POST['bbp_forum_subscription'];
// Get edit data
} elseif ( bbp_is_forum_edit() || bbp_is_reply_edit() ) {
// Get current posts author
$post_author = bbp_get_global_post_field( 'post_author', 'raw' );
// Post author is not the current user
if ( bbp_get_current_user_id() !== $post_author ) {
$forum_subscribed = bbp_is_user_subscribed_to_forum( $post_author );
// Post author is the current user
} else {
$forum_subscribed = bbp_is_user_subscribed_to_forum( bbp_get_current_user_id() );
}
// Get current status
} elseif ( bbp_is_single_forum() ) {
$forum_subscribed = bbp_is_user_subscribed_to_forum( bbp_get_current_user_id() );
// No data
} else {
$forum_subscribed = false;
}
// Get checked output
$checked = checked( $forum_subscribed, true, false );
return apply_filters( 'bbp_get_form_forum_subscribed', $checked, $forum_subscribed );
}
/** Form Dropdowns ************************************************************/
/**
* Output value forum type dropdown
*
* @since bbPress (r3563)
*
* @param int $forum_id The forum id to use
* @uses bbp_get_form_forum_type() To get the topic's forum id
*/
function bbp_form_forum_type_dropdown( $args = '' ) {
echo bbp_get_form_forum_type_dropdown( $args );
}
/**
* Return the forum type dropdown
*
* @since bbPress (r3563)
*
* @param int $forum_id The forum id to use
* @uses bbp_is_topic_edit() To check if it's the topic edit page
* @uses bbp_get_forum_type() To get the forum type
* @uses apply_filters()
* @return string HTML select list for selecting forum type
*/
function bbp_get_form_forum_type_dropdown( $args = '' ) {
// Backpat for handling passing of a forum ID as integer
if ( is_int( $args ) ) {
$forum_id = (int) $args;
$args = array();
} else {
$forum_id = 0;
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'select_id' => 'bbp_forum_type',
'tab' => bbp_get_tab_index(),
'forum_id' => $forum_id,
'selected' => false
), 'forum_type_select' );
// No specific selected value passed
if ( empty( $r['selected'] ) ) {
// Post value is passed
if ( bbp_is_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
$r['selected'] = $_POST[ $r['select_id'] ];
// No Post value was passed
} else {
// Edit topic
if ( bbp_is_forum_edit() ) {
$r['forum_id'] = bbp_get_forum_id( $r['forum_id'] );
$r['selected'] = bbp_get_forum_type( $r['forum_id'] );
// New topic
} else {
$r['selected'] = bbp_get_public_status_id();
}
}
}
// Used variables
$tab = ! empty( $r['tab'] ) ? ' tabindex="' . (int) $r['tab'] . '"' : '';
// Start an output buffer, we'll finish it after the select loop
ob_start(); ?>
<select name="<?php echo esc_attr( $r['select_id'] ) ?>" id="<?php echo esc_attr( $r['select_id'] ) ?>_select"<?php echo $tab; ?>>
<?php foreach ( bbp_get_forum_types() as $key => $label ) : ?>
<option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
<?php endforeach; ?>
</select>
<?php
// Return the results
return apply_filters( 'bbp_get_form_forum_type_dropdown', ob_get_clean(), $r );
}
/**
* Output value forum status dropdown
*
* @since bbPress (r3563)
*
* @param int $forum_id The forum id to use
* @uses bbp_get_form_forum_status() To get the topic's forum id
*/
function bbp_form_forum_status_dropdown( $args = '' ) {
echo bbp_get_form_forum_status_dropdown( $args );
}
/**
* Return the forum status dropdown
*
* @since bbPress (r3563)
*
* @param int $forum_id The forum id to use
* @uses bbp_is_topic_edit() To check if it's the topic edit page
* @uses bbp_get_forum_status() To get the forum status
* @uses apply_filters()
* @return string HTML select list for selecting forum status
*/
function bbp_get_form_forum_status_dropdown( $args = '' ) {
// Backpat for handling passing of a forum ID
if ( is_int( $args ) ) {
$forum_id = (int) $args;
$args = array();
} else {
$forum_id = 0;
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'select_id' => 'bbp_forum_status',
'tab' => bbp_get_tab_index(),
'forum_id' => $forum_id,
'selected' => false
), 'forum_status_select' );
// No specific selected value passed
if ( empty( $r['selected'] ) ) {
// Post value is passed
if ( bbp_is_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
$r['selected'] = $_POST[ $r['select_id'] ];
// No Post value was passed
} else {
// Edit topic
if ( bbp_is_forum_edit() ) {
$r['forum_id'] = bbp_get_forum_id( $r['forum_id'] );
$r['selected'] = bbp_get_forum_status( $r['forum_id'] );
// New topic
} else {
$r['selected'] = bbp_get_public_status_id();
}
}
}
// Used variables
$tab = ! empty( $r['tab'] ) ? ' tabindex="' . (int) $r['tab'] . '"' : '';
// Start an output buffer, we'll finish it after the select loop
ob_start(); ?>
<select name="<?php echo esc_attr( $r['select_id'] ) ?>" id="<?php echo esc_attr( $r['select_id'] ) ?>_select"<?php echo $tab; ?>>
<?php foreach ( bbp_get_forum_statuses() as $key => $label ) : ?>
<option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
<?php endforeach; ?>
</select>
<?php
// Return the results
return apply_filters( 'bbp_get_form_forum_status_dropdown', ob_get_clean(), $r );
}
/**
* Output value forum visibility dropdown
*
* @since bbPress (r3563)
*
* @param int $forum_id The forum id to use
* @uses bbp_get_form_forum_visibility() To get the topic's forum id
*/
function bbp_form_forum_visibility_dropdown( $args = '' ) {
echo bbp_get_form_forum_visibility_dropdown( $args );
}
/**
* Return the forum visibility dropdown
*
* @since bbPress (r3563)
*
* @param int $forum_id The forum id to use
* @uses bbp_is_topic_edit() To check if it's the topic edit page
* @uses bbp_get_forum_visibility() To get the forum visibility
* @uses apply_filters()
* @return string HTML select list for selecting forum visibility
*/
function bbp_get_form_forum_visibility_dropdown( $args = '' ) {
// Backpat for handling passing of a forum ID
if ( is_int( $args ) ) {
$forum_id = (int) $args;
$args = array();
} else {
$forum_id = 0;
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'select_id' => 'bbp_forum_visibility',
'tab' => bbp_get_tab_index(),
'forum_id' => $forum_id,
'selected' => false
), 'forum_type_select' );
// No specific selected value passed
if ( empty( $r['selected'] ) ) {
// Post value is passed
if ( bbp_is_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
$r['selected'] = $_POST[ $r['select_id'] ];
// No Post value was passed
} else {
// Edit topic
if ( bbp_is_forum_edit() ) {
$r['forum_id'] = bbp_get_forum_id( $r['forum_id'] );
$r['selected'] = bbp_get_forum_visibility( $r['forum_id'] );
// New topic
} else {
$r['selected'] = bbp_get_public_status_id();
}
}
}
// Used variables
$tab = ! empty( $r['tab'] ) ? ' tabindex="' . (int) $r['tab'] . '"' : '';
// Start an output buffer, we'll finish it after the select loop
ob_start(); ?>
<select name="<?php echo esc_attr( $r['select_id'] ) ?>" id="<?php echo esc_attr( $r['select_id'] ) ?>_select"<?php echo $tab; ?>>
<?php foreach ( bbp_get_forum_visibilities() as $key => $label ) : ?>
<option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
<?php endforeach; ?>
</select>
<?php
// Return the results
return apply_filters( 'bbp_get_form_forum_type_dropdown', ob_get_clean(), $r );
}
/** Feeds *********************************************************************/
/**
* Output the link for the forum feed
*
* @since bbPress (r3172)
*
* @param type $forum_id Optional. Forum ID.
*
* @uses bbp_get_forum_topics_feed_link()
*/
function bbp_forum_topics_feed_link( $forum_id = 0 ) {
echo bbp_get_forum_topics_feed_link( $forum_id );
}
/**
* Retrieve the link for the forum feed
*
* @since bbPress (r3172)
*
* @param int $forum_id Optional. Forum ID.
*
* @uses bbp_get_forum_id()
* @uses get_option()
* @uses trailingslashit()
* @uses bbp_get_forum_permalink()
* @uses user_trailingslashit()
* @uses bbp_get_forum_post_type()
* @uses get_post_field()
* @uses apply_filters()
*
* @return string
*/
function bbp_get_forum_topics_feed_link( $forum_id = 0 ) {
// Validate forum id
$forum_id = bbp_get_forum_id( $forum_id );
// Forum is valid
if ( !empty( $forum_id ) ) {
// Define local variable(s)
$link = '';
// Pretty permalinks
if ( get_option( 'permalink_structure' ) ) {
// Forum link
$url = trailingslashit( bbp_get_forum_permalink( $forum_id ) ) . 'feed';
$url = user_trailingslashit( $url, 'single_feed' );
// Unpretty permalinks
} else {
$url = home_url( add_query_arg( array(
'feed' => 'rss2',
bbp_get_forum_post_type() => get_post_field( 'post_name', $forum_id )
) ) );
}
$link = '<a href="' . esc_url( $url ) . '" class="bbp-forum-rss-link topics"><span>' . esc_attr__( 'Topics', 'bbpress' ) . '</span></a>';
}
return apply_filters( 'bbp_get_forum_topics_feed_link', $link, $url, $forum_id );
}
/**
* Output the link for the forum replies feed
*
* @since bbPress (r3172)
*
* @param type $forum_id Optional. Forum ID.
*
* @uses bbp_get_forum_replies_feed_link()
*/
function bbp_forum_replies_feed_link( $forum_id = 0 ) {
echo bbp_get_forum_replies_feed_link( $forum_id );
}
/**
* Retrieve the link for the forum replies feed
*
* @since bbPress (r3172)
*
* @param int $forum_id Optional. Forum ID.
*
* @uses bbp_get_forum_id()
* @uses get_option()
* @uses trailingslashit()
* @uses bbp_get_forum_permalink()
* @uses user_trailingslashit()
* @uses bbp_get_forum_post_type()
* @uses get_post_field()
* @uses apply_filters()
*
* @return string
*/
function bbp_get_forum_replies_feed_link( $forum_id = 0 ) {
// Validate forum id
$forum_id = bbp_get_forum_id( $forum_id );
// Forum is valid
if ( !empty( $forum_id ) ) {
// Define local variable(s)
$link = '';
// Pretty permalinks
if ( get_option( 'permalink_structure' ) ) {
// Forum link
$url = trailingslashit( bbp_get_forum_permalink( $forum_id ) ) . 'feed';
$url = user_trailingslashit( $url, 'single_feed' );
$url = add_query_arg( array( 'type' => 'reply' ), $url );
// Unpretty permalinks
} else {
$url = home_url( add_query_arg( array(
'type' => 'reply',
'feed' => 'rss2',
bbp_get_forum_post_type() => get_post_field( 'post_name', $forum_id )
) ) );
}
$link = '<a href="' . esc_url( $url ) . '" class="bbp-forum-rss-link replies"><span>' . esc_html__( 'Replies', 'bbpress' ) . '</span></a>';
}
return apply_filters( 'bbp_get_forum_replies_feed_link', $link, $url, $forum_id );
}
Mini Shell