| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
BuddyPress Forums Template Tags.
| File Size: | 3249 lines (92 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
BP_Forums_Template_Forum:: (90 methods):
__construct()
has_topics()
next_topic()
rewind_topics()
user_topics()
the_topic()
bp_has_forum_topics()
bp_forum_topics()
bp_the_forum_topic()
bp_the_topic_id()
bp_get_the_topic_id()
bp_the_topic_title()
bp_get_the_topic_title()
bp_the_topic_slug()
bp_get_the_topic_slug()
bp_the_topic_text()
bp_get_the_topic_text()
bp_the_topic_poster_id()
bp_get_the_topic_poster_id()
bp_the_topic_poster_avatar()
bp_get_the_topic_poster_avatar()
bp_the_topic_poster_name()
bp_get_the_topic_poster_name()
bp_the_topic_object_id()
bp_get_the_topic_object_id()
bp_the_topic_object_name()
bp_get_the_topic_object_name()
bp_the_topic_object_slug()
bp_get_the_topic_object_slug()
bp_the_topic_object_permalink()
bp_get_the_topic_object_permalink()
bp_the_topic_last_poster_name()
bp_get_the_topic_last_poster_name()
bp_the_topic_object_avatar()
bp_get_the_topic_object_avatar()
bp_the_topic_last_poster_avatar()
bp_get_the_topic_last_poster_avatar()
bp_the_topic_start_time()
bp_get_the_topic_start_time()
bp_the_topic_time()
bp_get_the_topic_time()
bp_the_topic_forum_id()
bp_get_the_topic_forum_id()
bp_the_topic_status()
bp_get_the_topic_status()
bp_the_topic_is_topic_open()
bp_get_the_topic_is_topic_open()
bp_the_topic_last_post_id()
bp_get_the_topic_last_post_id()
bp_the_topic_is_sticky()
bp_get_the_topic_is_sticky()
bp_the_topic_total_post_count()
bp_get_the_topic_total_post_count()
bp_the_topic_total_posts()
bp_get_the_topic_total_posts()
bp_the_topic_tag_count()
bp_get_the_topic_tag_count()
bp_the_topic_permalink()
bp_get_the_topic_permalink()
bp_the_topic_time_since_created()
bp_get_the_topic_time_since_created()
bp_the_topic_latest_post_excerpt()
bp_get_the_topic_latest_post_excerpt()
bp_the_topic_time_since_last_post()
bp_get_the_topic_time_since_last_post()
bp_the_topic_is_mine()
bp_get_the_topic_is_mine()
bp_the_topic_admin_links()
bp_get_the_topic_admin_links()
bp_the_topic_css_class()
bp_get_the_topic_css_class()
bp_my_forum_topics_link()
bp_get_my_forum_topics_link()
bp_unreplied_forum_topics_link()
bp_get_unreplied_forum_topics_link()
bp_popular_forum_topics_link()
bp_get_popular_forum_topics_link()
bp_newest_forum_topics_link()
bp_get_newest_forum_topics_link()
bp_forum_topic_type()
bp_get_forum_topic_type()
bp_forum_topic_new_reply_link()
bp_get_forum_topic_new_reply_link()
bp_forums_tag_name()
bp_get_forums_tag_name()
bp_forum_pagination()
bp_get_forum_pagination()
bp_forum_pagination_count()
bp_get_forum_pagination_count()
bp_is_edit_topic()
BP_Forums_Template_Topic:: (51 methods):
__construct()
has_posts()
next_post()
rewind_posts()
user_posts()
the_post()
bp_has_forum_topic_posts()
bp_forum_topic_posts()
bp_the_forum_topic_post()
bp_the_topic_post_id()
bp_get_the_topic_post_id()
bp_the_topic_post_content()
bp_get_the_topic_post_content()
bp_the_topic_post_css_class()
bp_get_the_topic_post_css_class()
bp_the_topic_post_poster_avatar()
bp_get_the_topic_post_poster_avatar()
bp_the_topic_post_poster_name()
bp_get_the_topic_post_poster_name()
bp_the_topic_post_poster_link()
bp_get_the_topic_post_poster_link()
bp_the_topic_post_time_since()
bp_get_the_topic_post_time_since()
bp_the_topic_post_is_mine()
bp_get_the_topic_post_is_mine()
bp_the_topic_post_admin_links()
bp_get_the_topic_post_admin_links()
bp_the_topic_post_edit_text()
bp_get_the_topic_post_edit_text()
bp_the_topic_pagination()
bp_get_the_topic_pagination()
bp_the_topic_pagination_count()
bp_the_topic_is_last_page()
bp_get_the_topic_is_last_page()
bp_directory_forums_search_form()
bp_forum_permalink()
bp_get_forum_permalink()
bp_forum_name()
bp_get_forum_name()
bp_forums_tag_heat_map()
bp_forum_topic_tag_list()
bp_get_forum_topic_tag_list()
bp_forum_topic_has_tags()
bp_forum_action()
bp_get_forum_action()
bp_forum_topic_action()
bp_get_forum_topic_action()
bp_forum_topic_count_for_user()
bp_get_forum_topic_count_for_user()
bp_forum_topic_count()
bp_get_forum_topic_count()
Class: BP_Forums_Template_Forum - X-Ref
The main forums template loop class.| __construct( $type, $forum_id, $user_id, $page, $per_page, $max, $no_stickies, $search_terms, $offset = false, $number = false ) X-Ref |
| Constructor method. param: string $type The 'type' is the sort order/kind. 'newest', param: int $forum_id The ID of the forum for which topics are being param: int $user_id The ID of the user to whom topics should be param: int $page The number of the page being requested. param: int $per_page The number of items being requested per page. param: int $max Max amount to retrieve. param: string $no_stickies Requested sticky format. param: string $search_terms Filter results by a string. param: int|bool $offset Optional. Offset results by a given numeric value. param: int|bool $number Optional. Total number of items to retrieve. since: 1.5.0 |
| has_topics() X-Ref |
| Whether there are topics available in the loop. return: bool True if there are items in the loop, otherwise false. since: 1.0.0 |
| next_topic() X-Ref |
| Set up the next topic and iterate index. return: object The next topic to iterate over. since: 1.0.0 |
| rewind_topics() X-Ref |
| Rewind the topics and reset topic index. since: 1.0.0 |
| user_topics() X-Ref |
| Whether there are blogs left in the loop to iterate over. This method is used by {@link bp_forum_topics()} as part of the while loop that controls iteration inside the blogs loop, eg: while ( bp_forum_topics() ) { ... return: bool True if there are more topics to show, otherwise false. since: 1.0.0 |
| the_topic() X-Ref |
| Set up the current topic in the loop. since: 1.0.0 |
| bp_has_forum_topics( $args = '' ) X-Ref |
| Initiate the forum topics loop. Like other BuddyPress custom loops, the default arguments for this function are determined dynamically, depending on your current page. All of these $defaults can be overridden in the $args parameter. param: array|string $args { return: bool True when forum topics are found corresponding to the args, since: 1.1.0 |
| bp_forum_topics() X-Ref |
| Determine whether there are still topics left in the loop. return: bool Returns true when topics are found. since: 1.1.0 |
| bp_the_forum_topic() X-Ref |
| Get the current topic object in the loop. return: object The current topic object. since: 1.1.0 |
| bp_the_topic_id() X-Ref |
| Output the ID of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_id() X-Ref |
| Return the ID of the current topic in the loop. return: int ID of the current topic in the loop. since: 1.0.0 |
| bp_the_topic_title() X-Ref |
| Output the title of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_title() X-Ref |
| Return the title of the current topic in the loop. return: string Title of the current topic in the loop. since: 1.0.0 |
| bp_the_topic_slug() X-Ref |
| Output the slug of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_slug() X-Ref |
| Return the slug of the current topic in the loop. return: string Slug of the current topic in the loop. since: 1.0.0 |
| bp_the_topic_text() X-Ref |
| Output the text of the first post in the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_text() X-Ref |
| Return the text of the first post in the current topic in the loop. return: string Text of the first post in the current topic. since: 1.1.0 |
| bp_the_topic_poster_id() X-Ref |
| Output the ID of the user who posted the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_poster_id() X-Ref |
| Return the ID of the user who posted the current topic in the loop. return: int ID of the user who posted the current topic. since: 1.0.0 |
| bp_the_topic_poster_avatar( $args = '' ) X-Ref |
| Output the avatar of the user who posted the current topic in the loop. param: array|string $args See {@link bp_get_the_topic_poster_avatar()}. since: 1.0.0 |
| bp_get_the_topic_poster_avatar( $args = '' ) X-Ref |
| Return the avatar of the user who posted the current topic in the loop. param: array|string $args { return: string HTML of user avatar. since: 1.0.0 |
| bp_the_topic_poster_name() X-Ref |
| Output the name of the user who posted the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_poster_name() X-Ref |
| Return the name of the user who posted the current topic in the loop. return: string Name of the user who posted the current topic. since: 1.0.0 |
| bp_the_topic_object_id() X-Ref |
| Output the ID of the object associated with the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_object_id() X-Ref |
| Return the ID of the object associated with the current topic in the loop. Objects are things like associated groups. return: int ID of the associated object. since: 1.1.0 |
| bp_the_topic_object_name() X-Ref |
| Output the name of the object associated with the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_object_name() X-Ref |
| Return the name of the object associated with the current topic in the loop. Objects are things like groups. So this function would return the name of the group associated with the forum topic, if it exists. return: string Object name. since: 1.1.0 |
| bp_the_topic_object_slug() X-Ref |
| Output the slug of the object associated with the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_object_slug() X-Ref |
| Return the slug of the object associated with the current topic in the loop. Objects are things like groups. So this function would return the slug of the group associated with the forum topic, if it exists. return: string Object slug. since: 1.1.0 |
| bp_the_topic_object_permalink() X-Ref |
| Output the permalink of the object associated with the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_object_permalink() X-Ref |
| Return the permalink of the object associated with the current topic in the loop. Objects are things like groups. So this function would return the permalink of the group associated with the forum topic, if it exists. return: string Object permalink. since: 1.1.0 |
| bp_the_topic_last_poster_name() X-Ref |
| Output the linked name of the user who last posted to the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_last_poster_name() X-Ref |
| Return the linked name of the user who last posted to the current topic in the loop. return: string HTML link to the profile of the user who last posted since: 1.0.0 |
| bp_the_topic_object_avatar( $args = '' ) X-Ref |
| Output the permalink of the object associated with the current topic in the loop. param: array|string $args See {@bp_get_the_topic_object_avatar()}. since: 1.1.0 |
| bp_get_the_topic_object_avatar( $args = '' ) X-Ref |
| Return the avatar of the object associated with the current topic in the loop. Objects are things like groups. So this function would return the avatar of the group associated with the forum topic, if it exists. param: array|string $args { return: string Object avatar. since: 1.1.0 |
| bp_the_topic_last_poster_avatar( $args = '' ) X-Ref |
| Output the avatar for the user who last posted to the current topic in the loop. param: array|string $args See {@bp_get_the_topic_last_poster_avatar()}. since: 1.0.0 |
| bp_get_the_topic_last_poster_avatar( $args = '' ) X-Ref |
| Return the avatar for the user who last posted to the current topic in the loop. param: array|string $args { return: string User avatar. since: 1.0.0 |
| bp_the_topic_start_time() X-Ref |
| Output the start time of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_start_time() X-Ref |
| Return the start time of the current topic in the loop. return: string Start time of the current topic. since: 1.0.0 |
| bp_the_topic_time() X-Ref |
| Output the topic time of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_time() X-Ref |
| Return the topic time of the current topic in the loop. return: string Topic time of the current topic. since: 1.0.0 |
| bp_the_topic_forum_id() X-Ref |
| Output the ID of the forum associated with the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_forum_id() X-Ref |
| Return the ID of the forum associated with the current topic in the loop. return: int ID of the forum associated with the current topic. since: 1.0.0 |
| bp_the_topic_status() X-Ref |
| Output the status of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_status() X-Ref |
| Return the status of the current topic in the loop. return: string Status of the current topic. since: 1.0.0 |
| bp_the_topic_is_topic_open() X-Ref |
| Output whether the current topic in the loop is open. since: 1.0.0 |
| bp_get_the_topic_is_topic_open() X-Ref |
| Return whether the current topic in the loop is open. return: string since: 1.0.0 |
| bp_the_topic_last_post_id() X-Ref |
| Output the ID of the last post in the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_last_post_id() X-Ref |
| Return the ID of the last post in the current topic in the loop. return: int ID of the last post in the current topic. since: 1.0.0 |
| bp_the_topic_is_sticky() X-Ref |
| Output whether the current topic in the loop is sticky. since: 1.0.0 |
| bp_get_the_topic_is_sticky() X-Ref |
| Return whether the current topic in the loop is sticky. return: bool since: 1.0.0 |
| bp_the_topic_total_post_count() X-Ref |
| Output a 'x posts' string with the number of posts in the current topic. since: 1.0.0 |
| bp_get_the_topic_total_post_count() X-Ref |
| Return a 'x posts' string with the number of posts in the current topic. return: string String of the form 'x posts'. since: 1.0.0 |
| bp_the_topic_total_posts() X-Ref |
| Output the total number of posts in the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_total_posts() X-Ref |
| Return the total number of posts in the current topic in the loop. return: int Total number of posts in the current topic. since: 1.1.0 |
| bp_the_topic_tag_count() X-Ref |
| Output the tag count for the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_tag_count() X-Ref |
| Return the tag count for the current topic in the loop. return: int Tag count for the current topic. since: 1.0.0 |
| bp_the_topic_permalink() X-Ref |
| Output the permalink of the current topic in the loop. since: 1.0.0 |
| bp_get_the_topic_permalink() X-Ref |
| Return the permalink for the current topic in the loop. return: string Permalink for the current topic. since: 1.0.0 |
| bp_the_topic_time_since_created() X-Ref |
| Output a 'since' string describing when the current topic was created. since: 1.0.0 |
| bp_get_the_topic_time_since_created() X-Ref |
| Return a 'since' string describing when the current topic was created. return: string since: 1.0.0 |
| bp_the_topic_latest_post_excerpt( $args = '' ) X-Ref |
| Output an excerpt from the latest post of the current topic in the loop. param: array|string $args See {@bp_get_the_topic_latest_post_excerpt()}. since: 1.0.0 |
| bp_get_the_topic_latest_post_excerpt( $args = '' ) X-Ref |
| Return an excerpt from the latest post of the current topic in the loop. param: array|string $args { return: string Post excerpt. since: 1.0.0 |
| bp_the_topic_time_since_last_post() X-Ref |
| Output a 'since' string describing when the last post in the current topic was created. since: 1.0.0 |
| bp_get_the_topic_time_since_last_post() X-Ref |
| Return a 'since' string describing when the last post in the current topic was created. return: string since: 1.0.0 |
| bp_the_topic_is_mine() X-Ref |
| Output whether the current topic in the loop belongs to the logged-in user. since: 1.1.0 |
| bp_get_the_topic_is_mine() X-Ref |
| Does the current topic belong to the logged-in user? return: bool True if the current topic in the loop was created by since: 1.1.0 |
| bp_the_topic_admin_links( $args = '' ) X-Ref |
| Output the admin links for the current topic in the loop. param: array|string $args See {@link bp_get_the_topic_admin_links()}. since: 1.1.0 |
| bp_get_the_topic_admin_links( $args = '' ) X-Ref |
| Return the admin links for the current topic in the loop. param: array|string $args { return: string HTML string containing the admin links for the current topic. since: 1.1.0 |
| bp_the_topic_css_class() X-Ref |
| Output the CSS class for the current topic in the loop. since: 1.1.0 |
| bp_get_the_topic_css_class() X-Ref |
| Return the CSS class for the current topic in the loop. This class may contain keywords like 'alt', 'sticky', or 'closed', based on context. return: string Contents of the 'class' attribute. since: 1.1.0 |
| bp_my_forum_topics_link() X-Ref |
| Output the permalink to the 'personal' topics tab. since: 1.1.0 |
| bp_get_my_forum_topics_link() X-Ref |
| Return the permalink to the 'personal' topics tab. return: string Link to the 'personal' topics tab. since: 1.1.0 |
| bp_unreplied_forum_topics_link() X-Ref |
| Output the permalink to the 'unreplied' topics tab. since: 1.1.0 |
| bp_get_unreplied_forum_topics_link() X-Ref |
| Return the permalink to the 'unreplied' topics tab. return: string Link to the 'unreplied' topics tab. since: 1.1.0 |
| bp_popular_forum_topics_link() X-Ref |
| Output the permalink to the 'popular' topics tab. since: 1.1.0 |
| bp_get_popular_forum_topics_link() X-Ref |
| Return the permalink to the 'popular' topics tab. return: string Link to the 'popular' topics tab. since: 1.1.0 |
| bp_newest_forum_topics_link() X-Ref |
| Output the link to the forums directory. since: 1.1.0 |
| bp_get_newest_forum_topics_link() X-Ref |
| Return the link to the forums directory. return: string Link to the forums directory. since: 1.1.0 |
| bp_forum_topic_type() X-Ref |
| Output the currently viewed topic list type. since: 1.1.0 |
| bp_get_forum_topic_type() X-Ref |
| Return the currently viewed topic list type. Eg, 'newest', 'popular', etc. return: string Type of the currently viewed topic list. since: 1.1.0 |
| bp_forum_topic_new_reply_link() X-Ref |
| Output the value of bp_get_forum_topic_new_reply_link(). since: 1.5.0 |
| bp_get_forum_topic_new_reply_link() X-Ref |
| Return the permalink for the New Reply button at the top of forum topics. return: string The URL for the New Reply link. since: 1.5.0 |
| bp_forums_tag_name() X-Ref |
| Output the currently viewed tag name. since: 1.1.0 |
| bp_get_forums_tag_name() X-Ref |
| Return the currently viewed tag name. return: bool|string since: 1.1.0 |
| bp_forum_pagination() X-Ref |
| Output the pagination links for the current topic list. since: 1.0.0 |
| bp_get_forum_pagination() X-Ref |
| Return the pagination links for the current topic list. return: string HTML pagination links. since: 1.0.0 |
| bp_forum_pagination_count() X-Ref |
| Output the pagination count for the current topic list. since: 1.0.0 |
| bp_get_forum_pagination_count() X-Ref |
| Return the pagination count for the current topic list. The "count" is a string of the form "Viewing x of y topics". return: string since: 1.5.0 |
| bp_is_edit_topic() X-Ref |
| Are we currently on an Edit Topic screen? return: bool True if currently editing a topic, otherwise false. since: 1.1.0 |
Class: BP_Forums_Template_Topic - X-Ref
The single forum topic template loop class.| __construct( $topic_id, $per_page, $max, $order ) X-Ref |
| Constructor method. param: int $topic_id ID of the topic whose posts are being requested. param: int $per_page Number of items to return per page. param: int $max Max records to return. param: string $order Direction to order results. since: 1.5.0 |
| has_posts() X-Ref |
| Whether there are posts available in the loop. return: bool True if there are items in the loop, otherwise false. since: 1.0.0 |
| next_post() X-Ref |
| Set up the next post and iterate index. return: object The next post to iterate over. since: 1.0.0 |
| rewind_posts() X-Ref |
| Rewind the posts and reset post index. since: 1.0.0 |
| user_posts() X-Ref |
| Whether there are posts left in the loop to iterate over. This method is used by {@link bp_forum_topic_posts()} as part of the while loop that controls iteration inside the blogs loop, eg: while ( bp_forum_topic_posts() ) { ... return: bool True if there are more posts to show, otherwise false. since: 1.0.0 |
| the_post() X-Ref |
| Set up the current topic in the loop. since: 1.0.0 |
| bp_has_forum_topic_posts( $args = '' ) X-Ref |
| Initiate the loop for a single topic's posts. param: array|string $args { return: bool True when posts are found corresponding to the args, since: 1.1.0 |
| bp_forum_topic_posts() X-Ref |
| Determine whether there are posts left in the loop. return: bool True when posts are found. since: 1.1.0 |
| bp_the_forum_topic_post() X-Ref |
| Set up the current post in the loop. return: object since: 1.1.0 |
| bp_the_topic_post_id() X-Ref |
| Output the ID of the current post in the loop. since: 1.0.0 |
| bp_get_the_topic_post_id() X-Ref |
| Return the ID of the current post in the loop. return: int ID of the current post in the loop. since: 1.0.0 |
| bp_the_topic_post_content() X-Ref |
| Output the content of the current post in the loop. since: 1.0.0 |
| bp_get_the_topic_post_content() X-Ref |
| Return the content of the current post in the loop. return: string Content of the current post. since: 1.0.0 |
| bp_the_topic_post_css_class() X-Ref |
| Output the CSS class of the current post in the loop. since: 1.2.4 |
| bp_get_the_topic_post_css_class() X-Ref |
| Return the CSS class of the current post in the loop. May contain strings 'alt', 'deleted', or 'open', depending on context. return: string String to put in the 'class' attribute of the current since: 1.2.4 |
| bp_the_topic_post_poster_avatar( $args = '' ) X-Ref |
| Output the avatar of the user who posted the current post in the loop. param: array|string $args See {@link bp_get_the_topic_post_poster_avatar()}. since: 1.0.0 |
| bp_get_the_topic_post_poster_avatar( $args = '' ) X-Ref |
| Return the avatar of the user who posted the current post in the loop. param: array|string $args { return: string HTML of user avatar. since: 1.0.0 |
| bp_the_topic_post_poster_name() X-Ref |
| Output the name of the user who posted the current post in the loop. since: 1.0.0 |
| bp_get_the_topic_post_poster_name() X-Ref |
| Return the name of the user who posted the current post in the loop. return: string Name of the user who posted the current post. since: 1.0.0 |
| bp_the_topic_post_poster_link() X-Ref |
| Output a link to the profile of the user who posted the current post. since: 1.2.0 |
| bp_get_the_topic_post_poster_link() X-Ref |
| Return a link to the profile of the user who posted the current post. return: string Link to the profile of the user who posted the since: 1.2.0 |
| bp_the_topic_post_time_since() X-Ref |
| Output a 'since' string describing when the current post in the loop was posted. since: 1.0.0 |
| bp_get_the_topic_post_time_since() X-Ref |
| Return a 'since' string describing when the current post in the loop was posted. return: string since: 1.0.0 |
| bp_the_topic_post_is_mine() X-Ref |
| Output whether the current post in the loop belongs to the logged-in user. since: 1.1.0 |
| bp_get_the_topic_post_is_mine() X-Ref |
| Does the current post belong to the logged-in user? return: bool True if the current post in the loop was created by since: 1.1.0 |
| bp_the_topic_post_admin_links( $args = '' ) X-Ref |
| Output the admin links for the current post in the loop. param: array|string $args See {@link bp_get_the_post_admin_links()}. since: 1.1.0 |
| bp_get_the_topic_post_admin_links( $args = '' ) X-Ref |
| Return the admin links for the current post in the loop. param: array|string $args { return: string HTML string containing the admin links for the current post. since: 1.1.0 |
| bp_the_topic_post_edit_text() X-Ref |
| Output the text to edit when editing a post. since: 1.1.0 |
| bp_get_the_topic_post_edit_text() X-Ref |
| Return the text to edit when editing a post. return: string Editable text. since: 1.1.0 |
| bp_the_topic_pagination() X-Ref |
| Output the pagination links for the current topic. since: 1.0.0 |
| bp_get_the_topic_pagination() X-Ref |
| Return the pagination links for the current topic page. return: string HTML pagination links. since: 1.0.0 |
| bp_the_topic_pagination_count() X-Ref |
| Return the pagination count for the current topic page. The "count" is a string of the form "Viewing x of y posts". since: 1.0.0 |
| bp_the_topic_is_last_page() X-Ref |
| Output whether this is the last page in the current topic. since: 1.2.0 |
| bp_get_the_topic_is_last_page() X-Ref |
| Is this the last page in the current topic? return: bool True if this is the last page of posts for the current since: 1.2.0 |
| bp_directory_forums_search_form() X-Ref |
| Output the forums directory search form. since: 1.1.0 |
| bp_forum_permalink( $forum_id = 0 ) X-Ref |
| Output the link to a given forum. param: int $forum_id See {@link bp_get_forum_permalink()}. since: 1.0.0 |
| bp_get_forum_permalink( $forum_id = 0 ) X-Ref |
| Return the permalink to a given forum. param: int $forum_id Optional. Defaults to the current forum, if return: string|bool False on failure, a URL on success. since: 1.0.0 |
| bp_forum_name( $forum_id = 0 ) X-Ref |
| Output the name of a given forum. param: int $forum_id See {@link bp_get_forum_name()}. since: 1.5.0 |
| bp_get_forum_name( $forum_id = 0 ) X-Ref |
| Return the name of a given forum. param: int $forum_id Optional. Defaults to the current forum, if return: string|bool False on failure, a name on success. since: 1.5.0 |
| bp_forums_tag_heat_map( $args = '' ) X-Ref |
| Get a heatmap of forum tags for the installation. A wrapper for {@link bb_tag_heat_map}, which provides it with BP-friendly defaults. param: array|string $args { since: 1.1.0 |
| bp_forum_topic_tag_list() X-Ref |
| Output the current topic's tag list, comma-separated. since: 1.5.0 |
| bp_get_forum_topic_tag_list( $format = 'string' ) X-Ref |
| Get the current topic's tag list. param: string $format 'string' returns comma-separated string; return: mixed $tags since: 1.5.0 |
| bp_forum_topic_has_tags() X-Ref |
| Does the current topic have any tags? return: bool True if the current topic has tags, otherwise false. since: 1.5.0 |
| bp_forum_action() X-Ref |
| Output a URL to use in as a forum form 'action'. since: 1.0.0 |
| bp_get_forum_action() X-Ref |
| Get a URL to use in as a forum form 'action'. return: string URL of the current page, minus query args. since: 1.0.0 |
| bp_forum_topic_action() X-Ref |
| Output a URL to use in as a forum topic form 'action'. since: 1.0.0 |
| bp_get_forum_topic_action() X-Ref |
| Get a URL to use in as a forum topic form 'action'. return: string URL of the current page, minus query args. since: 1.0.0 |
| bp_forum_topic_count_for_user( $user_id = 0 ) X-Ref |
| Output the total topic count for a given user. param: int $user_id See {@link bp_get_forum_topic_count_for_user()}. since: 1.2.0 |
| bp_get_forum_topic_count_for_user( $user_id = 0 ) X-Ref |
| Return the total topic count for a given user. param: int $user_id See {@link bp_forums_total_topic_count_for_user}. return: int since: 1.2.0 |
| bp_forum_topic_count( $user_id = 0 ) X-Ref |
| Output the total topic count for a given user. param: int $user_id See {@link bp_get_forum_topic_count()}. since: 1.2.0 |
| bp_get_forum_topic_count( $user_id = 0 ) X-Ref |
| Return the total topic count for a given user. param: int $user_id See {@link bp_forums_total_topic_count()}. return: int since: 1.2.0 |
| bp_forums_slug() X-Ref |
| Output the forums component slug. since: 1.5.0 |
| bp_get_forums_slug() X-Ref |
| Return the forums component slug. return: string Slug for the forums component. since: 1.5.0 |
| bp_forums_root_slug() X-Ref |
| Output the forums component root slug. since: 1.5.0 |
| bp_get_forums_root_slug() X-Ref |
| Return the forums component root slug. return: string Root slug for the forums component. since: 1.5.0 |
| bp_forums_directory_permalink() X-Ref |
| Output permalink for the forum directory. since: 1.5.0 |
| bp_get_forums_directory_permalink() X-Ref |
| Return permalink for the forum directory. return: string The permalink for the forums component directory. since: 1.5.0 |
| Generated: Thu Dec 7 01:01:35 2017 | Cross-referenced by PHPXref 0.7.1 |