[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

/src/includes/forums/ -> template.php (summary)

[Source view] [Print] [Project Stats]

bbPress Forum Template Tags

File Size: 2719 lines (80 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 117 functions

  bbp_forum_post_type()
  bbp_get_forum_post_type()
  bbp_get_forum_post_type_labels()
  bbp_get_forum_post_type_rewrite()
  bbp_get_forum_post_type_supports()
  bbp_has_forums()
  bbp_forums()
  bbp_the_forum()
  bbp_forum_id()
  bbp_get_forum_id()
  bbp_get_forum()
  bbp_forum_permalink()
  bbp_get_forum_permalink()
  bbp_forum_title()
  bbp_get_forum_title()
  bbp_forum_archive_title()
  bbp_get_forum_archive_title()
  bbp_forum_content()
  bbp_get_forum_content()
  bbp_forum_row_actions()
  bbp_forum_last_active_id()
  bbp_get_forum_last_active_id()
  bbp_forum_last_active_time()
  bbp_get_forum_last_active_time()
  bbp_forum_freshness_link()
  bbp_get_forum_freshness_link()
  bbp_forum_parent_id()
  bbp_get_forum_parent_id()
  bbp_get_forum_ancestors()
  bbp_forum_get_subforums()
  bbp_list_forums()
  bbp_forum_subscription_link()
  bbp_get_forum_subscription_link()
  bbp_forum_last_topic_id()
  bbp_get_forum_last_topic_id()
  bbp_forum_last_topic_title()
  bbp_get_forum_last_topic_title()
  bbp_forum_last_topic_permalink()
  bbp_get_forum_last_topic_permalink()
  bbp_get_forum_last_topic_author_id()
  bbp_forum_last_topic_author_link()
  bbp_get_forum_last_topic_author_link()
  bbp_forum_last_reply_id()
  bbp_get_forum_last_reply_id()
  bbp_forum_last_reply_title()
  bbp_get_forum_last_reply_title()
  bbp_forum_last_reply_permalink()
  bbp_get_forum_last_reply_permalink()
  bbp_forum_last_reply_url()
  bbp_get_forum_last_reply_url()
  bbp_forum_last_reply_author_id()
  bbp_get_forum_last_reply_author_id()
  bbp_forum_last_reply_author_link()
  bbp_get_forum_last_reply_author_link()
  bbp_forum_topics_link()
  bbp_get_forum_topics_link()
  bbp_forum_subforum_count()
  bbp_get_forum_subforum_count()
  bbp_forum_topic_count()
  bbp_get_forum_topic_count()
  bbp_forum_reply_count()
  bbp_get_forum_reply_count()
  bbp_forum_post_count()
  bbp_get_forum_post_count()
  bbp_forum_topic_count_hidden()
  bbp_get_forum_topic_count_hidden()
  bbp_forum_reply_count_hidden()
  bbp_get_forum_reply_count_hidden()
  bbp_forum_status()
  bbp_get_forum_status()
  bbp_forum_visibility()
  bbp_get_forum_visibility()
  bbp_forum_type()
  bbp_get_forum_type()
  bbp_is_forum_category()
  bbp_is_forum_open()
  bbp_is_forum_closed()
  bbp_is_forum_status()
  bbp_is_forum_public()
  bbp_is_forum_private()
  bbp_is_forum_hidden()
  bbp_is_forum_visibility()
  bbp_forum_author_id()
  bbp_get_forum_author_id()
  bbp_forum_author_display_name()
  bbp_get_forum_author_display_name()
  bbp_suppress_private_forum_meta()
  bbp_suppress_private_author_link()
  bbp_forum_class()
  bbp_get_forum_class()
  bbp_single_forum_description()
  bbp_get_single_forum_description()
  bbp_form_forum_title()
  bbp_get_form_forum_title()
  bbp_form_forum_content()
  bbp_get_form_forum_content()
  bbp_form_forum_moderators()
  bbp_get_form_forum_moderators()
  bbp_form_forum_parent()
  bbp_get_form_forum_parent()
  bbp_form_forum_type()
  bbp_get_form_forum_type()
  bbp_form_forum_visibility()
  bbp_get_form_forum_visibility()
  bbp_form_forum_subscribed()
  bbp_get_form_forum_subscribed()
  bbp_form_forum_type_dropdown()
  bbp_get_form_forum_type_dropdown()
  bbp_form_forum_status_dropdown()
  bbp_get_form_forum_status_dropdown()
  bbp_form_forum_visibility_dropdown()
  bbp_get_form_forum_visibility_dropdown()
  bbp_is_forum_form_post_request()
  bbp_forum_topics_feed_link()
  bbp_get_forum_topics_feed_link()
  bbp_forum_replies_feed_link()
  bbp_get_forum_replies_feed_link()

Functions
Functions that are not part of a class:

bbp_forum_post_type()   X-Ref
Output the unique id of the custom post type for forums

since: 2.0.0 bbPress (r2857)

bbp_get_forum_post_type()   X-Ref
Return the unique id of the custom post type for forums

return: string The unique forum post type id
since: 2.0.0 bbPress (r2857)

bbp_get_forum_post_type_labels()   X-Ref
Return array of labels used by the forum post type

return: array
since: 2.5.0 bbPress (r5129)

bbp_get_forum_post_type_rewrite()   X-Ref
Return array of forum post type rewrite settings

return: array
since: 2.5.0 bbPress (r5129)

bbp_get_forum_post_type_supports()   X-Ref
Return array of features the forum post type supports

return: array
since: 2.5.0 bbPress (r5129)

bbp_has_forums( $args = array()   X-Ref
The main forum loop.

WordPress makes this easy for us.

return: object Multidimensional array of forum information
since: 2.0.0 bbPress (r2464)
param: array $args All the arguments supported by {@link WP_Query}

bbp_forums()   X-Ref
Whether there are more forums available in the loop

return: object Forum information
since: 2.0.0 bbPress (r2464)

bbp_the_forum()   X-Ref
Loads up the current forum in the loop

return: object Forum information
since: 2.0.0 bbPress (r2464)

bbp_forum_id( $forum_id = 0 )   X-Ref
Output forum id

since: 2.0.0 bbPress (r2464)
param: $forum_id Optional. Used to check emptiness

bbp_get_forum_id( $forum_id = 0 )   X-Ref
Return the forum id

return: int The forum id
since: 2.0.0 bbPress (r2464)
param: $forum_id Optional. Used to check emptiness

bbp_get_forum( $forum, $output = OBJECT, $filter = 'raw' )   X-Ref
Gets a forum

return: mixed Null if error or forum (in specified form) if success
since: 2.0.0 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()}

bbp_forum_permalink( $forum_id = 0, $redirect_to = '' )   X-Ref
Output the link to the forum

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id
param: string $redirect_to Optional. Pass a redirect value for use with

bbp_get_forum_permalink( $forum_id = 0, $redirect_to = '' )   X-Ref
Return the link to the forum

return: string Permanent link to forum
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id
param: string $redirect_to Optional. Pass a redirect value for use with

bbp_forum_title( $forum_id = 0 )   X-Ref
Output the title of the forum

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_title( $forum_id = 0 )   X-Ref
Return the title of the forum

return: string Title of forum
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_forum_archive_title( $title = '' )   X-Ref
Output the forum archive title

since: 2.0.0 bbPress (r3249)
param: string $title Default text to use as title

bbp_get_forum_archive_title( $title = '' )   X-Ref
Return the forum archive title

return: string The forum archive title
since: 2.0.0 bbPress (r3249)
param: string $title Default text to use as title

bbp_forum_content( $forum_id = 0 )   X-Ref
Output the content of the forum

since: 2.0.0 bbPress (r2780)
param: int $forum_id Optional. Topic id

bbp_get_forum_content( $forum_id = 0 )   X-Ref
Return the content of the forum

return: string Content of the forum
since: 2.0.0 bbPress (r2780)
param: int $forum_id Optional. Topic id

bbp_forum_row_actions()   X-Ref
Allow forum rows to have administrative actions

since: 2.1.0 bbPress (r3653)

bbp_forum_last_active_id( $forum_id = 0 )   X-Ref
Output the forums last active ID

since: 2.0.0 bbPress (r2860)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_active_id( $forum_id = 0 )   X-Ref
Return the forums last active ID

return: int Forum's last active id
since: 2.0.0 bbPress (r2860)
param: int $forum_id Optional. Forum id

bbp_forum_last_active_time( $forum_id = 0 )   X-Ref
Output the forums last update date/time (aka freshness)

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_active_time( $forum_id = 0 )   X-Ref
Return the forums last update date/time (aka freshness)

return: string Forum last update date/time (freshness)
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_forum_freshness_link( $forum_id = 0)   X-Ref
Output link to the most recent activity inside a forum.

Outputs a complete link with attributes and content.

since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_get_forum_freshness_link( $forum_id = 0 )   X-Ref
Returns link to the most recent activity inside a forum.

Returns a complete link with attributes and content.

since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_parent_id( $forum_id = 0 )   X-Ref
Output parent ID of a forum, if exists

since: 2.1.0 bbPress (r3675)
param: int $forum_id Forum ID

bbp_get_forum_parent_id( $forum_id = 0 )   X-Ref
Return ID of forum parent, if exists

return: int Forum parent
since: 2.1.0 bbPress (r3675)
param: int $forum_id Optional. Forum id

bbp_get_forum_ancestors( $forum_id = 0 )   X-Ref
Return array of parent forums

return: array Forum ancestors
since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_get_subforums( $args = array()   X-Ref
Return subforums of given forum

return: mixed false if none, array of subs if yes
since: 2.0.0 bbPress (r2747)
param: array $args All the arguments supported by {@link WP_Query}

bbp_list_forums( $args = array()   X-Ref
Output a list of forums (can be used to list subforums)

since: 2.0.0 bbPress (r2708)
param: array $args The function supports these args:

bbp_forum_subscription_link( $args = array()   X-Ref
Output the forum subscription link

since: 2.5.0 bbPress (r5156)
since: 2.6.0 bbPress (r6308) Add 'redirect_to' support

bbp_get_forum_subscription_link( $args = array()   X-Ref
Get the forum subscription link

A custom wrapper for bbp_get_user_subscribe_link()

since: 2.5.0 bbPress (r5156)
since: 2.6.0 bbPress (r6308) Add 'redirect_to' support

bbp_forum_last_topic_id( $forum_id = 0 )   X-Ref
Output the forum's last topic id

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_topic_id( $forum_id = 0 )   X-Ref
Return the forum's last topic id

return: int Forum's last topic id
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_forum_last_topic_title( $forum_id = 0 )   X-Ref
Output the title of the last topic inside a forum

since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_topic_title( $forum_id = 0 )   X-Ref
Return the title of the last topic inside a forum

return: string Forum's last topic's title
since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_last_topic_permalink( $forum_id = 0 )   X-Ref
Output the link to the last topic in a forum

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_topic_permalink( $forum_id = 0 )   X-Ref
Return the link to the last topic in a forum

return: string Permanent link to topic
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_topic_author_id( $forum_id = 0 )   X-Ref
Return the author ID of the last topic of a forum

return: int Forum's last topic's author id
since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_last_topic_author_link( $forum_id = 0 )   X-Ref
Output link to author of last topic of forum

since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_topic_author_link( $forum_id = 0 )   X-Ref
Return link to author of last topic of forum

return: string Forum's last topic's author link
since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_last_reply_id( $forum_id = 0 )   X-Ref
Output the forums last reply id

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_reply_id( $forum_id = 0 )   X-Ref
Return the forums last reply id

return: int Forum's last reply id
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_forum_last_reply_title( $forum_id = 0 )   X-Ref
Output the title of the last reply inside a forum

param: int $forum_id Optional. Forum id

bbp_get_forum_last_reply_title( $forum_id = 0 )   X-Ref
Return the title of the last reply inside a forum

return: string
param: int $forum_id Optional. Forum id

bbp_forum_last_reply_permalink( $forum_id = 0 )   X-Ref
Output the link to the last reply in a forum

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_reply_permalink( $forum_id = 0 )   X-Ref
Return the link to the last reply in a forum

return: string Permanent link to the forum's last reply
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id

bbp_forum_last_reply_url( $forum_id = 0 )   X-Ref
Output the url to the last reply in a forum

since: 2.0.0 bbPress (r2683)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_reply_url( $forum_id = 0 )   X-Ref
Return the url to the last reply in a forum

return: string Paginated URL to latest reply
since: 2.0.0 bbPress (r2683)
param: int $forum_id Optional. Forum id

bbp_forum_last_reply_author_id( $forum_id = 0 )   X-Ref
Output author ID of last reply of forum

since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_reply_author_id( $forum_id = 0 )   X-Ref
Return author ID of last reply of forum

return: int Forum's last reply author id
since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_last_reply_author_link( $forum_id = 0 )   X-Ref
Output link to author of last reply of forum

since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_get_forum_last_reply_author_link( $forum_id = 0 )   X-Ref
Return link to author of last reply of forum

return: string Link to author of last reply of forum
since: 2.0.0 bbPress (r2625)
param: int $forum_id Optional. Forum id

bbp_forum_topics_link( $forum_id = 0 )   X-Ref
Output the topics link of the forum

since: 2.0.0 bbPress (r2883)
param: int $forum_id Optional. Topic id

bbp_get_forum_topics_link( $forum_id = 0 )   X-Ref
Return the topics link of the forum

since: 2.0.0 bbPress (r2883)
param: int $forum_id Optional. Topic id

bbp_forum_subforum_count( $forum_id = 0, $integer = false )   X-Ref
Output total sub-forum count of a forum

since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id to check
param: boolean $integer Optional. Whether or not to format the result

bbp_get_forum_subforum_count( $forum_id = 0, $integer = false )   X-Ref
Return total subforum count of a forum

return: int Forum's subforum count
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id
param: boolean $integer Optional. Whether or not to format the result

bbp_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Output total topic count of a forum

since: 2.0.0 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

bbp_get_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Return total topic count of a forum

return: int Forum topic count
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id
param: bool $total_count Optional. To get the total count or normal
param: boolean $integer Optional. Whether or not to format the result

bbp_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Output total reply count of a forum

since: 2.0.0 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

bbp_get_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Return total post count of a forum

return: int Forum reply count
since: 2.0.0 bbPress (r2464)
param: int $forum_id Optional. Forum id
param: bool $total_count Optional. To get the total count or normal
param: boolean $integer Optional. Whether or not to format the result

bbp_forum_post_count( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Output total post count of a forum

since: 2.0.0 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

bbp_get_forum_post_count( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Return total post count of a forum

return: int Forum post count
since: 2.0.0 bbPress (r2954)
param: int $forum_id Optional. Forum id
param: bool $total_count Optional. To get the total count or normal
param: boolean $integer Optional. Whether or not to format the result

bbp_forum_topic_count_hidden( $forum_id = 0, $total_count = true, $integer = null )   X-Ref
Output total hidden topic count of a forum (hidden includes trashed, spammed,
and pending topics)

since: 2.0.0 bbPress (r2883)
since: 2.6.0 bbPress (r6922) Changed function signature to add total counts
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

bbp_get_forum_topic_count_hidden( $forum_id = 0, $total_count = true, $integer = null )   X-Ref
Return total hidden topic count of a forum (hidden includes trashed,
spammed and pending topics)

return: int Topic hidden topic count
since: 2.0.0 bbPress (r2883)
since: 2.6.0 bbPress (r6922) Changed function signature to add total counts
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

bbp_forum_reply_count_hidden( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Output total hidden reply count of a forum (hidden includes trashed, spammed,
and pending replies)

since: 2.6.0 bbPress (r6922)
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

bbp_get_forum_reply_count_hidden( $forum_id = 0, $total_count = true, $integer = false )   X-Ref
Return total hidden reply count of a forum (hidden includes trashed,
spammed and pending replies)

return: int Forum reply count
since: 2.6.0 bbPress (r6922)
param: int $forum_id Optional. Forum id
param: bool $total_count Optional. To get the total count or normal
param: boolean $integer Optional. Whether or not to format the result

bbp_forum_status( $forum_id = 0 )   X-Ref
Output the status of the forum

since: 2.0.0 bbPress (r2667)
param: int $forum_id Optional. Forum id

bbp_get_forum_status( $forum_id = 0 )   X-Ref
Return the status of the forum

return: string Status of forum
since: 2.0.0 bbPress (r2667)
param: int $forum_id Optional. Forum id

bbp_forum_visibility( $forum_id = 0 )   X-Ref
Output the visibility of the forum

since: 2.0.0 bbPress (r2997)
param: int $forum_id Optional. Forum id

bbp_get_forum_visibility( $forum_id = 0 )   X-Ref
Return the visibility of the forum

return: string Status of forum
since: 2.0.0 bbPress (r2997)
param: int $forum_id Optional. Forum id

bbp_forum_type( $forum_id = 0 )   X-Ref
Output the type of the forum

since: 2.1.0 bbPress (r3563)
param: int $forum_id Optional. Forum id

bbp_get_forum_type( $forum_id = 0 )   X-Ref
Return the type of forum (category/forum/etc...)

return: bool Whether the forum is a category or not
since: 2.1.0 bbPress (r3563)
param: int $forum_id Optional. Forum id

bbp_is_forum_category( $forum_id = 0 )   X-Ref
Is the forum a category?

return: bool Whether the forum is a category or not
since: 2.0.0 bbPress (r2746)
param: int $forum_id Optional. Forum id

bbp_is_forum_open( $forum_id = 0, $check_ancestors = true )   X-Ref
Is the forum open?

return: bool Whether the forum is open or not
since: 2.0.0 bbPress (r2746)
param: int $forum_id Optional. Forum id
param: bool $check_ancestors Check if the ancestors are open (only

bbp_is_forum_closed( $forum_id = 0, $check_ancestors = true )   X-Ref
Is the forum closed?

return: bool True if closed, false if not
since: 2.0.0 bbPress (r2746)
param: int $forum_id Optional. Forum id
param: bool $check_ancestors Check if the ancestors are closed (only

bbp_is_forum_status( $forum_id, $status_name, $check_ancestors = true, $operator = 'AND' )   X-Ref
Check if the forum status is a specific one, also maybe checking ancestors

return: bool True if match, false if not
since: 2.6.0 bbPress (r5499)
param: bool $status_name The forum status name to check
param: bool $check_ancestors Check the forum ancestors
param: string $operator The logical operation to perform.

bbp_is_forum_public( $forum_id = 0, $check_ancestors = true )   X-Ref
Is the forum public?

return: bool True if closed, false if not
since: 2.0.0 bbPress (r2997)
param: int $forum_id Optional. Forum id
param: bool $check_ancestors Check if the ancestors are public

bbp_is_forum_private( $forum_id = 0, $check_ancestors = true )   X-Ref
Is the forum private?

return: bool True if private, false if not
since: 2.0.0 bbPress (r2746)
param: int $forum_id Optional. Forum id
param: bool $check_ancestors Check if the ancestors are private

bbp_is_forum_hidden( $forum_id = 0, $check_ancestors = true )   X-Ref
Is the forum hidden?

return: bool True if hidden, false if not
since: 2.0.0 bbPress (r2997)
param: int $forum_id Optional. Forum id
param: bool $check_ancestors Check if the ancestors are private (only if

bbp_is_forum_visibility( $forum_id, $status_name, $check_ancestors = true, $operator = 'AND' )   X-Ref
Check the forum visibility ID

return: bool True if match, false if not
since: 2.6.0 bbPress (r5499)
param: int $forum_id Optional. Forum id
param: bool $status_name The post status name to check
param: bool $check_ancestors Check the forum ancestors
param: string $operator The logical operation to perform.

bbp_forum_author_id( $forum_id = 0 )   X-Ref
Output the author ID of the forum

since: 2.1.0 bbPress (r3675)
param: int $forum_id Optional. Forum id

bbp_get_forum_author_id( $forum_id = 0 )   X-Ref
Return the author ID of the forum

return: string Author of forum
since: 2.1.0 bbPress (r3675)
param: int $forum_id Optional. Forum id

bbp_forum_author_display_name( $forum_id = 0 )   X-Ref
Output the author of the forum

since: 2.1.0 bbPress (r3675)
param: int $forum_id Optional. Forum id

bbp_get_forum_author_display_name( $forum_id = 0 )   X-Ref
Return the author of the forum

return: string Author of forum
since: 2.1.0 bbPress (r3675)
param: int $forum_id Optional. Forum id

bbp_suppress_private_forum_meta( $retval, $forum_id )   X-Ref
Replace forum meta details for users that cannot view them.

return: string
since: 2.0.0 bbPress (r3162)
param: string $retval
param: int $forum_id

bbp_suppress_private_author_link( $author_link = '', $args = array()   X-Ref
Replace forum author details for users that cannot view them.

return: string
since: 2.0.0 bbPress (r3162)
param: string $author_link
param: array $args

bbp_forum_class( $forum_id = 0, $classes = array()   X-Ref
Output the row class of a forum

since: 2.0.0 bbPress (r2667)
param: int $forum_id Optional. Forum ID.
param: array Extra classes you can pass when calling this function

bbp_get_forum_class( $forum_id = 0, $classes = array()   X-Ref
Return the row class of a forum

return: string Row class of the forum
since: 2.0.0 bbPress (r2667)
param: int $forum_id Optional. Forum ID
param: array Extra classes you can pass when calling this function

bbp_single_forum_description( $args = array()   X-Ref
Output a fancy description of the current forum, including total topics,
total replies, and last activity.

since: 2.0.0 bbPress (r2860)
param: array $args Arguments passed to alter output

bbp_get_single_forum_description( $args = array()   X-Ref
Return a fancy description of the current forum, including total
topics, total replies, and last activity.

return: string Filtered forum description
since: 2.0.0 bbPress (r2860)
param: array $args This function supports these arguments:

bbp_form_forum_title()   X-Ref
Output the value of forum title field

since: 2.1.0 bbPress (r3551)

bbp_get_form_forum_title()   X-Ref
Return the value of forum title field

return: string Value of forum title field
since: 2.1.0 bbPress (r3551)

bbp_form_forum_content()   X-Ref
Output the value of forum content field

since: 2.1.0 bbPress (r3551)

bbp_get_form_forum_content()   X-Ref
Return the value of forum content field

return: string Value of forum content field
since: 2.1.0 bbPress (r3551)

bbp_form_forum_moderators()   X-Ref
Output value of forum moderators field

since: 2.6.0 bbPress (r5837)

bbp_get_form_forum_moderators()   X-Ref
Return value of forum moderators field

return: string Value of forum mods field
since: 2.6.0 bbPress (r5837)

bbp_form_forum_parent()   X-Ref
Output value of forum parent

since: 2.1.0 bbPress (r3551)

bbp_get_form_forum_parent()   X-Ref
Return value of forum parent

return: string Value of topic content field
since: 2.1.0 bbPress (r3551)

bbp_form_forum_type()   X-Ref
Output value of forum type

since: 2.1.0 bbPress (r3563)

bbp_get_form_forum_type()   X-Ref
Return value of forum type

return: string Value of topic content field
since: 2.1.0 bbPress (r3563)

bbp_form_forum_visibility()   X-Ref
Output value of forum visibility

since: 2.1.0 bbPress (r3563)

bbp_get_form_forum_visibility()   X-Ref
Return value of forum visibility

return: string Value of topic content field
since: 2.1.0 bbPress (r3563)

bbp_form_forum_subscribed()   X-Ref
Output checked value of forum subscription

since: 2.5.0 bbPress (r5156)

bbp_get_form_forum_subscribed()   X-Ref
Return checked value of forum subscription

return: string Checked value of forum subscription
since: 2.5.0 bbPress (r5156)

bbp_form_forum_type_dropdown( $args = array()   X-Ref
Output value forum type dropdown

since: 2.1.0 bbPress (r3563)
param: $args This function supports these arguments:

bbp_get_form_forum_type_dropdown( $args = array()   X-Ref
Return the forum type dropdown

return: string HTML select list for selecting forum type
since: 2.1.0 bbPress (r3563)
param: $args This function supports these arguments:

bbp_form_forum_status_dropdown( $args = array()   X-Ref
Output value forum status dropdown

since: 2.1.0 bbPress (r3563)
param: $args This function supports these arguments:

bbp_get_form_forum_status_dropdown( $args = array()   X-Ref
Return the forum status dropdown

return: string HTML select list for selecting forum status
since: 2.1.0 bbPress (r3563)
param: $args This function supports these arguments:

bbp_form_forum_visibility_dropdown( $args = array()   X-Ref
Output value forum visibility dropdown

since: 2.1.0 bbPress (r3563)
param: $args This function supports these arguments:

bbp_get_form_forum_visibility_dropdown( $args = array()   X-Ref
Return the forum visibility dropdown

return: string HTML select list for selecting forum visibility
since: 2.1.0 bbPress (r3563)
param: $args This function supports these arguments:

bbp_is_forum_form_post_request()   X-Ref
Verify if a POST request came from a failed forum attempt.

Used to avoid cross-site request forgeries when checking posted forum form
content.

return: boolean True if is a post request with valid nonce
since: 2.6.0 bbPress (r5558)

bbp_forum_topics_feed_link( $forum_id = 0 )   X-Ref
Output the link for the forum feed

since: 2.0.0 bbPress (r3172)
param: int $forum_id Optional. Forum ID.

bbp_get_forum_topics_feed_link( $forum_id = 0 )   X-Ref
Retrieve the link for the forum feed

return: string
since: 2.0.0 bbPress (r3172)
param: int $forum_id Optional. Forum ID.

bbp_forum_replies_feed_link( $forum_id = 0 )   X-Ref
Output the link for the forum replies feed

since: 2.0.0 bbPress (r3172)
param: int $forum_id Optional. Forum ID.

bbp_get_forum_replies_feed_link( $forum_id = 0 )   X-Ref
Retrieve the link for the forum replies feed

return: string
since: 2.0.0 bbPress (r3172)
param: int $forum_id Optional. Forum ID.


Generated: Sat Apr 27 01:00:49 2024 Cross-referenced by PHPXref 0.7.1