[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

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

[Source view] [Print] [Project Stats]

bbPress Topic Template Tags

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

Defines 166 functions

  bbp_topic_post_type()
  bbp_get_topic_post_type()
  bbp_get_topic_post_type_labels()
  bbp_get_topic_post_type_rewrite()
  bbp_get_topic_post_type_supports()
  bbp_show_lead_topic()
  bbp_has_topics()
  bbp_topics()
  bbp_the_topic()
  bbp_add_sticky_topics()
  bbp_topic_id()
  bbp_get_topic_id()
  bbp_get_topic()
  bbp_topic_permalink()
  bbp_get_topic_permalink()
  bbp_topic_title()
  bbp_get_topic_title()
  bbp_topic_archive_title()
  bbp_get_topic_archive_title()
  bbp_topic_content()
  bbp_get_topic_content()
  bbp_topic_excerpt()
  bbp_get_topic_excerpt()
  bbp_topic_post_date()
  bbp_get_topic_post_date()
  bbp_topic_pagination()
  bbp_get_topic_pagination()
  bbp_topic_content_append_revisions()
  bbp_topic_revision_log()
  bbp_get_topic_revision_log()
  bbp_get_topic_raw_revision_log()
  bbp_get_topic_revisions()
  bbp_get_topic_revision_count()
  bbp_is_topic_sticky()
  bbp_is_topic_super_sticky()
  bbp_topic_status()
  bbp_get_topic_status()
  bbp_is_topic_closed()
  bbp_is_topic_open()
  bbp_is_topic_public()
  bbp_is_topic_published()
  bbp_is_topic_spam()
  bbp_is_topic_trash()
  bbp_is_topic_pending()
  bbp_is_topic_private()
  bbp_is_topic_anonymous()
  bbp_topic_author()
  bbp_get_topic_author()
  bbp_topic_author_id()
  bbp_get_topic_author_id()
  bbp_topic_author_display_name()
  bbp_get_topic_author_display_name()
  bbp_topic_author_avatar()
  bbp_get_topic_author_avatar()
  bbp_topic_author_link()
  bbp_get_topic_author_link()
  bbp_topic_author_url()
  bbp_get_topic_author_url()
  bbp_topic_author_email()
  bbp_get_topic_author_email()
  bbp_topic_author_role()
  bbp_get_topic_author_role()
  bbp_topic_forum_title()
  bbp_get_topic_forum_title()
  bbp_topic_forum_id()
  bbp_get_topic_forum_id()
  bbp_topic_last_active_id()
  bbp_get_topic_last_active_id()
  bbp_topic_last_active_time()
  bbp_get_topic_last_active_time()
  bbp_topic_subscription_link()
  bbp_get_topic_subscription_link()
  bbp_topic_favorite_link()
  bbp_get_topic_favorite_link()
  bbp_topic_last_reply_id()
  bbp_get_topic_last_reply_id()
  bbp_topic_last_reply_title()
  bbp_get_topic_last_reply_title()
  bbp_topic_last_reply_permalink()
  bbp_get_topic_last_reply_permalink()
  bbp_topic_last_reply_url()
  bbp_get_topic_last_reply_url()
  bbp_topic_freshness_link()
  bbp_get_topic_freshness_link()
  bbp_topic_replies_link()
  bbp_get_topic_replies_link()
  bbp_topic_reply_count()
  bbp_get_topic_reply_count()
  bbp_topic_post_count()
  bbp_get_topic_post_count()
  bbp_topic_reply_count_hidden()
  bbp_get_topic_reply_count_hidden()
  bbp_topic_voice_count()
  bbp_get_topic_voice_count()
  bbp_topic_tag_list()
  bbp_get_topic_tag_list()
  bbp_topic_class()
  bbp_get_topic_class()
  bbp_topic_admin_links()
  bbp_get_topic_admin_links()
  bbp_topic_edit_link()
  bbp_get_topic_edit_link()
  bbp_topic_edit_url()
  bbp_get_topic_edit_url()
  bbp_topic_trash_link()
  bbp_get_topic_trash_link()
  bbp_topic_close_link()
  bbp_get_topic_close_link()
  bbp_topic_approve_link()
  bbp_get_topic_approve_link()
  bbp_topic_stick_link()
  bbp_get_topic_stick_link()
  bbp_topic_merge_link()
  bbp_get_topic_merge_link()
  bbp_topic_spam_link()
  bbp_get_topic_spam_link()
  bbp_topic_reply_link()
  bbp_get_topic_reply_link()
  bbp_get_topics_pagination_base()
  bbp_forum_pagination_count()
  bbp_get_forum_pagination_count()
  bbp_forum_pagination_links()
  bbp_get_forum_pagination_links()
  bbp_topic_notices()
  bbp_topic_type_select()
  bbp_form_topic_type_dropdown()
  bbp_get_form_topic_type_dropdown()
  bbp_form_topic_status_dropdown()
  bbp_get_form_topic_status_dropdown()
  bbp_single_topic_description()
  bbp_get_single_topic_description()
  bbp_topic_tag_tax_id()
  bbp_get_topic_tag_tax_id()
  bbp_get_topic_tag_tax_labels()
  bbp_get_topic_tag_tax_rewrite()
  bbp_topic_tag_id()
  bbp_get_topic_tag_id()
  bbp_topic_tag_name()
  bbp_get_topic_tag_name()
  bbp_topic_tag_slug()
  bbp_get_topic_tag_slug()
  bbp_topic_tag_link()
  bbp_get_topic_tag_link()
  bbp_topic_tag_edit_link()
  bbp_get_topic_tag_edit_link()
  bbp_topic_tag_description()
  bbp_get_topic_tag_description()
  bbp_form_topic_title()
  bbp_get_form_topic_title()
  bbp_form_topic_content()
  bbp_get_form_topic_content()
  bbp_topic_row_actions()
  bbp_form_topic_tags()
  bbp_get_form_topic_tags()
  bbp_form_topic_forum()
  bbp_get_form_topic_forum()
  bbp_form_topic_subscribed()
  bbp_get_form_topic_subscribed()
  bbp_form_topic_log_edit()
  bbp_get_form_topic_log_edit()
  bbp_form_topic_edit_reason()
  bbp_get_form_topic_edit_reason()
  bbp_is_topic_form_post_request()
  bbp_show_topic_lock_alert()
  bbp_topic_lock_description()
  bbp_get_topic_lock_description()

Functions
Functions that are not part of a class:

bbp_topic_post_type()   X-Ref
Output the unique id of the custom post type for topics

since: 2.0.0 bbPress (r2857)

bbp_get_topic_post_type()   X-Ref
Return the unique id of the custom post type for topics

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

bbp_get_topic_post_type_labels()   X-Ref
Return array of labels used by the topic post type

return: array
since: 2.5.0 bbPress (r5129)

bbp_get_topic_post_type_rewrite()   X-Ref
Return array of topic post type rewrite settings

return: array
since: 2.5.0 bbPress (r5129)

bbp_get_topic_post_type_supports()   X-Ref
Return array of features the topic post type supports

return: array
since: 2.5.0 bbPress (r5129)

bbp_show_lead_topic( $show_lead = false )   X-Ref
The plugin version of bbPress comes with two topic display options:
- Traditional: Topics are included in the reply loop (default)
- New Style: Topics appear as "lead" posts, ahead of replies

return: bool Yes if the topic appears as a lead, otherwise false
since: 2.0.0 bbPress (r2954)
param: $show_lead Optional. Default false

bbp_has_topics( $args = array()   X-Ref
The main topic loop. WordPress makes this easy for us

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

bbp_topics()   X-Ref
Whether there are more topics available in the loop

return: object Topic information
since: 2.0.0 bbPress (r2485)

bbp_the_topic()   X-Ref
Loads up the current topic in the loop

return: object Topic information
since: 2.0.0 bbPress (r2485)

bbp_add_sticky_topics( &$query, $args = array()   X-Ref
Add sticky topics to a topics query object

since: 2.6.0 bbPress (r6402)
param: WP_Query $query
param: array    $args

bbp_topic_id( $topic_id = 0)   X-Ref
Output the topic id

since: 2.0.0 bbPress (r2485)

bbp_get_topic_id( $topic_id = 0 )   X-Ref
Return the topic id

return: int The topic id
since: 2.0.0 bbPress (r2485)
param: $topic_id Optional. Used to check emptiness

bbp_get_topic( $topic, $output = OBJECT, $filter = 'raw' )   X-Ref
Gets a topic

return: mixed Null if error or topic (in specified form) if success
since: 2.0.0 bbPress (r2787)

bbp_topic_permalink( $topic_id = 0, $redirect_to = '' )   X-Ref
Output the link to the topic in the topic loop

since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id
param: string $redirect_to Optional. Pass a redirect value for use with

bbp_get_topic_permalink( $topic_id = 0, $redirect_to = '' )   X-Ref
Return the link to the topic

return: string Permanent link to topic
since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id
param: string $redirect_to Optional. Pass a redirect value for use with

bbp_topic_title( $topic_id = 0 )   X-Ref
Output the title of the topic

since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id

bbp_get_topic_title( $topic_id = 0 )   X-Ref
Return the title of the topic

return: string Title of topic
since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id

bbp_topic_archive_title( $title = '' )   X-Ref
Output the topic archive title

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

bbp_get_topic_archive_title( $title = '' )   X-Ref
Return the topic archive title

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

bbp_topic_content( $topic_id = 0 )   X-Ref
Output the content of the topic

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

bbp_get_topic_content( $topic_id = 0 )   X-Ref
Return the content of the topic

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

bbp_topic_excerpt( $topic_id = 0, $length = 100 )   X-Ref
Output the excerpt of the topic

since: 2.0.0 bbPress (r2780)
param: int $topic_id Optional. Topic id
param: int $length Optional. Length of the excerpt. Defaults to 100 letters

bbp_get_topic_excerpt( $topic_id = 0, $length = 100 )   X-Ref
Return the excerpt of the topic

return: string topic Excerpt
since: 2.0.0 bbPress (r2780)
param: int $topic_id Optional. topic id
param: int $length Optional. Length of the excerpt. Defaults to 100

bbp_topic_post_date( $topic_id = 0, $humanize = false, $gmt = false )   X-Ref
Output the post date and time of a topic

since: 2.2.0 bbPress (r4155)
param: int $topic_id Optional. Topic id.
param: bool $humanize Optional. Humanize output using time_since
param: bool $gmt Optional. Use GMT

bbp_get_topic_post_date( $topic_id = 0, $humanize = false, $gmt = false )   X-Ref
Return the post date and time of a topic

return: string
since: 2.2.0 bbPress (r4155)
param: int $topic_id Optional. Topic id.
param: bool $humanize Optional. Humanize output using time_since
param: bool $gmt Optional. Use GMT

bbp_topic_pagination( $args = array()   X-Ref
Output pagination links of a topic within the topic loop

since: 2.0.0 bbPress (r2966)
param: array $args See {@link bbp_get_topic_pagination()}

bbp_get_topic_pagination( $args = array()   X-Ref
Returns pagination links of a topic within the topic loop

return: string Pagination links
since: 2.0.0 bbPress (r2966)
param: array $args This function supports these arguments:

bbp_topic_content_append_revisions( $content = '', $topic_id = 0 )   X-Ref
Append revisions to the topic content

return: string Content with the revisions appended
since: 2.0.0 bbPress (r2782)
param: string $content Optional. Content to which we need to append the revisions to
param: int $topic_id Optional. Topic id

bbp_topic_revision_log( $topic_id = 0 )   X-Ref
Output the revision log of the topic

since: 2.0.0 bbPress (r2782)
param: int $topic_id Optional. Topic id

bbp_get_topic_revision_log( $topic_id = 0 )   X-Ref
Return the formatted revision log of the topic

return: string Revision log of the topic
since: 2.0.0 bbPress (r2782)
param: int $topic_id Optional. Topic id

bbp_get_topic_raw_revision_log( $topic_id = 0 )   X-Ref
Return the raw revision log of the topic

return: string Raw revision log of the topic
since: 2.0.0 bbPress (r2782)
param: int $topic_id Optional. Topic id

bbp_get_topic_revisions( $topic_id = 0 )   X-Ref
Return the revisions of the topic

return: string Topic revisions
since: 2.0.0 bbPress (r2782)
param: int $topic_id Optional. Topic id

bbp_get_topic_revision_count( $topic_id = 0, $integer = false )   X-Ref
Return the revision count of the topic

return: string Topic revision count
since: 2.0.0 bbPress (r2782)
param: int $topic_id Optional. Topic id

bbp_is_topic_sticky( $topic_id = 0, $check_super = true )   X-Ref
Is the topic a sticky or super sticky?

return: bool True if sticky or super sticky, false if not.
since: 2.0.0 bbPress (r2754)
param: int $topic_id Optional. Topic id
param: int $check_super Optional. If set to true and if the topic is not a

bbp_is_topic_super_sticky( $topic_id = 0 )   X-Ref
Is the topic a super sticky?

return: bool True if super sticky, false if not.
since: 2.0.0 bbPress (r2754)
param: int $topic_id Optional. Topic id

bbp_topic_status( $topic_id = 0 )   X-Ref
Output the status of the topic

since: 2.0.0 bbPress (r2667)
param: int $topic_id Optional. Topic id

bbp_get_topic_status( $topic_id = 0 )   X-Ref
Return the status of the topic

return: string Status of topic
since: 2.0.0 bbPress (r2667)
param: int $topic_id Optional. Topic id

bbp_is_topic_closed( $topic_id = 0 )   X-Ref
Is the topic closed to new replies?

return: bool True if closed, false if not.
since: 2.0.0 bbPress (r2746)
param: int $topic_id Optional. Topic id

bbp_is_topic_open( $topic_id = 0 )   X-Ref
Is the topic open to new replies?

return: bool True if open, false if closed.
since: 2.0.0 bbPress (r2727)
param: int $topic_id Optional. Topic id

bbp_is_topic_public( $topic_id = 0 )   X-Ref
Is the topic publicly viewable?

See bbp_get_public_topic_statuses() for public statuses.

return: bool True if public, false if not.
since: 2.6.0 bbPress (r6383)
param: int $topic_id Optional. Topic id

bbp_is_topic_published( $topic_id = 0 )   X-Ref
Does the topic have a published status?

return: bool True if published, false if not.
since: 2.0.0 bbPress (r3496)
param: int $topic_id Optional. Topic id

bbp_is_topic_spam( $topic_id = 0 )   X-Ref
Is the topic marked as spam?

return: bool True if spam, false if not.
since: 2.0.0 bbPress (r2727)
param: int $topic_id Optional. Topic id

bbp_is_topic_trash( $topic_id = 0 )   X-Ref
Is the topic trashed?

return: bool True if trashed, false if not.
since: 2.0.0 bbPress (r2888)
param: int $topic_id Optional. Topic id

bbp_is_topic_pending( $topic_id = 0 )   X-Ref
Is the topic pending?

return: bool True if pending, false if not.
since: 2.6.0 bbPress (r5504)
param: int $topic_id Optional. Topic id

bbp_is_topic_private( $topic_id = 0 )   X-Ref
Is the topic private?

return: bool True if private, false if not.
since: 2.6.0 bbPress (r5504)
param: int $topic_id Optional. Topic id

bbp_is_topic_anonymous( $topic_id = 0 )   X-Ref
Is the posted by an anonymous user?

return: bool True if the post is by an anonymous user, false if not.
since: 2.0.0 bbPress (r2753)
param: int $topic_id Optional. Topic id

bbp_topic_author( $topic_id = 0 )   X-Ref
Deprecated. Use bbp_topic_author_display_name() instead.

Output the author of the topic.

since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_get_topic_author( $topic_id = 0 )   X-Ref
Deprecated. Use bbp_get_topic_author_display_name() instead.

Return the author of the topic

return: string Author of topic
since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_topic_author_id( $topic_id = 0 )   X-Ref
Output the author ID of the topic

since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_get_topic_author_id( $topic_id = 0 )   X-Ref
Return the author ID of the topic

return: string Author of topic
since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_topic_author_display_name( $topic_id = 0 )   X-Ref
Output the author display_name of the topic

since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_get_topic_author_display_name( $topic_id = 0 )   X-Ref
Return the author display_name of the topic

return: string Topic's author's display name
since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id

bbp_topic_author_avatar( $topic_id = 0, $size = 40 )   X-Ref
Output the author avatar of the topic

since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id
param: int $size Optional. Avatar size. Defaults to 40

bbp_get_topic_author_avatar( $topic_id = 0, $size = 40 )   X-Ref
Return the author avatar of the topic

return: string Avatar of the author of the topic
since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id
param: int $size Optional. Avatar size. Defaults to 40

bbp_topic_author_link( $args = array()   X-Ref
Output the author link of the topic

since: 2.0.0 bbPress (r2717)
param: mixed|int $args If it is an integer, it is used as topic_id. Optional.

bbp_get_topic_author_link( $args = array()   X-Ref
Return the author link of the topic

return: string Author link of topic
since: 2.0.0 bbPress (r2717)
param: mixed|int $args If it is an integer, it is used as topic id.

bbp_topic_author_url( $topic_id = 0 )   X-Ref
Output the author url of the topic

since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_get_topic_author_url( $topic_id = 0 )   X-Ref
Return the author url of the topic

return: string Author URL of topic
since: 2.0.0 bbPress (r2590)
param: int $topic_id Optional. Topic id

bbp_topic_author_email( $topic_id = 0 )   X-Ref
Output the topic author email address

since: 2.0.0 bbPress (r3445)
param: int $topic_id Optional. Reply id

bbp_get_topic_author_email( $topic_id = 0 )   X-Ref
Return the topic author email address

return: string Topic author email address
since: 2.0.0 bbPress (r3445)
param: int $topic_id Optional. Reply id

bbp_topic_author_role( $args = array()   X-Ref
Output the topic author role

since: 2.1.0 bbPress (r3860)
param: array $args Optional.

bbp_get_topic_author_role( $args = array()   X-Ref
Return the topic author role

return: string topic author role
since: 2.1.0 bbPress (r3860)
param: array $args Optional.

bbp_topic_forum_title( $topic_id = 0 )   X-Ref
Output the title of the forum a topic belongs to

since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id

bbp_get_topic_forum_title( $topic_id = 0 )   X-Ref
Return the title of the forum a topic belongs to

return: string Topic forum title
since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id

bbp_topic_forum_id( $topic_id = 0 )   X-Ref
Output the forum id a topic belongs to

since: 2.0.0 bbPress (r2491)
param: int $topic_id Optional. Topic id

bbp_get_topic_forum_id( $topic_id = 0 )   X-Ref
Return the forum id a topic belongs to

return: int Topic forum id
since: 2.0.0 bbPress (r2491)
param: int $topic_id Optional. Topic id

bbp_topic_last_active_id( $topic_id = 0 )   X-Ref
Output the topics last active ID

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

bbp_get_topic_last_active_id( $topic_id = 0 )   X-Ref
Return the topics last active ID

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

bbp_topic_last_active_time( $topic_id = 0 )   X-Ref
Output the topics last update date/time (aka freshness)

since: 2.0.0 bbPress (r2625)
param: int $topic_id Optional. Topic id

bbp_get_topic_last_active_time( $topic_id = 0 )   X-Ref
Return the topics last update date/time (aka freshness)

return: string Topic freshness
since: 2.0.0 bbPress (r2625)
param: int $topic_id Optional. Topic id

bbp_topic_subscription_link( $args = array()   X-Ref
Output the topic subscription link

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

bbp_get_topic_subscription_link( $args = array()   X-Ref
Get the topic 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_topic_favorite_link( $args = array()   X-Ref
Output the topic favorite link

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

bbp_get_topic_favorite_link( $args = array()   X-Ref
Get the forum favorite link

A custom wrapper for bbp_get_user_favorites_link()

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

bbp_topic_last_reply_id( $topic_id = 0 )   X-Ref
Output the id of the topics last reply

since: 2.0.0 bbPress (r2625)
param: int $topic_id Optional. Topic id

bbp_get_topic_last_reply_id( $topic_id = 0 )   X-Ref
Return the id of the topics last reply

return: int Topic last reply id
since: 2.0.0 bbPress (r2625)
param: int $topic_id Optional. Topic id

bbp_topic_last_reply_title( $topic_id = 0 )   X-Ref
Output the title of the last reply inside a topic

since: 2.0.0 bbPress (r2753)
param: int $topic_id Optional. Topic id

bbp_get_topic_last_reply_title( $topic_id = 0 )   X-Ref
Return the title of the last reply inside a topic

return: string Topic last reply title
since: 2.0.0 bbPress (r2753)
since: 2.6.0 bbPress https://bbpress.trac.wordpress.org/ticket/3039
param: int $topic_id Optional. Topic id

bbp_topic_last_reply_permalink( $topic_id = 0 )   X-Ref
Output the link to the last reply in a topic

since: 2.0.0 bbPress (r2464)
param: int $topic_id Optional. Topic id

bbp_get_topic_last_reply_permalink( $topic_id = 0 )   X-Ref
Return the link to the last reply in a topic

return: string Permanent link to the reply
since: 2.0.0 bbPress (r2464)
param: int $topic_id Optional. Topic id

bbp_topic_last_reply_url( $topic_id = 0 )   X-Ref
Output the link to the last reply in a topic

since: 2.0.0 bbPress (r2683)
param: int $topic_id Optional. Topic id

bbp_get_topic_last_reply_url( $topic_id = 0 )   X-Ref
Return the link to the last reply in a topic

return: string Topic last reply url
since: 2.0.0 bbPress (r2683)
param: int $topic_id Optional. Topic id

bbp_topic_freshness_link( $topic_id = 0 )   X-Ref
Output link to the most recent activity inside a topic, complete with link
attributes and content.

since: 2.0.0 bbPress (r2625)
param: int $topic_id Optional. Topic id

bbp_get_topic_freshness_link( $topic_id = 0 )   X-Ref
Returns link to the most recent activity inside a topic, complete
with link attributes and content.

return: string Topic freshness link
since: 2.0.0 bbPress (r2625)
param: int $topic_id Optional. Topic id

bbp_topic_replies_link( $topic_id = 0 )   X-Ref
Output the replies link of the topic

since: 2.0.0 bbPress (r2740)
param: int $topic_id Optional. Topic id

bbp_get_topic_replies_link( $topic_id = 0 )   X-Ref
Return the replies link of the topic

since: 2.0.0 bbPress (r2740)
param: int $topic_id Optional. Topic id

bbp_topic_reply_count( $topic_id = 0, $integer = false )   X-Ref
Output total reply count of a topic

since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id
param: boolean $integer Optional. Whether or not to format the result

bbp_get_topic_reply_count( $topic_id = 0, $integer = false )   X-Ref
Return total reply count of a topic

return: int Reply count
since: 2.0.0 bbPress (r2485)
param: int $topic_id Optional. Topic id
param: boolean $integer Optional. Whether or not to format the result

bbp_topic_post_count( $topic_id = 0, $integer = false )   X-Ref
Output total post count of a topic

since: 2.0.0 bbPress (r2954)
param: int $topic_id Optional. Topic id
param: boolean $integer Optional. Whether or not to format the result

bbp_get_topic_post_count( $topic_id = 0, $integer = false )   X-Ref
Return total post count of a topic

return: int Post count
since: 2.0.0 bbPress (r2954)
param: int $topic_id Optional. Topic id
param: boolean $integer Optional. Whether or not to format the result

bbp_topic_reply_count_hidden( $topic_id = 0, $integer = false )   X-Ref
Output total hidden reply count of a topic (hidden includes trashed and
spammed replies)

since: 2.0.0 bbPress (r2740)
param: int $topic_id Optional. Topic id
param: boolean $integer Optional. Whether or not to format the result

bbp_get_topic_reply_count_hidden( $topic_id = 0, $integer = false )   X-Ref
Return total hidden reply count of a topic (hidden includes trashed
and spammed replies)

return: int Topic hidden reply count
since: 2.0.0 bbPress (r2740)
param: int $topic_id Optional. Topic id
param: boolean $integer Optional. Whether or not to format the result

bbp_topic_voice_count( $topic_id = 0, $integer = false )   X-Ref
Output total voice count of a topic

since: 2.0.0 bbPress (r2567)
param: int $topic_id Optional. Topic id

bbp_get_topic_voice_count( $topic_id = 0, $integer = false )   X-Ref
Return total voice count of a topic

return: int Voice count of the topic
since: 2.0.0 bbPress (r2567)
param: int $topic_id Optional. Topic id

bbp_topic_tag_list( $topic_id = 0, $args = array()   X-Ref
Output a the tags of a topic

since: 2.0.0 bbPress (r2688)
param: int $topic_id Optional. Topic id
param: array $args See {@link bbp_get_topic_tag_list()}

bbp_get_topic_tag_list( $topic_id = 0, $args = array()   X-Ref
Return the tags of a topic

return: string Tag list of the topic
since: 2.0.0 bbPress (r2688)
param: int $topic_id Optional. Topic id
param: array $args This function supports these arguments:

bbp_topic_class( $topic_id = 0, $classes = array()   X-Ref
Output the row class of a topic

since: 2.0.0 bbPress (r2667)
param: int $topic_id Optional. Topic id
param: array Extra classes you can pass when calling this function

bbp_get_topic_class( $topic_id = 0, $classes = array()   X-Ref
Return the row class of a topic

return: string Row class of a topic
since: 2.0.0 bbPress (r2667)
param: int $topic_id Optional. Topic id
param: array Extra classes you can pass when calling this function

bbp_topic_admin_links( $args = array()   X-Ref
Output admin links for topic

param: array $args See {@link bbp_get_topic_admin_links()}

bbp_get_topic_admin_links( $args = array()   X-Ref
Return admin links for topic.

Move topic functionality is handled by the edit topic page.

return: string Topic admin links
param: array $args This function supports these arguments:

bbp_topic_edit_link( $args = array()   X-Ref
Output the edit link of the topic

since: 2.0.0 bbPress (r2727)
param: array $args See {@link bbp_get_topic_edit_link()}

bbp_get_topic_edit_link( $args = array()   X-Ref
Return the edit link of the topic

return: string Topic edit link
since: 2.0.0 bbPress (r2727)
param: array $args This function supports these args:

bbp_topic_edit_url( $topic_id = 0 )   X-Ref
Output URL to the topic edit page

since: 2.0.0 bbPress (r2753)
param: int $topic_id Optional. Topic id

bbp_get_topic_edit_url( $topic_id = 0 )   X-Ref
Return URL to the topic edit page

return: string Topic edit url
since: 2.0.0 bbPress (r2753)
param: int $topic_id Optional. Topic id

bbp_topic_trash_link( $args = array()   X-Ref
Output the trash link of the topic

since: 2.0.0 bbPress (r2727)
param: array $args See {@link bbp_get_topic_trash_link()}

bbp_get_topic_trash_link( $args = array()   X-Ref
Return the trash link of the topic

return: string Topic trash link
since: 2.0.0 bbPress (r2727)
param: array $args This function supports these args:

bbp_topic_close_link( $args = array()   X-Ref
Output the close link of the topic

since: 2.0.0 bbPress (r2727)
param: array $args See {@link bbp_get_topic_close_link()}

bbp_get_topic_close_link( $args = array()   X-Ref
Return the close link of the topic

return: string Topic close link
since: 2.0.0 bbPress (r2727)
param: array $args This function supports these args:

bbp_topic_approve_link( $args = array()   X-Ref
Output the approve link of the topic

since: 2.6.0 bbPress (r5504)
param: array $args See {@link bbp_get_topic_approve_link()}

bbp_get_topic_approve_link( $args = array()   X-Ref
Return the approve link of the topic

return: string Topic approve link
since: 2.6.0 bbPress (r5504)
param: array $args This function supports these args:

bbp_topic_stick_link( $args = array()   X-Ref
Output the stick link of the topic

since: 2.0.0 bbPress (r2754)
param: array $args See {@link bbp_get_topic_stick_link()}

bbp_get_topic_stick_link( $args = array()   X-Ref
Return the stick link of the topic

return: string Topic stick link
since: 2.0.0 bbPress (r2754)
param: array $args This function supports these args:

bbp_topic_merge_link( $args = array()   X-Ref
Output the merge link of the topic

since: 2.0.0 bbPress (r2756)
param: array $args

bbp_get_topic_merge_link( $args = array()   X-Ref
Return the merge link of the topic

return: string Topic merge link
since: 2.0.0 bbPress (r2756)
param: array $args This function supports these args:

bbp_topic_spam_link( $args = array()   X-Ref
Output the spam link of the topic

since: 2.0.0 bbPress (r2727)
param: array $args See {@link bbp_get_topic_spam_link()}

bbp_get_topic_spam_link( $args = array()   X-Ref
Return the spam link of the topic

return: string Topic spam link
since: 2.0.0 bbPress (r2727)
param: array $args This function supports these args:

bbp_topic_reply_link( $args = array()   X-Ref
Output the link to go directly to the reply form

since: 2.4.0 bbPress (r4966)
param: array $args

bbp_get_topic_reply_link( $args = array()   X-Ref
Return the link to go directly to the reply form

return: string Link for a reply to a topic
since: 2.4.0 bbPress (r4966)
param: array $args Arguments

bbp_get_topics_pagination_base( $forum_id = 0 )   X-Ref
Return the base URL used inside of pagination links

return: string
since: 2.6.0 bbPress (r6402)
param: int $forum_id

bbp_forum_pagination_count()   X-Ref
Output the pagination count

The results are unescaped by design, to allow them to be filtered freely via
the 'bbp_get_forum_pagination_count' filter.

since: 2.0.0 bbPress (r2519)

bbp_get_forum_pagination_count()   X-Ref
Return the pagination count

return: string Forum Pagination count
since: 2.0.0 bbPress (r2519)

bbp_forum_pagination_links()   X-Ref
Output pagination links

since: 2.0.0 bbPress (r2519)

bbp_get_forum_pagination_links()   X-Ref
Return pagination links

return: string Pagination links
since: 2.0.0 bbPress (r2519)

bbp_topic_notices()   X-Ref
Displays topic notices

since: 2.0.0 bbPress (r2744)

bbp_topic_type_select( $args = array()   X-Ref
Displays topic type select box (normal/sticky/super sticky)

since: 2.0.0 bbPress (r2784)
param: $args This function supports these arguments:

bbp_form_topic_type_dropdown( $args = array()   X-Ref
Displays topic type select box (normal/sticky/super sticky)

since: 2.4.0 bbPress (r5059)
param: $args This function supports these arguments:

bbp_get_form_topic_type_dropdown( $args = array()   X-Ref
Returns topic type select box (normal/sticky/super sticky)

since: 2.4.0 bbPress (r5059)
param: $args This function supports these arguments:

bbp_form_topic_status_dropdown( $args = array()   X-Ref
Output value topic status dropdown

since: 2.4.0 bbPress (r5059)
param: $args This function supports these arguments:

bbp_get_form_topic_status_dropdown( $args = array()   X-Ref
Returns topic status dropdown

This dropdown is only intended to be seen by users with the 'moderate'
capability. Because of this, no additional capability checks are performed
within this function to check available topic statuses.

since: 2.4.0 bbPress (r5059)
param: $args This function supports these arguments:

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

since: 2.0.0 bbPress (r2860)
param: array $args See {@link bbp_get_single_topic_description()}

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

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

bbp_topic_tag_tax_id()   X-Ref
Output the unique id of the topic tag taxonomy

since: 2.0.0 bbPress (r3348)

bbp_get_topic_tag_tax_id()   X-Ref
Return the unique id of the topic tag taxonomy

return: string The unique topic tag taxonomy
since: 2.0.0 bbPress (r3348)

bbp_get_topic_tag_tax_labels()   X-Ref
Return array of labels used by the topic-tag taxonomy

return: array
since: 2.5.0 bbPress (r5129)

bbp_get_topic_tag_tax_rewrite()   X-Ref
Return an array of topic-tag taxonomy rewrite settings

return: array
since: 2.5.0 bbPress (r5129)

bbp_topic_tag_id( $tag = '' )   X-Ref
Output the id of the current tag

since: 2.0.0 bbPress (r3109)

bbp_get_topic_tag_id( $tag = '' )   X-Ref
Return the id of the current tag

return: string Term Name
since: 2.0.0 bbPress (r3109)

bbp_topic_tag_name( $tag = '' )   X-Ref
Output the name of the current tag

since: 2.0.0 bbPress (r3109)

bbp_get_topic_tag_name( $tag = '' )   X-Ref
Return the name of the current tag

return: string Term Name
since: 2.0.0 bbPress (r3109)

bbp_topic_tag_slug( $tag = '' )   X-Ref
Output the slug of the current tag

since: 2.0.0 bbPress (r3109)

bbp_get_topic_tag_slug( $tag = '' )   X-Ref
Return the slug of the current tag

return: string Term Name
since: 2.0.0 bbPress (r3109)

bbp_topic_tag_link( $tag = '' )   X-Ref
Output the link of the current tag

since: 2.0.0 bbPress (r3348)

bbp_get_topic_tag_link( $tag = '' )   X-Ref
Return the link of the current tag

return: string Term Name
since: 2.0.0 bbPress (r3348)

bbp_topic_tag_edit_link( $tag = '' )   X-Ref
Output the link of the current tag

since: 2.0.0 bbPress (r3348)

bbp_get_topic_tag_edit_link( $tag = '' )   X-Ref
Return the link of the current tag

return: string Term Name
since: 2.0.0 bbPress (r3348)

bbp_topic_tag_description( $args = array()   X-Ref
Output the description of the current tag

since: 2.0.0 bbPress (r3109)

bbp_get_topic_tag_description( $args = array()   X-Ref
Return the description of the current tag

return: string Term Name
since: 2.0.0 bbPress (r3109)
param: array $args before|after|tag

bbp_form_topic_title()   X-Ref
Output the value of topic title field

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_title()   X-Ref
Return the value of topic title field

return: string Value of topic title field
since: 2.0.0 bbPress (r2976)

bbp_form_topic_content()   X-Ref
Output the value of topic content field

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_content()   X-Ref
Return the value of topic content field

return: string Value of topic content field
since: 2.0.0 bbPress (r2976)

bbp_topic_row_actions()   X-Ref
Allow topic rows to have administrative actions

since: 2.1.0 bbPress (r3653)

bbp_form_topic_tags()   X-Ref
Output value of topic tags field

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_tags()   X-Ref
Return value of topic tags field

return: string Value of topic tags field
since: 2.0.0 bbPress (r2976)

bbp_form_topic_forum()   X-Ref
Output value of topic forum

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_forum()   X-Ref
Return value of topic forum

return: string Value of topic content field
since: 2.0.0 bbPress (r2976)

bbp_form_topic_subscribed()   X-Ref
Output checked value of topic subscription

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_subscribed()   X-Ref
Return checked value of topic subscription

return: string Checked value of topic subscription
since: 2.0.0 bbPress (r2976)

bbp_form_topic_log_edit()   X-Ref
Output checked value of topic log edit field

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_log_edit()   X-Ref
Return checked value of topic log edit field

return: string Topic log edit checked value
since: 2.0.0 bbPress (r2976)

bbp_form_topic_edit_reason()   X-Ref
Output the value of the topic edit reason

since: 2.0.0 bbPress (r2976)

bbp_get_form_topic_edit_reason()   X-Ref
Return the value of the topic edit reason

return: string Topic edit reason value
since: 2.0.0 bbPress (r2976)

bbp_is_topic_form_post_request()   X-Ref
Verify if a POST request came from a failed topic attempt.

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

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

bbp_show_topic_lock_alert()   X-Ref
Should the topic-lock alert appear?

return: bool
since: 2.6.0 bbPress (r6342)

bbp_topic_lock_description( $topic_id = 0 )   X-Ref
Output the topic lock description

since: 2.6.0 bbPress (r6343)
param: int $topic_id Optional. Topic id

bbp_get_topic_lock_description( $topic_id = 0 )   X-Ref
Return the topic lock description

since: 2.6.0 bbPress (r6343)
param: int $topic_id Optional. Topic id


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