[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

/src/includes/common/ -> shortcodes.php (summary)

bbPress Shortcodes

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

Defines 1 class

BBP_Shortcodes:: (27 methods):
  __construct()
  setup_globals()
  add_shortcodes()
  unset_globals()
  start()
  end()
  display_forum_index()
  display_forum()
  display_forum_form()
  display_topic_index()
  display_topic()
  display_topic_form()
  display_reply()
  display_reply_form()
  display_topic_tags()
  display_topics_of_tag()
  display_topic_tag_form()
  display_view()
  display_search_form()
  display_search()
  display_login()
  display_register()
  display_lost_pass()
  display_stats()
  display_breadcrumb()
  display_topic_index_query()
  display_topics_of_tag_query()


Class: BBP_Shortcodes  - X-Ref

bbPress Shortcode Class

__construct()   X-Ref
Add the register_shortcodes action to bbp_init

since: 2.0.0 bbPress (r3031)

setup_globals()   X-Ref
Shortcode globals

since: 2.0.0 bbPress (r3143)

add_shortcodes()   X-Ref
Register the bbPress shortcodes

since: 2.0.0 bbPress (r3031)

unset_globals()   X-Ref
Unset some globals in the $bbp object that hold query related info

since: 2.0.0 bbPress (r3034)

start( $query_name = '' )   X-Ref
Start an output buffer.

This is used to put the contents of the shortcode into a variable rather
than outputting the HTML at run-time. This allows shortcodes to appear
in the correct location in the_content() instead of when it's created.

param: string $query_name
since: 2.0.0 bbPress (r3079)

end()   X-Ref
Return the contents of the output buffer and flush its contents.

since: 2.0.0 bbPress (r3079)
return: string Contents of output buffer.

display_forum_index()   X-Ref
Display an index of all visible root level forums in an output buffer
and return to ensure that post/page contents are displayed first.

since: 2.0.0 bbPress (r3031)
return: string

display_forum( $attr, $content = '' )   X-Ref
Display the contents of a specific forum ID in an output buffer
and return to ensure that post/page contents are displayed first.

param: array $attr
param: string $content
since: 2.0.0 bbPress (r3031)
return: string

display_forum_form()   X-Ref
Display the forum form in an output buffer and return to ensure
post/page contents are displayed first.

since: 2.1.0 bbPress (r3566)

display_topic_index()   X-Ref
Display an index of all visible root level topics in an output buffer
and return to ensure that post/page contents are displayed first.

since: 2.0.0 bbPress (r3031)
return: string

display_topic( $attr, $content = '' )   X-Ref
Display the contents of a specific topic ID in an output buffer
and return to ensure that post/page contents are displayed first.

param: array $attr
param: string $content
since: 2.0.0 bbPress (r3031)
return: string

display_topic_form( $attr = array()   X-Ref
Display the topic form in an output buffer and return to ensure
post/page contents are displayed first.

Supports 'forum_id' attribute to display the topic form for a particular
forum. This currently has styling issues from not being wrapped in
<div id="bbpress-forums" class="bbpress-wrapper"></div> which will need to be sorted out later.

param: array $attr
param: string $content
since: 2.0.0 bbPress (r3031)
return: string

display_reply( $attr, $content = '' )   X-Ref
Display the contents of a specific reply ID in an output buffer
and return to ensure that post/page contents are displayed first.

param: array $attr
param: string $content
since: 2.0.0 bbPress (r3031)
return: string

display_reply_form()   X-Ref
Display the reply form in an output buffer and return to ensure
post/page contents are displayed first.

since: 2.0.0 bbPress (r3031)

display_topic_tags()   X-Ref
Display a tag cloud of all topic tags in an output buffer and return to
ensure that post/page contents are displayed first.

since: 2.0.0 bbPress (r3110)
return: string

display_topics_of_tag( $attr, $content = '' )   X-Ref
Display the contents of a specific topic tag in an output buffer
and return to ensure that post/page contents are displayed first.

param: array $attr
param: string $content
since: 2.0.0 bbPress (r3110)
return: string

display_topic_tag_form()   X-Ref
Display the contents of a specific topic tag in an output buffer
and return to ensure that post/page contents are displayed first.

since: 2.0.0 bbPress (r3346)
return: string

display_view( $attr, $content = '' )   X-Ref
Display the contents of a specific view in an output buffer and return to
ensure that post/page contents are displayed first.

param: array $attr
param: string $content
since: 2.0.0 bbPress (r3031)
return: string

display_search_form()   X-Ref
Display the search form in an output buffer and return to ensure
post/page contents are displayed first.

since: 2.3.0 bbPress (r4585)

display_search( $attr, $content = '' )   X-Ref
Display the contents of search results in an output buffer and return to
ensure that post/page contents are displayed first.

param: array $attr
param: string $content
since: 2.3.0 bbPress (r4579)

display_login()   X-Ref
Display a login form

since: 2.0.0 bbPress (r3302)
return: string

display_register()   X-Ref
Display a register form

since: 2.0.0 bbPress (r3302)
return: string

display_lost_pass()   X-Ref
Display a lost password form

since: 2.0.0 bbPress (r3302)
return: string

display_stats()   X-Ref
Display forum statistics

since: 2.3.0 bbPress (r4509)
return: string

display_breadcrumb()   X-Ref
Display a breadcrumb

since: 2.0.0 bbPress (r3302)
return: string

display_topic_index_query( $args = array()   X-Ref
Filter the query for the topic index

param: array $args
since: 2.1.0 bbPress (r3637)
return: array

display_topics_of_tag_query( $args = array()   X-Ref
Filter the query for topic tags

param: array $args
since: 2.1.0 bbPress (r3637)
return: array



Generated: Thu Mar 28 01:00:51 2024 Cross-referenced by PHPXref 0.7.1