Changeset 7380

trunk/bbpress.php

r7340	r7380
2	2
3	3	/**
4		* The bbPress Plugin
	4	* The bbPress Plugin.
5	5	*
6	6	* bbPress is forum software with a twist from the creators of WordPress.

trunk/src/bbpress.php

-                      r7378
+                      r7380
 /**
  * The bbPress Plugin
+ * The bbPress Plugin.
+ *
  * bbPress is forum software with a twist from the creators of WordPress.
 …
 if ( ! class_exists( 'bbPress' ) ) :
 /**
  * Main bbPress Class
+ * Main bbPress Class.
+ *
  * "Word hard. Stay bumble."
 …
     /**
      * @var mixed False when not logged in; WP_User object when logged in
+     * @var mixed False when not logged in; WP_User object when logged in.
      */
     public $current_user = false;
 …
     /**
      * @var array Topic views
+     * @var array Topic views.
      */
     public $views = array();
     /**
      * @var array Overloads get_option()
+     * @var array Overloads get_option().
      */
     public $options = array();
     /**
      * @var array Storage of options not in the database
+     * @var array Storage of options not in the database.
      */
     public $not_options = array();
     /**
      * @var array Overloads get_user_meta()
+     * @var array Overloads get_user_meta().
      */
     public $user_options = array();
     /**
      * @var array Dynamically initialized user roles
+     * @var array Dynamically initialized user roles.
      */
     public $roles = array();
 …
     /**
      * Main bbPress Instance
+     *
      * bbPress is fun
      * Please load it only one time
      * For this, we thank you
+     * Main bbPress Instance.
+     *
+     * bbPress is fun.
+     * Please load it only one time.
+     * For this, we thank you.
+     *
      * Insures that only one instance of bbPress exists in memory at any one
 …
      * @staticvar object $instance
      * @see bbpress()
      * @return bbPress The one true bbPress
+     * @return bbPress The one true bbPress.
      */
     public static function instance() {
 …
     /**
      * A dummy magic method to prevent bbPress from being cloned
+     * A dummy magic method to prevent bbPress from being cloned.
+     *
      * @since 2.0.0 bbPress (r2464)
 …
     /**
      * A dummy magic method to prevent bbPress from being unserialized
+     * A dummy magic method to prevent bbPress from being unserialized.
+     *
      * @since 2.0.0 bbPress (r2464)
 …
     /**
      * Magic method for checking the existence of a certain custom field
+     * Magic method for checking the existence of a certain custom field.
+     *
      * @since 2.1.0 bbPress (r3951)
 …
     /**
      * Magic method for getting bbPress variables
+     * Magic method for getting bbPress variables.
+     *
      * @since 2.1.0 bbPress (r3951)
 …
     /**
      * Magic method for setting bbPress variables
+     * Magic method for setting bbPress variables.
+     *
      * @since 2.1.0 bbPress (r3951)
 …
     /**
      * Magic method for unsetting bbPress variables
+     * Magic method for unsetting bbPress variables.
+     *
      * @since 2.3.0 bbPress (r4628)
 …
     /**
      * Magic method to prevent notices and errors from invalid method calls
+     * Magic method to prevent notices and errors from invalid method calls.
+     *
      * @since 2.2.0 bbPress (r4252)
 …
     /**
      * Include required files
+     * Include required files.
+     *
      * @since 2.0.0 bbPress (r2626)
 …
     /**
      * Setup the default hooks and actions
+     * Setup the default hooks and actions.
+     *
      * @since 2.0.0 bbPress (r2644)
 …
     /**
      * Register bundled theme packages
+     * Register bundled theme packages.
+     *
      * Note that since we currently have complete control over bbp-themes and
 …
     /**
      * Setup the post types for forums, topics and replies
+     * Setup the post types for forums, topics and replies.
+     *
      * @since 2.0.0 bbPress (r2597)
 …
     /**
      * Register the post statuses used by bbPress
+     * Register the post statuses used by bbPress.
+     *
      * We do some manipulation of the 'trash' status so trashed topics and
 …
         /**
          * Trash fix
+         * Trash fix.
+         *
          * We need to remove the internal arg and change that to
 …
     /**
      * Register the topic tag and forum moderator taxonomies
+     * Register the topic tag and forum moderator taxonomies.
+     *
      * @since 2.0.0 bbPress (r2464) Added bbp_get_topic_tag_tax_id() taxonomy
 …
     /**
      * Register the bbPress views
+     * Register the bbPress views.
+     *
      * @since 2.0.0 bbPress (r2789)
 …
     /**
      * Register the bbPress shortcodes
+     * Register the bbPress shortcodes.
+     *
      * @since 2.0.0 bbPress (r3031)
 …
     /**
      * Register bbPress meta-data
+     *
      * Counts added in 2.6.0 to avoid negative values
+     * Register bbPress meta-data.
+     *
+     * Counts added in 2.6.0 to avoid negative values.
+     *
      * @since 2.6.0 bbPress (r6300)
 …
     /**
      * Setup the currently logged-in user
+     * Setup the currently logged-in user.
+     *
      * @since 2.0.0 bbPress (r2697)
 …
     /**
      * Setup the user engagements strategy
+     * Setup the user engagements strategy.
+     *
      * @since 2.6.0 bbPress (r6875)
 …
     /**
      * Initialize forum-specific roles
+     * Initialize forum-specific roles.
+     *
      * @since 2.6.0
 …
     /**
      * Add the bbPress-specific rewrite tags
+     * Add the bbPress-specific rewrite tags.
+     *
      * @since 2.0.0 bbPress (r2753)

trunk/src/includes/admin/actions.php

-                      r7376
+                      r7380
 /**
  * bbPress Admin Actions
+ * bbPress Admin Actions.
+ *
  * This file contains the actions that are used through-out bbPress Admin. They
 …
 /**
  * Setup bbPress admin
+ * Setup bbPress admin.
+ *
  * @since 2.0.0 bbPress (r1000)
 …
 /**
  * When a new site is created in a multisite installation, run the activation
  * routine on that site
+ * routine on that site.
+ *
  * @since 2.0.0 bbPress (r3283)
 …
 /**
  * Show icons in list-table column headers instead of strings
+ * Show icons in list-table column headers instead of strings.
+ *
  * @since 2.6.0 bbPress (r5833)
+ *
  * @param  array $columns Column headers fed into list-table objects
+ *
  * @return array Possibly altered column headers
+ * @param  array $columns Column headers fed into list-table objects.
+ *
+ * @return array Possibly altered column headers.
  */
 function bbp_filter_column_headers( $columns = array() ) {
 …
  * @since 2.0.0 bbPress (r3336)
+ *
  * @param string $post_link Custom post type permalink
  * @param object $_post Post data object
+ * @param string $post_link Custom post type permalink.
+ * @param object $_post Post data object.
  * @param bool $leavename Optional, defaults to false. Whether to keep post name or page name.
  * @param bool $sample Optional, defaults to false. Is it a sample permalink.
+ *
  * @return string The custom post type permalink
+ * @return string The custom post type permalink.
  */
 function bbp_filter_sample_permalink( $post_link, $_post, $leavename = false, $sample = false ) {
 …
 /**
  * Piggy back admin_init action
+ * Piggy back admin_init action.
+ *
  * @since 2.1.0 bbPress (r3766)
 …
 /**
  * Piggy back admin_menu action
+ * Piggy back admin_menu action.
+ *
  * @since 2.1.0 bbPress (r3766)
 …
 /**
  * Piggy back admin_head action
+ * Piggy back admin_head action.
+ *
  * @since 2.1.0 bbPress (r3766)
 …
 /**
  * Piggy back admin_notices action
+ * Piggy back admin_notices action.
+ *
  * @since 2.1.0 bbPress (r3766)
 …
 /**
  * Dedicated action to register bbPress importers
+ * Dedicated action to register bbPress importers.
+ *
  * @since 2.1.0 bbPress (r3766)
 …
 /**
  * Dedicated action to register admin styles
+ * Dedicated action to register admin styles.
+ *
  * @since 2.6.0 bbPress (r6912)
 …
     /**
      * Action used to register the admin styling
+     * Action used to register the admin styling.
+     *
      * @since 2.1.0
 …
     /**
      * Action used to register all admin styling
+     * Action used to register all admin styling.
+     *
      * @since 2.6.0
 …
 /**
  * Dedicated action to register admin scripts
+ * Dedicated action to register admin scripts.
+ *
  * @since 2.6.0 bbPress (r6912)
 …
 /**
  * Dedicated action to register admin settings
+ * Dedicated action to register admin settings.
+ *
  * @since 2.1.0 bbPress (r3766)
 …
 /**
  * Dedicated action to output admin tools.php sections
+ * Dedicated action to output admin tools.php sections.
+ *
  * @since 2.6.0 bbPress (r6273)
 …
 /**
  * Dedicated action to hook into the current screen
+ * Dedicated action to hook into the current screen.
+ *
  * @since 2.6.0 bbPress (r6185)

trunk/src/includes/admin/classes/class-bbp-admin.php

-                      r7379
+                      r7380
     /**
+     * @var string Path to the bbPress admin directory
+     * Path to the bbPress admin directory.
+     *
+     * @var string
      */
     public $admin_dir = '';
 …
     /**
+     * @var string URL to the bbPress admin directory
+     * URL to the bbPress admin directory.
+     *
+     * @var string
      */
     public $admin_url = '';
     /**
+     * @var string URL to the bbPress images directory
+     * URL to the bbPress images directory.
+     *
+     * @var string
      */
     public $images_url = '';
     /**
+     * @var string URL to the bbPress admin styles directory
+     * URL to the bbPress admin styles directory.
+     *
+     * @var string
      */
     public $styles_url = '';
     /**
+     * @var string URL to the bbPress admin css directory
+     * URL to the bbPress admin css directory.
+     *
+     * @var string
      */
     public $css_url = '';
     /**
+     * @var string URL to the bbPress admin js directory
+     * URL to the bbPress admin js directory.
+     *
+     * @var string
      */
     public $js_url = '';
 …
     /**
+     * @var bool Minimum capability to access Tools and Settings
+     * Minimum capability to access Tools and Settings.
+     *
+     * @var bool
      */
     public $minimum_capability = 'keep_gate';
 …
     /**
+     * @var bool Whether or not to add an extra top level menu separator
+     * Whether or not to add an extra top level menu separator.
+     *
+     * @var bool
      */
     public $show_separator = false;
 …
     /**
+     * @var array Array of available repair tools
+     * Array of available repair tools.
+     *
+     * @var array
      */
     public $tools = array();
 …
     /**
+     * @var array Array of notices to output to the current user
+     * Array of notices to output to the current user.
+     *
+     * @var array
      */
     public $notices = array();
 …
     /**
+     * @var BBP_Forums_Admin Forums admin
+     * Forums admin.
+     *
+     * @var BBP_Forums_Admin
      */
     public $forums = null;
     /**
+     * @var BBP_Topics_Admin Topics admin
+     * Topics admin.
+     *
+     * @var BBP_Topics_Admin
      */
     public $topics = null;
     /**
+     * @var BBP_Replies_Admin Replies admin
+     * Replies admin.
+     *
+     * @var BBP_Replies_Admin
      */
     public $replies = null;
     /**
+     * @var BBP_Converter Converter admin
+     * Converter admin.
+     *
+     * @var BBP_Converter
      */
     public $converter = null;
 …
     /**
      * The main bbPress admin loader
+     * The main bbPress admin loader.
+     *
      * @since 2.0.0 bbPress (r2515)
 …
     /**
      * Admin globals
+     * Admin globals.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Include required files
+     * Include required files.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Setup the admin hooks, actions and filters
+     * Setup the admin hooks, actions and filters.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Output all admin area notices
+     * Output all admin area notices.
+     *
      * @since 2.6.0 bbPress (r6771)
 …
     /**
      * Add a notice to the notices array
+     * Add a notice to the notices array.
+     *
      * @since 2.6.0 bbPress (r6771)
+     *
      * @param string|WP_Error $message        A message to be displayed or {@link WP_Error}
      * @param string          $class          Optional. A class to be added to the message div
      * @param bool            $is_dismissible Optional. True to dismiss, false to persist
+     *
      * @return void
+     * @param string|WP_Error $message        A message to be displayed or {@link WP_Error}.
+     * @param string          $class          Optional. A class to be added to the message div.
+     * @param bool            $is_dismissible Optional. True to dismiss, false to persist.
+     *
+     * @return bool|void False on failure, void otherwise.
      */
     public function add_notice( $message, $class = false, $is_dismissible = true ) {
 …
     /**
      * Escape message string output
+     * Escape message string output.
+     *
      * @since 2.6.0 bbPress (r6775)
+     *
      * @param string $message
+     * @param string $message The message.
+     *
      * @return string
 …
     /**
      * Add the admin menus
+     * Add the admin menus.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Add the network admin menus
+     * Add the network admin menus.
+     *
      * @since 2.1.0 bbPress (r3689)
 …
     /**
      * Register the settings
+     * Register the settings.
+     *
      * @since 2.0.0 bbPress (r2737)
+     *
      * @todo Put fields into multidimensional array
+     * @todo Put fields into multidimensional array.
      */
     public static function register_admin_settings() {
 …
     /**
      * Maps settings capabilities
+     * Maps settings capabilities.
+     *
      * @since 2.2.0 bbPress (r4242)
+     *
      * @param array $caps Capabilities for meta capability
      * @param string $cap Capability name
      * @param int $user_id User id
      * @param array $args Arguments
+     *
      * @return array Actual capabilities for meta capability
+     * @param array $caps Capabilities for meta capability.
+     * @param string $cap Capability name.
+     * @param int $user_id User id.
+     * @param array $args Arguments.
+     *
+     * @return array Actual capabilities for meta capability.
      */
     public static function map_settings_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {
 …
     /**
      * Register the importers
+     * Register the importers.
+     *
      * @since 2.0.0 bbPress (r2737)
 …
     /**
      * Add Settings link to plugins area
+     * Add Settings link to plugins area.
+     *
      * @since 2.0.0 bbPress (r2737)
+     *
      * @param array $links Links array in which we would prepend our link
      * @param string $file Current plugin basename
      * @return array Processed links
+     * @param array $links Links array in which we would prepend our link.
+     * @param string $file Current plugin basename.
+     * @return array Processed links.
      */
     public static function modify_plugin_action_links( $links, $file ) {
 …
     /**
      * Enqueue any admin scripts we might need
+     * Enqueue any admin scripts we might need.
+     *
      * @since 2.2.0 bbPress (r4260)
 …
     /**
      * Enqueue any admin scripts we might need
+     * Enqueue any admin scripts we might need.
+     *
      * @since 2.6.0 bbPress (r5224)
 …
     /**
      * Remove the individual recount and converter menus.
      * They are grouped together by h2 tabs
+     * They are grouped together by h2 tabs.
+     *
      * @since 2.0.0 bbPress (r2464)
 …
     /**
      * Registers the bbPress admin styling and color schemes
+     * Registers the bbPress admin styling and color schemes.
+     *
      * Because wp-content can exist outside of the WordPress root, there is no
 …
     /**
      * Registers the bbPress admin color schemes
+     * Registers the bbPress admin color schemes.
+     *
      * Because wp-content can exist outside of the WordPress root there is no
 …
     /**
      * Allow keymaster role to save Forums settings
+     * Allow keymaster role to save Forums settings.
+     *
      * @since 2.3.0 bbPress (r4678)
+     *
      * @param string $capability
      * @return string Return minimum capability
+     * @param string $capability Optional. Default 'manage_options'.
+     * @return string Return minimum capability.
      */
     public function option_page_capability_bbpress( $capability = 'manage_options' ) {
 …
     /**
      * Ajax action for facilitating the forum auto-suggest
+     * Ajax action for facilitating the forum auto-suggest.
+     *
      * @since 2.2.0 bbPress (r4261)
 …
     /**
      * Ajax action for facilitating the topic and reply author auto-suggest
+     * Ajax action for facilitating the topic and reply author auto-suggest.
+     *
      * @since 2.4.0 bbPress (r5014)
 …
     /**
      * Output the shared screen header for about_screen() & credits_screen()
+     *
      * Contains title, subtitle, and badge area
+     * Output the shared screen header for about_screen() & credits_screen().
+     *
+     * Contains title, subtitle, and badge area.
+     *
      * @since 2.6.0 bbPress (r6604)
 …
     /**
      * Output the about screen
+     * Output the about screen.
+     *
      * @since 2.2.0 bbPress (r4159)
 …
     /**
      * Output the credits screen
+     * Output the credits screen.
+     *
      * @since 2.2.0 bbPress (r4159)
 …
     /**
      * Update all bbPress forums across all sites
+     * Update all bbPress forums across all sites.
+     *
      * @since 2.1.0 bbPress (r3689)
 …
     /**
      * Update all bbPress forums across all sites
+     * Update all bbPress forums across all sites.
+     *
      * @since 2.1.0 bbPress (r3689)

trunk/src/includes/admin/classes/class-bbp-converter-base.php

-                      r7378
+                      r7380
 /**
  * bbPress Converter Base Class
+ * bbPress Converter Base Class.
+ *
  * Based on the hard work of Adam Ellis
+ * Based on the hard work of Adam Ellis.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Converter_Base' ) ) :
 /**
  * Base class to be extended by specific individual importers
+ * Base class to be extended by specific individual importers.
+ *
  * phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
 …
     /**
      * Setup global values
+     * Setup global values.
      */
     public function setup_globals() {}
     /**
      * Convert Forums
+     * Convert Forums.
      */
     public function convert_forums( $start = 1 ) {
 …
     /**
      * Convert Topics / Threads
+     * Convert Topics / Threads.
      */
     public function convert_topics( $start = 1 ) {
 …
     /**
      * Convert Posts
+     * Convert Posts.
      */
     public function convert_replies( $start = 1 ) {
 …
     /**
      * Convert Users
+     * Convert Users.
      */
     public function convert_users( $start = 1 ) {
 …
     /**
      * Convert Topic Tags
+     * Convert Topic Tags.
      */
     public function convert_tags( $start = 1 ) {
 …
     /**
      * Convert Forum Subscriptions
+     * Convert Forum Subscriptions.
      */
     public function convert_forum_subscriptions( $start = 1 ) {
 …
     /**
      * Convert Topic Subscriptions
+     * Convert Topic Subscriptions.
      */
     public function convert_topic_subscriptions( $start = 1 ) {
 …
     /**
      * Convert Favorites
+     * Convert Favorites.
      */
     public function convert_favorites( $start = 1 ) {
 …
     /**
      * Convert Table
+     * Convert Table.
+     *
      * @param string to type
 …
     /**
      * This method grabs appropriate fields from the table specified
+     *
      * @param string The table name to grab fields from
+     * This method grabs appropriate fields from the table specified.
+     *
+     * @param string The table name to grab fields from.
      */
     private function get_fields( $tablename = '' ) {
 …
     /**
      * Update the last query option and return results
+     * Update the last query option and return results.
+     *
      * @param string $query
 …
     /**
      * Update the last query option and return results
+     * Update the last query option and return results.
+     *
      * @param string $query
 …
     /**
      * Update the last query option and do a general query
+     * Update the last query option and do a general query.
+     *
      * @param string $query
 …
     /**
      * Update the last query ran
+     * Update the last query ran.
+     *
      * @since 2.6.0 bbPress (r6637)
+     *
      * @param string $query The literal MySQL query
+     * @param string $query The literal MySQL query.
      * @return bool
      */
 …
     /**
      * Update the number of rows in the current step
+     * Update the number of rows in the current step.
+     *
      * @since 2.6.0 bbPress (r6637)
+     *
      * @param string $query The literal MySQL query
+     * @param string $query The literal MySQL query.
      * @return bool
      */
 …
     /**
      * Update the number of rows in the current step
+     * Update the number of rows in the current step.
+     *
      * @since 2.6.0 bbPress (r6637)
+     *
      * @param string $table_name The literal MySQL query
+     * @param string $table_name The literal MySQL query.
      * @return bool
      */
 …
     /**
      * Run password through wp_hash_password()
+     * Run password through wp_hash_password().
+     *
      * @param string $username
 …
     /**
      * A mini cache system to reduce database calls to forum ID's
+     * A mini cache system to reduce database calls to forum ID's.
+     *
      * @param string $field
 …
     /**
      * A mini cache system to reduce database calls to topic ID's
+     * A mini cache system to reduce database calls to topic ID's.
+     *
      * @param string $field
 …
     /**
      * A mini cache system to reduce database calls to user ID's
+     * A mini cache system to reduce database calls to user ID's.
+     *
      * @param string $field
 …
     /**
      * Check if the topic or reply author is anonymous
+     * Check if the topic or reply author is anonymous.
+     *
      * @since 2.6.0 bbPress (r5544)
 …
     /**
      * A mini cache system to reduce database calls map topics ID's to forum ID's
+     * A mini cache system to reduce database calls map topics ID's to forum ID's.
+     *
      * @param string $field

trunk/src/includes/admin/classes/class-bbp-converter-db.php

-                      r7268
+                      r7380
 /**
  * bbPress Converter Database
+ * bbPress Converter Database.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Converter_DB' ) && class_exists( 'wpdb' ) ) :
 /**
  * bbPress Converter Database Access Abstraction Object
+ * bbPress Converter Database Access Abstraction Object.
+ *
  * @since 2.6.0 bbPress (r6784)

trunk/src/includes/admin/classes/class-bbp-converter.php

-                      r7379
+                      r7380
     /**
+     * @var int Number of rows
+     * Number of rows.
+     *
+     * @var int
      */
     public $max = 0;
     /**
+     * @var int Start
+     * Start.
+     *
+     * @var int
      */
     public $start = 0;
     /**
+     * @var int Step in converter process
+     * Step in converter process.
+     *
+     * @var int
      */
     public $step = 0;
     /**
+     * @var int Number of rows
+     * Number of rows.
+     *
+     * @var int
      */
     public $rows = 0;
     /**
+     * @var int Maximum number of converter steps
+     * Maximum number of converter steps.
+     *
+     * @var int
      */
     public $max_steps = 17;
     /**
+     * @var int Number of rows in the current step
+     * Number of rows in the current step.
+     *
+     * @var int
      */
     public $rows_in_step = 0;
     /**
+     * @var int Percent complete of current step
+     * Percent complete of current step.
+     *
+     * @var int
      */
     public $step_percentage = 0;
     /**
+     * @var int Percent complete of all step
+     * Percent complete of all step.
+     *
+     * @var int
      */
     public $total_percentage = 0;
     /**
+     * @var int Name of source forum platform
+     * Name of source forum platform.
+     *
+     * @var int
      */
     public $platform = '';
     /**
+     * @var BBP_Converter_Base Type of converter to use
+     * Type of converter to use.
+     *
+     * @var BBP_Converter_Base
      */
     public $converter = null;
     /**
+     * @var string Path to included platforms
+     * Path to included platforms.
+     *
+     * @var string
      */
     public $converters_dir = '';
     /**
+     * @var array Map of steps to methods
+     * Map of steps to methods.
+     *
+     * @var array
      */
     private $steps = array(

trunk/src/includes/admin/classes/class-bbp-topic-replies-list-table.php

-                      r7379
+                      r7380
 if ( class_exists( 'WP_List_Table' ) ) :
 /**
  * Topic replies list table
+ * Topic replies list table.
+ *
  * This list table is responsible for showing the replies to a topic in a
 …
     /**
      * The main constructor method
+     * The main constructor method.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Setup the list-table columns
+     * Setup the list-table columns.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Allow `bbp_reply_created` to be sortable
+     *
      * @since 2.6.0 bbPress (r5886)
+     *
      * @return array An associative array containing the `bbp_reply_created` column
+     * Allow `bbp_reply_created` to be sortable.
+     *
+     * @since 2.6.0 bbPress (r5886)
+     *
+     * @return array An associative array containing the `bbp_reply_created` column.
      */
     public function get_sortable_columns() {
 …
     /**
      * Setup the bulk actions
+     *
      * @since 2.6.0 bbPress (r5886)
+     *
      * @return array An associative array containing all the bulk actions
+     * Setup the bulk actions.
+     *
+     * @since 2.6.0 bbPress (r5886)
+     *
+     * @return array An associative array containing all the bulk actions.
      */
     public function get_bulk_actions() {
 …
     /**
      * Output the check-box column for bulk actions (if we implement them)
+     * Output the check-box column for bulk actions (if we implement them).
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Output the contents of the `bbp_topic_reply_author` column
+     * Output the contents of the `bbp_topic_reply_author` column.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Output the contents of the `bbp_reply_created` column
+     * Output the contents of the `bbp_reply_created` column.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Output the contents of the `bbp_reply_content` column
+     * Output the contents of the `bbp_reply_content` column.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Handle bulk action requests
+     * Handle bulk action requests.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Prepare the list-table items for display
+     * Prepare the list-table items for display.
+     *
      * @since 2.6.0 bbPress (r5886)
 …
     /**
      * Message to be displayed when there are no items
+     * Message to be displayed when there are no items.
+     *
      * @since 2.6.0 bbPress (r5930)
 …
     /**
      * Display the list table
+     * Display the list table.
+     *
      * This custom method is necessary because the one in `WP_List_Table` comes
 …
     /**
      * Generate the table navigation above or below the table
+     * Generate the table navigation above or below the table.
+     *
      * This custom method is necessary because the one in `WP_List_Table` comes
 …
     /**
      * Generates content for a single row of the table
+     * Generates content for a single row of the table.
+     *
      * @since 2.6.0
      * @access public
+     *
      * @param object $item The current item
+     * @param object $item The current item.
      */
     public function single_row( $item ) {

trunk/src/includes/admin/common.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Functions
+ * bbPress Admin Functions.
+ *
  * @package bbPress
 …
 /**
  * Add a separator to the WordPress admin menus
+ * Add a separator to the WordPress admin menus.
+ *
  * @since 2.0.0 bbPress (r2957)
 …
 /**
  * Tell WordPress we have a custom menu order
+ * Tell WordPress we have a custom menu order.
+ *
  * @since 2.0.0 bbPress (r2957)
+ *
  * @param bool $menu_order Menu order
  * @return mixed True if separator, false if not
+ * @param bool $menu_order Menu order.
+ * @return mixed True if separator, false if not.
  */
 function bbp_admin_custom_menu_order( $menu_order = false ) {
 …
 /**
  * Move our custom separator above our custom post types
+ * Move our custom separator above our custom post types.
+ *
  * @since 2.0.0 bbPress (r2957)
+ *
  * @param array $menu_order Menu Order
  * @return array Modified menu order
+ * @param array $menu_order Menu Order.
+ * @return array Modified menu order.
  */
 function bbp_admin_menu_order( $menu_order ) {
 …
  * @since 2.1.0 bbPress (r3765)
+ *
  * @param int $site_id
+ * @param int $site_id Site id.
  */
 function bbp_do_uninstall( $site_id = 0 ) {

trunk/src/includes/admin/forums.php

-                      r7378
+                      r7380
 /**
  * bbPress Forum Admin Class
+ * bbPress Forum Admin Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Forums_Admin' ) ) :
 /**
  * Loads bbPress forums admin area
+ * Loads bbPress forums admin area.
+ *
  * @package bbPress
 …
     /**
      * @var string The post type of this admin component
+     * @var string The post type of this admin component.
      */
     private $post_type = '';
 …
     /**
      * The main bbPress forums admin loader
+     * The main bbPress forums admin loader.
+     *
      * @since 2.0.0 bbPress (r2515)
 …
     /**
      * Setup the admin hooks, actions and filters
+     * Setup the admin hooks, actions and filters.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Admin globals
+     * Admin globals.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Contextual help for bbPress forum edit page
+     * Contextual help for bbPress forum edit page.
+     *
      * @since 2.0.0 bbPress (r3119)
 …
     /**
      * Contextual help for bbPress forum edit page
+     * Contextual help for bbPress forum edit page.
+     *
      * @since 2.0.0 bbPress (r3119)
 …
     /**
      * Add the forum attributes meta-box
+     * Add the forum attributes meta-box.
+     *
      * @since 2.0.0 bbPress (r2746)
 …
     /**
      * Add the forum moderators meta-box
+     * Add the forum moderators meta-box.
+     *
      * @since 2.6.0 bbPress
 …
     /**
      * Add the subscriptions meta-box
+     * Add the subscriptions meta-box.
+     *
      * Allows viewing of users who have subscribed to a forum.
 …
     /**
      * Remove comments & discussion meta-boxes if comments are not supported
+     * Remove comments & discussion meta-boxes if comments are not supported.
+     *
      * @since 2.6.0 bbPress (r6186)
 …
     /**
      * Pass the forum attributes for processing
+     * Pass the forum attributes for processing.
+     *
      * @since 2.0.0 bbPress (r2746)
+     *
      * @param int $forum_id Forum id
      * @return int Forum id
+     * @param int $forum_id Forum id.
+     * @return int Forum id.
      */
     public function save_meta_boxes( $forum_id ) {
 …
     /**
      * Toggle forum
+     *
      * Handles the admin-side opening/closing of forums
+     * Toggle forum.
+     *
+     * Handles the admin-side opening/closing of forums.
+     *
      * @since 2.6.0 bbPress (r5254)
 …
     /**
      * Toggle forum notices
+     * Toggle forum notices.
+     *
      * Display the success/error notices from
 …
     /**
      * Returns an array of keys used to sort row actions
+     * Returns an array of keys used to sort row actions.
+     *
      * @since 2.6.0 bbPress (r6771)
 …
     /**
      * Returns an array of notice toggles
+     * Returns an array of notice toggles.
+     *
      * @since 2.6.0 bbPress (r6396)
 …
     /**
      * Returns an array of notice toggles
+     * Returns an array of notice toggles.
+     *
      * @since 2.6.0 bbPress (r6396)
 …
     /**
      * Manage the column headers for the forums page
+     * Manage the column headers for the forums page.
+     *
      * @since 2.0.0 bbPress (r2485)
+     *
      * @param array $columns The columns
+     *
      * @return array $columns bbPress forum columns
+     * @param array $columns The columns.
+     *
+     * @return array $columns bbPress forum columns.
      */
     public function column_headers( $columns ) {
 …
     /**
      * Print extra columns for the forums page
+     * Print extra columns for the forums page.
+     *
      * @since 2.0.0 bbPress (r2485)
+     *
      * @param string $column Column
      * @param int $forum_id Forum id
+     * @param string $column Column.
+     * @param int $forum_id Forum id.
      */
     public function column_data( $column, $forum_id ) {
 …
     /**
      * Forum Row actions
+     * Forum Row actions.
+     *
      * Remove the quick-edit action link and display the description under
      * the forum title and add the open/close links
+     * the forum title and add the open/close links.
+     *
      * @since 2.0.0 bbPress (r2577)
+     *
      * @param array  $actions Actions
      * @param object $forum   Forum object
+     *
      * @return array $actions Actions
+     * @param array  $actions Actions.
+     * @param object $forum   Forum object.
+     *
+     * @return array $actions Actions.
      */
     public function row_actions( $actions = array(), $forum = false ) {
 …
     /**
      * Sort row actions by key
+     * Sort row actions by key.
+     *
      * @since 2.6.0
+     *
      * @param array $actions
+     * @param array $actions.
+     *
      * @return array
 …
     /**
      * Custom user feedback messages for forum post type
+     * Custom user feedback messages for forum post type.
+     *
      * @since 2.0.0 bbPress (r3080)
 …
 /**
  * Setup bbPress Forums Admin
+ * Setup bbPress Forums Admin.
+ *
  * This is currently here to make hooking and unhooking of the admin UI easy.
 …
  * @since 2.0.0 bbPress (r2596)
+ *
  * @param WP_Screen $current_screen Current screen object
+ * @param WP_Screen $current_screen Current screen object.
  */
 function bbp_admin_forums( $current_screen ) {

trunk/src/includes/admin/metaboxes.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Metaboxes
+ * bbPress Admin Metaboxes.
+ *
  * @package bbPress
 …
 /**
  * bbPress Dashboard Right Now Widget
+ *
  * Adds a dashboard widget with forum statistics
+ * bbPress Dashboard Right Now Widget.
+ *
+ * Adds a dashboard widget with forum statistics.
+ *
  * @since 2.0.0 bbPress (r2770)
 …
 /**
  * Forum meta-box
+ *
  * The meta-box that holds all of the additional forum information
+ * Forum meta-box.
+ *
+ * The meta-box that holds all of the additional forum information.
+ *
  * @since 2.0.0 bbPress (r2744)
 …
 /**
  * Topic meta-box
+ *
  * The meta-box that holds all of the additional topic information
+ * Topic meta-box.
+ *
+ * The meta-box that holds all of the additional topic information.
+ *
  * @since 2.0.0 bbPress (r2464)
 …
 /**
  * Reply meta-box
+ *
  * The meta-box that holds all of the additional reply information
+ * Reply meta-box.
+ *
+ * The meta-box that holds all of the additional reply information.
+ *
  * @since 2.0.0 bbPress (r2464)
 …
 /**
  * Output the topic replies meta-box
+ * Output the topic replies meta-box.
+ *
  * @since 2.6.0 bbPress (r5886)
 …
 /**
  * Anonymous user information meta-box
+ * Anonymous user information meta-box.
+ *
  * @since 2.0.0 bbPress (r2828)
+ *
  * @param WP_Post $post The current post object
+ * @param WP_Post $post The current post object.
  */
 function bbp_author_metabox( $post ) {
 …
 /**
  * Moderator assignment meta-box
+ * Moderator assignment meta-box.
+ *
  * @since 2.6.0 bbPress (r2828)
 …
 /**
  * See who engaged with a topic
+ * See who engaged with a topic.
+ *
  * @since 2.6.0 bbPress (r6333)
 …
 /**
  * See who marked a topic as a favorite
+ * See who marked a topic as a favorite.
+ *
  * @since 2.6.0 bbPress (r6197)
 …
 /**
  * See who is subscribed to a topic
+ * See who is subscribed to a topic.
+ *
  * @since 2.6.0 bbPress (r6197)
 …
 /**
  * See who is subscribed to a forum
+ * See who is subscribed to a forum.
+ *
  * @since 2.6.0 bbPress (r6197)
 …
 /**
  * Loop through queried metabox users, and output links to their avatars
+ * Loop through queried metabox users, and output links to their avatars.
+ *
  * Developers Note: This function may change in a future release to include

trunk/src/includes/admin/replies.php

-                      r7379
+                      r7380
 /**
  * bbPress Replies Admin Class
+ * bbPress Replies Admin Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Replies_Admin' ) ) :
 /**
  * Loads bbPress replies admin area
+ * Loads bbPress replies admin area.
+ *
  * @package bbPress
 …
     /**
      * @var The post type of this admin component
+     * @var The post type of this admin component.
      */
     private $post_type = '';
 …
     /**
      * The main bbPress admin loader
+     * The main bbPress admin loader.
+     *
      * @since 2.0.0 bbPress (r2515)
 …
     /**
      * Setup the admin hooks, actions and filters
+     * Setup the admin hooks, actions and filters.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Admin globals
+     * Admin globals.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Contextual help for bbPress reply edit page
+     * Contextual help for bbPress reply edit page.
+     *
      * @since 2.0.0 bbPress (r3119)
 …
     /**
      * Contextual help for bbPress reply edit page
+     * Contextual help for bbPress reply edit page.
+     *
      * @since 2.0.0 bbPress (r3119)
 …
     /**
      * Add the reply attributes meta-box
+     * Add the reply attributes meta-box.
+     *
      * @since 2.0.0 bbPress (r2746)
 …
     /**
      * Add the author info meta-box
+     *
      * Allows editing of information about an author
+     * Add the author info meta-box.
+     *
+     * Allows editing of information about an author.
+     *
      * @since 2.0.0 bbPress (r2828)
 …
     /**
      * Remove comments & discussion meta-boxes if comments are not supported
+     * Remove comments & discussion meta-boxes if comments are not supported.
+     *
      * @since 2.6.0 bbPress (r6186)
 …
     /**
      * Pass the reply attributes for processing
+     * Pass the reply attributes for processing.
+     *
      * @since 2.0.0 bbPress (r2746)
+     *
      * @param int $reply_id Reply id
      * @return int Parent id
+     * @param int $reply_id Reply id.
+     * @return int Parent id.
      */
     public function save_meta_boxes( $reply_id ) {
 …
     /**
      * Toggle reply
+     *
      * Handles the admin-side spamming/unspamming of replies
+     * Toggle reply.
+     *
+     * Handles the admin-side spamming/unspamming of replies.
+     *
      * @since 2.0.0 bbPress (r2740)
 …
     /**
      * Toggle reply notices
+     * Toggle reply notices.
+     *
      * Display the success/error notices from
 …
     /**
      * Returns an array of keys used to sort row actions
+     * Returns an array of keys used to sort row actions.
+     *
      * @since 2.6.0 bbPress (r6771)
 …
     /**
      * Returns an array of notice toggles
+     * Returns an array of notice toggles.
+     *
      * @since 2.6.0 bbPress (r6396)
 …
     /**
      * Returns an array of notice toggles
+     * Returns an array of notice toggles.
+     *
      * @since 2.6.0 bbPress (r6396)
 …
     /**
      * Manage the column headers for the replies page
+     * Manage the column headers for the replies page.
+     *
      * @since 2.0.0 bbPress (r2577)
+     *
      * @param array $columns The columns
+     *
      * @return array $columns bbPress reply columns
+     * @param array $columns The columns.
+     *
+     * @return array $columns bbPress reply columns.
      */
     public function column_headers( $columns ) {
 …
     /**
      * Print extra columns for the replies page
+     * Print extra columns for the replies page.
+     *
      * @since 2.0.0 bbPress (r2577)
+     *
      * @param string $column Column
      * @param int $reply_id reply id
+     * @param string $column Column.
+     * @param int $reply_id Reply id.
      */
     public function column_data( $column, $reply_id ) {
 …
     /**
      * Reply Row actions
+     * Reply Row actions.
+     *
      * Remove the quick-edit action link under the reply title and add the
      * content and spam link
+     * content and spam link.
+     *
      * @since 2.0.0 bbPress (r2577)
+     *
      * @param array  $actions Actions
      * @param object $reply   Reply object
+     *
      * @return array $actions Actions
+     * @param array  $actions Actions.
+     * @param object $reply   Reply object.
+     *
+     * @return array $actions Actions.
      */
     public function row_actions( $actions = array(), $reply = false ) {
 …
     /**
      * Sort row actions by key
+     * Sort row actions by key.
+     *
      * @since 2.6.0
 …
     /**
      * Add forum dropdown to topic and reply list table filters
+     * Add forum dropdown to topic and reply list table filters.
+     *
      * @since 2.0.0 bbPress (r2991)
+     *
      * @return bool False. If post type is not topic or reply
+     * @return bool False. If post type is not topic or reply.
      */
     public function filter_dropdown() {
 …
     /**
      * Add "Empty Spam" button for moderators
+     * Add "Empty Spam" button for moderators.
+     *
      * @since 2.6.0 bbPress (r6791)
 …
     /**
      * Adjust the request query and include the forum id
+     * Adjust the request query and include the forum id.
+     *
      * @since 2.0.0 bbPress (r2991)
+     *
      * @param array $query_vars Query variables from {@link WP_Query}
      * @return array Processed Query Vars
+     * @param array $query_vars Query variables from {@link WP_Query}.
+     * @return array Processed Query Vars.
      */
     public function filter_post_rows( $query_vars ) {
 …
     /**
      * Custom user feedback messages for reply post type
+     * Custom user feedback messages for reply post type.
+     *
      * @since 2.0.0 bbPress (r3080)
+     *
      * @global int $post_ID
+     * @global int $post_ID.
+     *
      * @param array $messages
 …
 /**
  * Setup bbPress Replies Admin
+ * Setup bbPress Replies Admin.
+ *
  * This is currently here to make hooking and unhooking of the admin UI easy.
 …
  * @since 2.0.0 bbPress (r2596)
+ *
  * @param WP_Screen $current_screen Current screen object
+ * @param WP_Screen $current_screen Current screen object.
  */
 function bbp_admin_replies( $current_screen ) {

trunk/src/includes/admin/settings.php

-                      r7379
+                      r7380
 /**
  * bbPress Admin Settings
+ * bbPress Admin Settings.
+ *
  * @package bbPress
 …
  * @since 2.1.0 bbPress (r4001)
+ *
  * @param string $section_id ID of the section to get fields for
  * @staticvar array $fields All of the available fields
+ * @param string $section_id ID of the section to get fields for.
+ * @staticvar array $fields All of the available fields.
  * @return mixed False if section is invalid, array of fields otherwise.
  */
 …
 /**
  * User settings section description for the settings page
+ * User settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Edit lock setting field
+ * Edit lock setting field.
+ *
  * @since 2.0.0 bbPress (r2737)
 …
 /**
  * Throttle setting field
+ * Throttle setting field.
+ *
  * @since 2.0.0 bbPress (r2737)
 …
 /**
  * Allow anonymous posting setting field
+ * Allow anonymous posting setting field.
+ *
  * @since 2.0.0 bbPress (r2737)
 …
 /**
  * Allow global access setting field
+ * Allow global access setting field.
+ *
  * @since 2.0.0 bbPress (r3378)
 …
 /**
  * Features settings section description for the settings page
+ * Features settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Allow favorites setting field
+ * Allow favorites setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Allow subscriptions setting field
+ * Allow subscriptions setting field.
+ *
  * @since 2.0.0 bbPress (r2737)
 …
 /**
  * Allow engagements setting field
+ * Allow engagements setting field.
+ *
  * @since 2.0.0 bbPress (r2737)
 …
 /**
  * Allow topic tags setting field
+ * Allow topic tags setting field.
+ *
  * @since 2.4.0 bbPress (r4944)
 …
 /**
  * Allow forum-mods setting field
+ * Allow forum-mods setting field.
+ *
  * @since 2.6.0 bbPress (r5834)
 …
 /**
  * Allow super-mods setting field
+ * Allow super-mods setting field.
+ *
  * @since 2.6.0 bbPress (r6562)
 …
 /**
  * Allow forum wide search
+ * Allow forum wide search.
+ *
  * @since 2.4.0 bbPress (r4970)
 …
 /**
  * Hierarchical reply maximum depth level setting field
+ *
  * Replies will be threaded if depth is 2 or greater
+ * Hierarchical reply maximum depth level setting field.
+ *
+ * Replies will be threaded if depth is 2 or greater.
+ *
  * @since 2.4.0 bbPress (r4944)
 …
 /**
  * Allow topic and reply revisions
+ * Allow topic and reply revisions.
+ *
  * @since 2.0.0 bbPress (r3412)
 …
 /**
  * Use the WordPress editor setting field
+ * Use the WordPress editor setting field.
+ *
  * @since 2.1.0 bbPress (r3586)
 …
 /**
  * Main subtheme section
+ * Main subtheme section.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Use the WordPress editor setting field
+ * Use the WordPress editor setting field.
+ *
  * @since 2.1.0 bbPress (r3586)
 …
 /**
  * Allow oEmbed in replies
+ * Allow oEmbed in replies.
+ *
  * @since 2.1.0 bbPress (r3752)
 …
 /**
  * Per page settings section description for the settings page
+ * Per page settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Topics per page setting field
+ * Topics per page setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Replies per page setting field
+ * Replies per page setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Per page settings section description for the settings page
+ * Per page settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Topics per RSS page setting field
+ * Topics per RSS page setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Replies per RSS page setting field
+ * Replies per RSS page setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Slugs settings section description for the settings page
+ * Slugs settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Root slug setting field
+ * Root slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Include root slug setting field
+ * Include root slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Include root slug setting field
+ * Include root slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Slugs settings section description for the settings page
+ * Slugs settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * User slug setting field
+ * User slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Topic archive slug setting field
+ * Topic archive slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Reply archive slug setting field
+ * Reply archive slug setting field.
+ *
  * @since 2.4.0 bbPress (r4932)
 …
 /**
  * Favorites slug setting field
+ * Favorites slug setting field.
+ *
  * @since 2.4.0 bbPress (r4932)
 …
 /**
  * Subscriptions slug setting field
+ * Subscriptions slug setting field.
+ *
  * @since 2.4.0 bbPress (r4932)
 …
 /**
  * Engagements slug setting field
+ * Engagements slug setting field.
+ *
  * @since 2.6.0 bbPress (r6320)
 …
 /**
  * Slugs settings section description for the settings page
+ * Slugs settings section description for the settings page.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Forum slug setting field
+ * Forum slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Topic slug setting field
+ * Topic slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Reply slug setting field
+ * Reply slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * Topic tag slug setting field
+ * Topic tag slug setting field.
+ *
  * @since 2.0.0 bbPress (r2786)
 …
 /**
  * View slug setting field
+ * View slug setting field.
+ *
  * @since 2.0.0 bbPress (r2789)
 …
 /**
  * Search slug setting field
+ * Search slug setting field.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
 /**
  * Edit slug setting field
+ * Edit slug setting field.
+ *
  * @since 2.6.2 bbPress (r6965)
 …
 /**
  * Extension settings section description for the settings page
+ * Extension settings section description for the settings page.
+ *
  * @since 2.1.0 bbPress (r3575)
 …
 /**
  * Allow BuddyPress group forums setting field
+ * Allow BuddyPress group forums setting field.
+ *
  * @since 2.1.0 bbPress (r3575)
 …
 /**
  * Replies per page setting field
+ * Replies per page setting field.
+ *
  * @since 2.1.0 bbPress (r3575)
 …
 /**
  * Extension settings section description for the settings page
+ * Extension settings section description for the settings page.
+ *
  * @since 2.1.0 bbPress (r3575)
 …
 /**
  * Allow Akismet setting field
+ * Allow Akismet setting field.
+ *
  * @since 2.1.0 bbPress (r3575)
 …
 /**
  * The main settings page
+ * The main settings page.
+ *
  * @since 2.0.0 bbPress (r2643)
 …
 /**
  * Main settings section description for the settings page
+ * Main settings section description for the settings page.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Platform setting field
+ * Edit Platform setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Database Server setting field
+ * Edit Database Server setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Database Server Port setting field
+ * Edit Database Server Port setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Database User setting field
+ * Edit Database User setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Database Pass setting field
+ * Edit Database Pass setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Database Name setting field
+ * Edit Database Name setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Main settings section description for the settings page
+ * Main settings section description for the settings page.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Table Prefix setting field
+ * Edit Table Prefix setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Rows Limit setting field
+ * Edit Rows Limit setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Delay Time setting field
+ * Edit Delay Time setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Halt setting field
+ * Edit Halt setting field.
+ *
  * @since 2.6.0 bbPress (r6599)
 …
 /**
  * Edit Restart setting field
+ * Edit Restart setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Clean setting field
+ * Edit Clean setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * Edit Convert Users setting field
+ * Edit Convert Users setting field.
+ *
  * @since 2.1.0 bbPress (r3813)
 …
 /**
  * The main settings page
+ * The main settings page.
+ *
  * @since 2.1.0 bbPress (r3186)
 …
 /**
  * Contextual help for Forums settings page
+ * Contextual help for Forums settings page.
+ *
  * @since 2.0.0 bbPress (r3119)
 …
 /**
  * Output settings API option
+ * Output settings API option.
+ *
  * @since 2.0.0 bbPress (r3203)
 …
 /**
  * Return settings API option
+ * Return settings API option.
+ *
  * @since 2.0.0 bbPress (r3203)

trunk/src/includes/admin/tools.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Tools Page
+ * bbPress Admin Tools Page.
+ *
  * @package bbPress
 …
 /**
  * Output a bbPress specific tools box
+ * Output a bbPress specific tools box.
+ *
  * @since 2.6.0 bbPress (r6273)
 …
 /**
  * Register an admin area repair tool
+ * Register an admin area repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Register the default repair tools
+ * Register the default repair tools.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Output the tabs in the admin area
+ * Output the tabs in the admin area.
+ *
  * @since 2.1.0 bbPress (r3872)
+ *
  * @param string $active_tab Name of the tab that is active
+ * @param string $active_tab Name of the tab that is active.
  */
 function bbp_tools_admin_tabs( $active_tab = '' ) {
 …
     /**
      * Output the tabs in the admin area
+     * Output the tabs in the admin area.
+     *
      * @since 2.1.0 bbPress (r3872)
+     *
      * @param string $active_tab Name of the tab that is active
+     * @param string $active_tab Name of the tab that is active.
      */
     function bbp_get_tools_admin_tabs( $active_tab = '' ) {
 …
 /**
  * Return possible tools pages
+ * Return possible tools pages.
+ *
  * @since 2.6.0 bbPress (r6273)

trunk/src/includes/admin/tools/common.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Tools Common
+ * bbPress Admin Tools Common.
+ *
  * @package bbPress
 …
 /**
  * Return the current admin repair tool page
+ * Return the current admin repair tool page.
+ *
  * @since 2.6.0 bbPress (r6894)
 …
 /**
  * Return the current admin repair tool page ID
+ * Return the current admin repair tool page ID.
+ *
  * @since 2.6.0 bbPress (r6894)
 …
 /**
  * Return a URL to the repair tool page
+ * Return a URL to the repair tool page.
+ *
  * @since 2.6.0 bbPress (r6894)
 …
 /**
  * Output the URL to run a specific repair tool
+ * Output the URL to run a specific repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Return the URL to run a specific repair tool
+ * Return the URL to run a specific repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Assemble the admin notices
+ * Assemble the admin notices.
+ *
  * @since 2.0.0 bbPress (r2613)
 …
 /**
  * Handle the processing and feedback of the admin tools page
+ * Handle the processing and feedback of the admin tools page.
+ *
  * @since 2.0.0 bbPress (r2613)
 …
 /**
  * Get the array of available repair tools
+ * Get the array of available repair tools.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Return array of components from the array of registered tools
+ * Return array of components from the array of registered tools.
+ *
  * @since 2.5.0 bbPress (r5885)
 …
 /**
  * Output the repair list search form
+ * Output the repair list search form.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Output a select drop-down of components to filter by
+ * Output a select drop-down of components to filter by.
+ *
  * @since 2.5.0 bbPress (r5885)
 …
 /**
  * Return array of versions from the array of registered tools
+ * Return array of versions from the array of registered tools.
+ *
  * @since 2.6.0 bbPress (r6894)
 …
 /**
  * Output a select drop-down of versions to filter by
+ * Output a select drop-down of versions to filter by.
+ *
  * @since 2.5.0 bbPress (r6894)
 …
 /**
  * Maybe translate a repair tool overhead name
+ * Maybe translate a repair tool overhead name.
+ *
  * @since 2.6.0 bbPress (r6177)
 …
 /**
  * Maybe translate a repair tool component name
+ * Maybe translate a repair tool component name.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Maybe translate a repair tool overhead name
+ * Maybe translate a repair tool overhead name.
+ *
  * @since 2.6.0 bbPress (r6894)
 …
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array Repair list of options
+ * @return array Repair list of options.
  */
 function bbp_admin_repair_list( $type = 'repair' ) {
 …
 /**
  * Get filter links for components for a specific admin repair tool
+ * Get filter links for components for a specific admin repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Get filter links for versions for a specific admin repair tool
+ * Get filter links for versions for a specific admin repair tool.
+ *
  * @since 2.6.0 bbPress (r6894)
 …
 /**
  * Get filter links for overhead for a specific admin repair tool
+ * Get filter links for overhead for a specific admin repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Output filter links for overheads for a specific admin repair tool
+ * Output filter links for overheads for a specific admin repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Get filter links for overheads for a specific admin repair tool
+ * Get filter links for overheads for a specific admin repair tool.
+ *
  * @since 2.6.0 bbPress (r5885)
 …
 /**
  * Output filter links for statuses
+ * Output filter links for statuses.
+ *
  * @since 2.6.0 bbPress (r6925)
 …
 /**
  * Get filter links for statuses
+ * Get filter links for statuses.
+ *
  * @since 2.6.0 bbPress (r5885)

trunk/src/includes/admin/tools/converter.php

-                      r7379
+                      r7380
 /**
  * bbPress Converter
+ * bbPress Converter.
+ *
  * Based on the hard work of Adam Ellis
+ * Based on the hard work of Adam Ellis.
+ *
  * @package bbPress
 …
 /**
  * Return an array of available converters
+ * Return an array of available converters.
+ *
  * @since 2.6.0 bbPress (r6447)

trunk/src/includes/admin/tools/help.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Tools Help
+ * bbPress Admin Tools Help.
+ *
  * @package bbPress
 …
 /**
  * Contextual help for Repair Forums tools page
+ * Contextual help for Repair Forums tools page.
+ *
  * @since 2.6.0 bbPress (r5314)
 …
 /**
  * Contextual help for Reset Forums tools page
+ * Contextual help for Reset Forums tools page.
+ *
  * @since 2.6.0 bbPress (r5314)
 …
 /**
  * Contextual help for Import Forums tools page
+ * Contextual help for Import Forums tools page.
+ *
  * @since 2.6.0 bbPress (r5314)

trunk/src/includes/admin/tools/repair.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Repair Page
+ * bbPress Admin Repair Page.
+ *
  * @package bbPress
 …
 /**
  * Admin repair page
+ * Admin repair page.
+ *
  * @since 2.0.0 bbPress (r2613) Converted from bbPress 1.2
 …
+ *
  * @todo Use a real list table
+ *
  */
 function bbp_admin_repair_page() {
 …
 /**
  * Recount topic replies
+ * Recount topic replies.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_topic_reply_count() {
 …
 /**
  * Recount topic voices
+ * Recount topic voices.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_topic_voice_count() {
 …
 /**
  * Recount non-public replies per topic (pending/spammed/trashed)
+ * Recount non-public replies per topic (pending/spammed/trashed).
+ *
  * @since 2.0.0 bbPress (r2747)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_topic_hidden_reply_count() {
 …
 /**
  * Recount forum topics
+ * Recount forum topics.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_forum_topic_count() {
 …
 /**
  * Recount topic in each topic-tag
+ * Recount topic in each topic-tag.
+ *
  * @since 2.6.0 bbPress (r6256)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_topic_tag_count() {
 …
 /**
  * Recount forum replies
+ * Recount forum replies.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_forum_reply_count() {
 …
 /**
  * Recount non-public forum replies
+ * Recount non-public forum replies.
+ *
  * @since 2.6.0 bbPress (r6922)
  * @since 2.6.0 bbPress (r6932) Rename to match the topic reply recount function
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_forum_hidden_reply_count() {
 …
 /**
  * Recount topics by the users
+ * Recount topics by the users.
+ *
  * @since 2.1.0 bbPress (r3889)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_user_topic_count() {
 …
 /**
  * Recount topic replied by the users
+ * Recount topic replied by the users.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_user_reply_count() {
 …
 /**
  * Repair user favorites
+ * Repair user favorites.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_user_favorites() {
 …
 /**
  * Clean the user topic subscriptions
+ * Clean the user topic subscriptions.
+ *
  * @since 2.0.0 bbPress (r2668)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_user_topic_subscriptions() {
 …
 /**
  * Clean the user forum subscriptions
+ * Clean the user forum subscriptions.
+ *
  * @since 2.5.0 bbPress (r5155)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_user_forum_subscriptions() {
 …
 /**
  * Repair the last post in every topic and forum
+ * Repair the last post in every topic and forum.
+ *
  * @since 2.0.0 bbPress (r3040)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_freshness() {
 …
 /**
  * Repair the relationship of sticky topics to the actual parent forum
+ * Repair the relationship of sticky topics to the actual parent forum.
+ *
  * @since 2.3.0 bbPress (r4695)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_sticky() {
 …
 /**
  * Repair closed topics
+ * Repair closed topics.
+ *
  * Closed topics that are missing the post-meta "_bbp_status" key value "publish"
 …
 /**
  * Repair the private and hidden forums
+ * Repair the private and hidden forums.
+ *
  * @since 2.2.0 bbPress (r4104)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_forum_visibility() {
 …
 /**
  * Repair the parent forum meta for each topic and reply
+ * Repair the parent forum meta for each topic and reply.
+ *
  * @since 2.1.0 bbPress (r3876)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_forum_meta() {
 …
 /**
  * Repair the topic for each post
+ * Repair the topic for each post.
+ *
  * @since 2.1.0 bbPress (r3876)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_topic_meta() {
 …
 /**
  * Recalculate reply menu order
+ * Recalculate reply menu order.
+ *
  * @since 2.5.4 bbPress (r5367)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_repair_reply_menu_order() {

trunk/src/includes/admin/tools/reset.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Tools Reset
+ * bbPress Admin Tools Reset.
+ *
  * @package bbPress
 …
 /**
  * Admin reset page
+ * Admin reset page.
+ *
  * @since 2.0.0 bbPress (r2613)
+ *
  */
 function bbp_admin_reset_page() {
 …
  * @since 2.6.0 bbPress (r6758)
+ *
  * @param array $args Array of query, message, and possible responses
+ * @param array $args Array of query, message, and possible responses.
+ *
  * @return string

trunk/src/includes/admin/tools/upgrade.php

-                      r7378
+                      r7380
 /**
  * bbPress Admin Upgrade Functions
+ * bbPress Admin Upgrade Functions.
+ *
  * @package bbPress
 …
 /**
  * Admin repair page
+ * Admin repair page.
+ *
  * @since 2.6.0 bbPress (r6278)
+ *
  */
 function bbp_admin_upgrade_page() {
 …
 /**
  * Upgrade user engagements for bbPress 2.6 and higher
+ * Upgrade user engagements for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_user_engagements() {
 …
 /**
  * Upgrade group forum ID mappings after a bbPress 1.x to bbPress 2.x conversion
+ *
  * Previously named: bbp_admin_repair_group_forum_relationships()
+ * Upgrade group forum ID mappings after a bbPress 1.x to bbPress 2.x conversion.
+ *
+ * Previously named: bbp_admin_repair_group_forum_relationships().
+ *
  * @since 2.6.0 bbPress (r4395)
+ *
  * @return If a wp_error() occurs and no converted forums are found
+ * @return If a wp_error() occurs and no converted forums are found.
  */
 function bbp_admin_upgrade_group_forum_relationships() {
 …
 /**
  * Upgrade user favorites for bbPress 2.6 and higher
+ * Upgrade user favorites for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6174)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_user_favorites() {
 …
 /**
  * Upgrade user topic subscriptions for bbPress 2.6 and higher
+ * Upgrade user topic subscriptions for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6174)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_user_topic_subscriptions() {
 …
 /**
  * Upgrade user forum subscriptions for bbPress 2.6 and higher
+ * Upgrade user forum subscriptions for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6193)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_user_forum_subscriptions() {
 …
 /**
  * Remove favorites data from user meta for bbPress 2.6 and higher
+ * Remove favorites data from user meta for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6281)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_remove_favorites_from_usermeta() {
 …
 /**
  * Remove topic subscriptions data from user meta for bbPress 2.6 and higher
+ * Remove topic subscriptions data from user meta for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6281)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_remove_topic_subscriptions_from_usermeta() {
 …
 /**
  * Remove topic subscriptions data from user meta for bbPress 2.6 and higher
+ * Remove topic subscriptions data from user meta for bbPress 2.6 and higher.
+ *
  * @since 2.6.0 bbPress (r6281)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_admin_upgrade_remove_forum_subscriptions_from_usermeta() {

trunk/src/includes/admin/topics.php

-                      r7379
+                      r7380
 /**
  * bbPress Topics Admin Class
+ * bbPress Topics Admin Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Topics_Admin' ) ) :
 /**
  * Loads bbPress topics admin area
+ * Loads bbPress topics admin area.
+ *
  * @package bbPress
 …
     /**
      * @var The post type of this admin component
+     * @var The post type of this admin component.
      */
     private $post_type = '';
 …
     /**
      * The main bbPress topics admin loader
+     * The main bbPress topics admin loader.
+     *
      * @since 2.0.0 bbPress (r2515)
 …
     /**
      * Setup the admin hooks, actions and filters
+     * Setup the admin hooks, actions and filters.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Admin globals
+     * Admin globals.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Contextual help for bbPress topic edit page
+     * Contextual help for bbPress topic edit page.
+     *
      * @since 2.0.0 bbPress (r3119)
 …
     /**
      * Contextual help for bbPress topic edit page
+     * Contextual help for bbPress topic edit page.
+     *
      * @since 2.0.0 bbPress (r3119)
 …
     /**
      * Add the topic attributes meta-box
+     * Add the topic attributes meta-box.
+     *
      * @since 2.0.0 bbPress (r2744)
 …
     /**
      * Add the author info meta-box
+     * Add the author info meta-box.
+     *
      * @since 2.0.0 bbPress (r2828)
 …
     /**
      * Add the replies meta-box
+     * Add the replies meta-box.
+     *
      * Allows viewing & moderating of replies to a topic, based on the way
 …
     /**
      * Add the engagements meta-box
+     * Add the engagements meta-box.
+     *
      * Allows viewing of users who have engaged in a topic.
 …
     /**
      * Add the favorites meta-box
+     * Add the favorites meta-box.
+     *
      * Allows viewing of users who have favorited a topic.
 …
     /**
      * Add the subscriptions meta-box
+     * Add the subscriptions meta-box.
+     *
      * Allows viewing of users who have subscribed to a topic.
 …
     /**
      * Remove comments & discussion meta-boxes if comments are not supported
+     * Remove comments & discussion meta-boxes if comments are not supported.
+     *
      * @since 2.6.0 bbPress (r6186)
 …
     /**
      * Pass the topic attributes for processing
+     * Pass the topic attributes for processing.
+     *
      * @since 2.0.0 bbPress (r2746)
+     *
      * @param int $topic_id Topic id
      * @return int Parent id
+     * @param int $topic_id Topic id.
+     * @return int Parent id.
      */
     public function save_meta_boxes( $topic_id ) {
 …
     /**
      * Toggle topic
+     * Toggle topic.
+     *
      * Handles the admin-side opening/closing, sticking/unsticking and
      * spamming/unspamming of topics
+     * spamming/unspamming of topics.
+     *
      * @since 2.0.0 bbPress (r2727)
 …
     /**
      * Toggle topic notices
+     * Toggle topic notices.
+     *
      * Display the success/error notices from
 …
     /**
      * Returns an array of keys used to sort row actions
+     * Returns an array of keys used to sort row actions.
+     *
      * @since 2.6.0 bbPress (r6771)
 …
     /**
      * Returns an array of notice toggles
+     * Returns an array of notice toggles.
+     *
      * @since 2.6.0 bbPress (r6396)
 …
     /**
      * Returns an array of notice toggles
+     * Returns an array of notice toggles.
+     *
      * @since 2.6.0 bbPress (r6396)
 …
     /**
      * Manage the column headers for the topics page
+     * Manage the column headers for the topics page.
+     *
      * @since 2.0.0 bbPress (r2485)
+     *
      * @param array $columns The columns
+     *
      * @return array $columns bbPress topic columns
+     * @param array $columns The columns.
+     *
+     * @return array $columns bbPress topic columns.
      */
     public function column_headers( $columns ) {
 …
     /**
      * Print extra columns for the topics page
+     * Print extra columns for the topics page.
+     *
      * @since 2.0.0 bbPress (r2485)
+     *
      * @param string $column Column
      * @param int $topic_id Topic id
+     * @param string $column Column.
+     * @param int $topic_id Topic id.
      */
     public function column_data( $column, $topic_id ) {
 …
     /**
      * Topic Row actions
+     * Topic Row actions.
+     *
      * Remove the quick-edit action link under the topic title and add the
      * content and close/stick/spam links
+     * content and close/stick/spam links.
+     *
      * @since 2.0.0 bbPress (r2485)
+     *
      * @param array  $actions Actions
      * @param object $topic   Topic object
+     *
      * @return array $actions Actions
+     * @param array  $actions Actions.
+     * @param object $topic   Topic object.
+     *
+     * @return array $actions Actions.
      */
     public function row_actions( $actions = array(), $topic = false ) {
 …
     /**
      * Sort row actions by key
+     * Sort row actions by key.
+     *
      * @since 2.6.0
 …
     /**
      * Add forum dropdown to topic and reply list table filters
+     * Add forum dropdown to topic and reply list table filters.
+     *
      * @since 2.0.0 bbPress (r2991)
+     *
      * @return bool False. If post type is not topic or reply
+     * @return bool False. If post type is not topic or reply.
      */
     public function filter_dropdown() {
 …
     /**
      * Add "Empty Spam" button for moderators
+     * Add "Empty Spam" button for moderators.
+     *
      * @since 2.6.0 bbPress (r6791)
 …
     /**
      * Adjust the request query and include the forum id
+     * Adjust the request query and include the forum id.
+     *
      * @since 2.0.0 bbPress (r2991)
+     *
      * @param array $query_vars Query variables from {@link WP_Query}
      * @return array Processed Query Vars
+     * @param array $query_vars Query variables from {@link WP_Query}.
+     * @return array Processed Query Vars.
      */
     public function filter_post_rows( $query_vars ) {
 …
     /**
      * Custom user feedback messages for topic post type
+     * Custom user feedback messages for topic post type.
+     *
      * @since 2.0.0 bbPress (r3080)
 …
 /**
  * Setup bbPress Topics Admin
+ * Setup bbPress Topics Admin.
+ *
  * This is currently here to make hooking and unhooking of the admin UI easy.
 …
  * @since 2.0.0 bbPress (r2596)
+ *
  * @param WP_Screen $current_screen Current screen object
+ * @param WP_Screen $current_screen Current screen object.
  */
 function bbp_admin_topics( $current_screen ) {

trunk/src/includes/admin/users.php

-                      r7378
+                      r7380
 /**
  * bbPress Users Admin Class
+ * bbPress Users Admin Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Users_Admin' ) ) :
 /**
  * Loads bbPress users admin area
+ * Loads bbPress users admin area.
+ *
  * @package bbPress
 …
     /**
      * The bbPress users admin loader
+     * The bbPress users admin loader.
+     *
      * @since 2.0.0 bbPress (r2515)
 …
     /**
      * Setup the admin hooks, actions and filters
+     * Setup the admin hooks, actions and filters.
+     *
      * @since 2.0.0 bbPress (r2646)
 …
     /**
      * Default interface for setting a forum role
+     * Default interface for setting a forum role.
+     *
      * @since 2.2.0 bbPress (r4285)
 …
     /**
      * Add bulk forums role dropdown to the WordPress users table
+     * Add bulk forums role dropdown to the WordPress users table.
+     *
      * @since 2.2.0 bbPress (r4360)
 …
     /**
+     * Process bulk dropdown form submission from the WordPress Users
+     * Table
+     * Process bulk dropdown form submission from the WordPress Users Table.
+     *
      * @since 2.2.0 bbPress (r4365)
+     *
-     * @return bool Always false
      */
     public function user_role_bulk_change() {
 …
     /**
      * Add a "View" link for each user
+     * Add a "View" link for each user.
+     *
      * @since 2.6.0 bbPress (r6502)
 …
      * @param WP_User $user
+     *
      * @return array Actions with 'view' link added to them
+     * @return array Actions with 'view' link added to them.
      */
     public function user_row_actions( $actions = array(), $user = false ) {
 …
     /**
      * Add Forum Role column to the WordPress Users table, and change the
      * core role title to "Site Role"
+     * core role title to "Site Role".
+     *
      * @since 2.2.0 bbPress (r4337)
+     *
      * @param array $columns Users table columns
+     * @param array $columns Users table columns.
      * @return array $columns
      */
 …
     /**
      * Return user's forums role for display in the WordPress Users list table
+     * Return user's forums role for display in the WordPress Users list table.
+     *
      * @since 2.2.0 bbPress (r4337)
 …
      * @param int $user_id
+     *
      * @return string Displayable bbPress user role
+     * @return string Displayable bbPress user role.
      */
     public static function user_role_row( $retval = '', $column_name = '', $user_id = 0 ) {
 …
     /**
      * Filter the list of roles included in the WordPress site role list
+     * Filter the list of roles included in the WordPress site role list.
+     *
      * Ensures forum roles are only displayed under the Forum Role list in the
      * WordPress Users list table
+     * WordPress Users list table.
+     *
      * @since 2.6.0 bbPress (r6051)

trunk/src/includes/common/ajax.php

-                      r7379
+                      r7380
 /**
  * bbPress Common AJAX Functions
+ * bbPress Common AJAX Functions.
+ *
  * Common AJAX functions are ones that are used to setup and/or use during
 …
 /**
  * Output the URL to use for theme-side bbPress AJAX requests
+ * Output the URL to use for theme-side bbPress AJAX requests.
+ *
  * @since 2.3.0 bbPress (r4543)
 …
     echo esc_url( bbp_get_ajax_url() );
+}
+/**
+ * Return the URL to use for theme-side bbPress AJAX requests.
+ *
+ * @since 2.3.0 bbPress (r4543)
+ *
+ * @global WP $wp
+ * @return string
+ */
+function bbp_get_ajax_url() {
+    global $wp;
+    $ssl      = bbp_get_url_scheme();
+    $url      = trailingslashit( $wp->request );
+    $base_url = home_url( $url, $ssl );
+    $ajaxurl  = add_query_arg( array( 'bbp-ajax' => 'true' ), $base_url );
     /**
      * Return the URL to use for theme-side bbPress AJAX requests
+     * Filters the URL used for theme-side bbPress AJAX requests.
+     *
      * @since 2.3.0 bbPress (r4543)
+     *
      * @global WP $wp
      * @return string
+     * @param string $ajaxurl The URL for bbPress AJAX requests.
+     * @return string The filtered URL for bbPress AJAX requests.
      */
+    function bbp_get_ajax_url() {
+        global $wp;
+        $ssl      = bbp_get_url_scheme();
+        $url      = trailingslashit( $wp->request );
+        $base_url = home_url( $url, $ssl );
+        $ajaxurl  = add_query_arg( array( 'bbp-ajax' => 'true' ), $base_url );
+        /**
+         * Filters the URL used for theme-side bbPress AJAX requests.
+         *
+         * @since 2.3.0 bbPress (r4543)
+         *
+         * @param string $ajaxurl The URL for bbPress AJAX requests.
+         * @return string The filtered URL for bbPress AJAX requests.
+         */
+        return apply_filters( 'bbp_get_ajax_url', $ajaxurl );
+    }
+    return apply_filters( 'bbp_get_ajax_url', $ajaxurl );
+}
 /**
 …
  * @since 2.3.0 bbPress (r4543)
+ *
  * @return bool Looking for bbp-ajax
+ * @return bool Looking for bbp-ajax.
  */
 function bbp_is_ajax() {
 …
  * @since 2.3.0 bbPress (r4543)
+ *
  * @param string $action Sanitized action from bbp_post_request/bbp_get_request
+ * @param string $action Sanitized action from bbp_post_request/bbp_get_request.
+ *
  * @return If not a bbPress AJAX request
+ * @return If not a bbPress AJAX request.
  */
 function bbp_do_ajax( $action = '' ) {
 …
 /**
  * Send headers for AJAX specific requests
+ * Send headers for AJAX specific requests.
+ *
  * This was abstracted from bbp_do_ajax() for use in custom theme-side AJAX
 …
 /**
  * Helper method to return JSON response for bbPress AJAX calls
+ * Helper method to return JSON response for bbPress AJAX calls.
+ *
  * @since 2.3.0 bbPress (r4542)

trunk/src/includes/common/classes.php

-                      r7378
+                      r7380
 /**
  * bbPress Classes
+ * bbPress Classes.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Component' ) ) :
 /**
  * bbPress Component Class
+ * bbPress Component Class.
+ *
  * The bbPress component class is responsible for simplifying the creation
 …
     /**
      * @var string Unique name (for internal identification)
+     * @var string Unique name (for internal identification).
      * @internal
      */
 …
     /**
      * @var Unique ID (normally for custom post type)
+     * @var Unique ID (normally for custom post type).
      */
     public $id;
     /**
      * @var string Unique slug (used in query string and permalinks)
+     * @var string Unique slug (used in query string and permalinks).
      */
     public $slug;
     /**
      * @var WP_Query The loop for this component
+     * @var WP_Query The loop for this component.
      */
     public $query;
     /**
      * @var string The current ID of the queried object
+     * @var string The current ID of the queried object.
      */
     public $current_id;
 …
     /**
      * bbPress Component loader
+     * bbPress Component loader.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Component global variables
+     * Component global variables.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Include required files
+     * Include required files.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Setup the actions
+     * Setup the actions.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Setup the component post types
+     * Setup the component post types.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Register component specific taxonomies
+     * Register component specific taxonomies.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Add any additional rewrite tags
+     * Add any additional rewrite tags.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Generate any additional rewrite rules
+     * Generate any additional rewrite rules.
+     *
      * @since 2.0.0 bbPress (r2700)
 …
     /**
      * Set the tree_type
+     * Set the tree_type.
+     *
      * @since 2.0.0 bbPress (r2746)
 …
     /**
      * Confirm the tree_type
+     * Confirm the tree_type.
+     *
      * @since 2.6.0 bbPress (r5389)
 …
      * @since 2.4.0 bbPress (r4944)
+     *
      * @param string $output Passed by reference. Used to append additional content
      * @param int $depth Depth of reply
      * @param array $args Uses 'style' argument for type of HTML list
+     * @param string $output Passed by reference. Used to append additional content.
+     * @param int $depth Depth of reply.
+     * @param array $args Uses 'style' argument for type of HTML list.
      */
     public function start_lvl( &$output = '', $depth = 0, $args = array() ) {
 …
      * @since 2.4.0 bbPress (r4944)
+     *
      * @param string $output Passed by reference. Used to append additional content
      * @param int $depth Depth of reply
      * @param array $args Will only append content if style argument value is 'ol' or 'ul'
+     * @param string $output Passed by reference. Used to append additional content.
+     * @param int $depth Depth of reply.
+     * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
      */
     public function end_lvl( &$output = '', $depth = 0, $args = array() ) {
 …
     /**
      * Confirm the tree_type
+     * Confirm the tree_type.
+     *
      * @since 2.6.0 bbPress (r5389)
 …
      *                       selected HTML attribute for option element.
+     *
      * @param int    $current_object_id Not Used
+     * @param int    $current_object_id Not Used.
      */
     public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {

trunk/src/includes/common/engagements.php

-                      r7379
+                      r7380
 /**
  * bbPress Common Engagements
+ * bbPress Common Engagements.
+ *
  * This file contains the common classes and functions for interacting with the
 …
 /**
  * Return the strategy used for storing user engagements
+ * Return the strategy used for storing user engagements.
+ *
  * @since 2.6.0 bbPress (r6722)
+ *
  * @param string $rel_key  The key used to index this relationship
  * @param string $rel_type The type of meta to look in
+ * @param string $rel_key  The key used to index this relationship.
+ * @param string $rel_type The type of meta to look in.
+ *
  * @return string
 …
     /**
      * Add a user id to an object
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
      * @param bool   $unique    Whether meta key should be unique to the object
+     *
      * @return bool Returns true on success, false on failure
+     * Add a user id to an object.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     * @param bool   $unique    Whether meta key should be unique to the object.
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post', $unique = false ) {
 …
     /**
      * Remove a user id from an object
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove a user id from an object.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove a user id from all objects
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove a user id from all objects.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_all_objects( $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove an object from all users
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove an object from all users.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_object_from_all_users( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove all users from all objects
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove all users from all objects.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_all_users_from_all_objects( $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Get users of an object
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param string $meta_key  The key used to index this relationship
      * @param string $meta_type The type of meta to look in
+     *
      * @return array Returns ids of users
+     * Get users of an object.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param string $meta_key  The key used to index this relationship.
+     * @param string $meta_type The type of meta to look in.
+     *
+     * @return array Returns ids of users.
      */
     public function get_users_for_object( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
 /**
  * Meta strategy for interfacing with User Engagements
+ * Meta strategy for interfacing with User Engagements.
+ *
  * @since 2.6.0 bbPress (r6722)
 …
     /**
      * Add a user id to an object
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
      * @param bool   $unique    Whether meta key should be unique to the object
+     *
      * @return bool Returns true on success, false on failure
+     * Add a user id to an object.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     * @param bool   $unique    Whether meta key should be unique to the object.
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post', $unique = false ) {
 …
     /**
      * Remove a user id from an object
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     * Remove a user id from an object.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
      * @return bool Returns true on success, false on failure
 …
     /**
      * Remove a user id from all objects
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove a user id from all objects.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_all_objects( $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove an object from all users
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove an object from all users.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_object_from_all_users( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove all users from all objects
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove all users from all objects.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_all_users_from_all_objects( $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Get users of an object
+     *
      * @since 2.6.0 bbPress (r6722)
+     *
      * @param int    $object_id The object id
      * @param string $meta_key  The key used to index this relationship
      * @param string $meta_type The type of meta to look in
+     *
      * @return array Returns ids of users
+     * Get users of an object.
+     *
+     * @since 2.6.0 bbPress (r6722)
+     *
+     * @param int    $object_id The object id.
+     * @param string $meta_key  The key used to index this relationship.
+     * @param string $meta_type The type of meta to look in.
+     *
+     * @return array Returns ids of users.
      */
     public function get_users_for_object( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
 /**
  * Term strategy for interfacing with User Engagements
+ * Term strategy for interfacing with User Engagements.
+ *
  * @since 2.6.0 bbPress (r6737)
 …
     /**
      * Register an engagement taxonomy just-in-time for immediate use
+     * Register an engagement taxonomy just-in-time for immediate use.
+     *
      * @since 2.6.0 bbPress (r6737)
 …
     /**
      * Add a user id to an object
+     *
      * @since 2.6.0 bbPress (r6737)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
      * @param bool   $unique    Whether meta key should be unique to the object
+     *
      * @return bool Returns true on success, false on failure
+     * Add a user id to an object.
+     *
+     * @since 2.6.0 bbPress (r6737)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     * @param bool   $unique    Whether meta key should be unique to the object.
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post', $unique = false ) {
 …
     /**
      * Remove a user id from an object
+     *
      * @since 2.6.0 bbPress (r6737)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove a user id from an object.
+     *
+     * @since 2.6.0 bbPress (r6737)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove a user id from all objects
+     *
      * @since 2.6.0 bbPress (r6737)
+     *
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove a user id from all objects.
+     *
+     * @since 2.6.0 bbPress (r6737)
+     *
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_all_objects( $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove an object from all users
+     *
      * @since 2.6.0 bbPress (r6737)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove an object from all users.
+     *
+     * @since 2.6.0 bbPress (r6737)
+     *
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_object_from_all_users( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove all users from all objects
+     *
      * @since 2.6.0 bbPress (r6737)
+     *
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * Remove all users from all objects.
+     *
+     * @since 2.6.0 bbPress (r6737)
+     *
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_all_users_from_all_objects( $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Get users of an object
+     *
      * @since 2.6.0 bbPress (r6737)
+     *
      * @param int    $object_id The object id
      * @param string $meta_key  The key used to index this relationship
      * @param string $meta_type The type of meta to look in
+     *
      * @return array Returns ids of users
+     * Get users of an object.
+     *
+     * @since 2.6.0 bbPress (r6737)
+     *
+     * @param int    $object_id The object id.
+     * @param string $meta_key  The key used to index this relationship.
+     * @param string $meta_type The type of meta to look in.
+     *
+     * @return array Returns ids of users.
      */
     public function get_users_for_object( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
 /**
  * User strategy for interfacing with User Engagements
+ * User strategy for interfacing with User Engagements.
+ *
  * This strategy largely exists for backwards compatibility with bbPress 2.5,
 …
      * @param int    $object_id
+     *
      * @return mixed Results from cache get
+     * @return mixed Results from cache get.
      */
     private function cache_get( $meta_key = '', $object_id = 0 ) {
 …
      * @param int    $object_id
+     *
      * @return mixed Results from cache set
+     * @return mixed Results from cache set.
      */
     private function cache_set( $meta_key = '', $object_id = 0, $user_ids = array() ) {
 …
      * @param int    $object_id
+     *
      * @return mixed Results from cache delete
+     * @return mixed Results from cache delete.
      */
     private function cache_delete( $meta_key = '', $object_id = 0 ) {
 …
     /**
      * Add a user id to an object
+     * Add a user id to an object.
+     *
      * @since 2.6.0 bbPress (r6844)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
      * @param bool   $unique    Whether meta key should be unique to the object
+     *
      * @return bool Returns true on success, false on failure
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     * @param bool   $unique    Whether meta key should be unique to the object.
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post', $unique = false ) {
 …
     /**
      * Remove a user id from an object
+     * Remove a user id from an object.
+     *
      * @since 2.6.0 bbPress (r6844)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove a user id from all objects
+     * Remove a user id from all objects.
+     *
      * @since 2.6.0 bbPress (r6844)
+     *
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_user_from_all_objects( $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove an object from all users
+     * Remove an object from all users.
+     *
      * @since 2.6.0 bbPress (r6844)
+     *
      * @param int    $object_id The object id
      * @param int    $user_id   The user id
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * @param int    $object_id The object id.
+     * @param int    $user_id   The user id.
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_object_from_all_users( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Remove all users from all objects
+     * Remove all users from all objects.
+     *
      * @since 2.6.0 bbPress (r6844)
+     *
      * @param string $meta_key  The relationship key
      * @param string $meta_type The relationship type (usually 'post')
+     *
      * @return bool Returns true on success, false on failure
+     * @param string $meta_key  The relationship key.
+     * @param string $meta_type The relationship type (usually 'post').
+     *
+     * @return bool Returns true on success, false on failure.
      */
     public function remove_all_users_from_all_objects( $meta_key = '', $meta_type = 'post' ) {
 …
     /**
      * Get users of an object
+     * Get users of an object.
+     *
      * The database queries in this function were cached in bbPress versions
 …
      * @since 2.6.0 bbPress (r6844)
+     *
      * @param int    $object_id The object id
      * @param string $meta_key  The key used to index this relationship
      * @param string $meta_type The type of meta to look in
+     *
      * @return array Returns ids of users
+     * @param int    $object_id The object id.
+     * @param string $meta_key  The key used to index this relationship.
+     * @param string $meta_type The type of meta to look in.
+     *
+     * @return array Returns ids of users.
      */
     public function get_users_for_object( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {

trunk/src/includes/common/formatting.php

-                      r7379
+                      r7380
 /**
  * bbPress Formatting
+ * bbPress Formatting.
+ *
  * @package bbPress
 …
 /**
  * Custom allowed tags for forum topics and replies
+ *
  * Allows all users to post links, quotes, code, formatting, lists, and images
+ * Custom allowed tags for forum topics and replies.
+ *
+ * Allows all users to post links, quotes, code, formatting, lists, and images.
+ *
  * @since 2.3.0 bbPress (r4603)
+ *
  * @return array Associative array of allowed tags and attributes
+ * @return array Associative array of allowed tags and attributes.
  */
 function bbp_kses_allowed_tags() {
 …
 /**
  * Custom kses filter for forum topics and replies, for filtering incoming data
+ * Custom kses filter for forum topics and replies, for filtering incoming data.
+ *
  * @since 2.3.0 bbPress (r4603)
+ *
  * @param string $data Content to filter, expected to be escaped with slashes
  * @return string Filtered content
+ * @param string $data Content to filter, expected to be escaped with slashes.
+ * @return string Filtered content.
  */
 function bbp_filter_kses( $data = '' ) {
 …
 /**
  * Custom kses filter for forum topics and replies, for raw data
+ * Custom kses filter for forum topics and replies, for raw data.
+ *
  * @since 2.3.0 bbPress (r4603)
+ *
  * @param string $data Content to filter, expected to not be escaped
  * @return string Filtered content
+ * @param string $data Content to filter, expected to not be escaped.
+ * @return string Filtered content.
  */
 function bbp_kses_data( $data = '' ) {
 …
 /**
  * Filter the topic or reply content and output code and pre tags
+ * Filter the topic or reply content and output code and pre tags.
+ *
  * @since 2.3.0 bbPress (r4641)
+ *
  * @param string $content Topic and reply content
  * @return string Partially encoded content
+ * @param string $content Topic and reply content.
+ * @return string Partially encoded content.
  */
 function bbp_code_trick( $content = '' ) {
 …
  * @since 2.3.0 bbPress (r4641)
+ *
  * @param string $content Topic and reply content
  * @return string Partially encoded content
+ * @param string $content Topic and reply content.
+ * @return string Partially encoded content.
  */
 function bbp_code_trick_reverse( $content = '' ) {
 …
 /**
  * Filter the content and encode any bad HTML tags
+ * Filter the content and encode any bad HTML tags.
+ *
  * @since 2.3.0 bbPress (r4641)
+ *
  * @param string $content Topic and reply content
  * @return string Partially encoded content
+ * @param string $content Topic and reply content.
+ * @return string Partially encoded content.
  */
 function bbp_encode_bad( $content = '' ) {
 …
 /**
  * Callback to encode the tags in topic or reply content
+ * Callback to encode the tags in topic or reply content.
+ *
  * @since 2.3.0 bbPress (r4641)
 …
 /**
  * Callback to decode the tags in topic or reply content
+ * Callback to decode the tags in topic or reply content.
+ *
  * @since 2.3.0 bbPress (r4641)
 …
 /**
  * Callback to replace empty HTML tags in a content string
+ * Callback to replace empty HTML tags in a content string.
+ *
  * @since 2.3.0 bbPress (r4641)
 …
 /**
  * Callback to replace normal HTML tags in a content string
+ * Callback to replace normal HTML tags in a content string.
+ *
  * @since 2.3.0 bbPress (r4641)
 …
 /**
  * Catches links so rel=nofollow can be added (on output, not save)
+ * Catches links so rel=nofollow can be added (on output, not save).
+ *
  * @since 2.3.0 bbPress (r4865)
+ *
  * @param string $text Post text
  * @return string $text Text with rel=nofollow added to any links
+ * @param string $text Post text.
+ * @return string $text Text with rel=nofollow added to any links.
  */
 function bbp_rel_nofollow( $text = '' ) {
 …
 /**
  * Adds rel=nofollow to a link
+ * Adds rel=nofollow to a link.
+ *
  * @since 2.3.0 bbPress (r4865)
+ *
  * @param array $matches
  * @return string $text Link with rel=nofollow added
+ * @return string $text Link with rel=nofollow added.
  */
 function bbp_rel_nofollow_callback( $matches = array() ) {
 …
 /**
  * Make URLs clickable in content areas
+ * Make URLs clickable in content areas.
+ *
  * @since 2.6.0 bbPress (r6014)
 …
 /**
  * Make FTP clickable in content areas
+ * Make FTP clickable in content areas.
+ *
  * @since 2.6.0 bbPress (r6014)
 …
 /**
  * Make emails clickable in content areas
+ * Make emails clickable in content areas.
+ *
  * @since 2.6.0 bbPress (r6014)
 …
 /**
  * Make mentions clickable in content areas
+ *
  * Allows ' ', '>', '[', and '(' before as '@' username mention
+ * Make mentions clickable in content areas.
+ *
+ * Allows ' ', '>', '[', and '(' before as '@' username mention.
+ *
  * @since 2.6.0 bbPress (r6014)
 …
 /**
  * A bbPress specific method of formatting numeric values
+ * A bbPress specific method of formatting numeric values.
+ *
  * @since 2.0.0 bbPress (r2486)
+ *
  * @param string $number Number to format
  * @param string $decimals Optional. Display decimals
+ *
  * @return string Formatted string
+ * @param string $number Number to format.
+ * @param string $decimals Optional. Display decimals.
+ *
+ * @return string Formatted string.
  */
 function bbp_number_format( $number = 0, $decimals = false, $dec_point = '.', $thousands_sep = ',' ) {
 …
 /**
  * A bbPress specific method of formatting numeric values
+ * A bbPress specific method of formatting numeric values.
+ *
  * @since 2.1.0 bbPress (r3857)
+ *
  * @param string $number Number to format
  * @param string $decimals Optional. Display decimals
+ *
  * @return string Formatted string
+ * @param string $number Number to format.
+ * @param string $decimals Optional. Display decimals.
+ *
+ * @return string Formatted string.
  */
 function bbp_number_format_i18n( $number = 0, $decimals = false ) {
 …
  * @param bool $translate Optional. Default is false. Whether to translate the
+ *
  * @return string Returns timestamp
+ * @return string Returns timestamp.
  */
 function bbp_convert_date( $time, $d = 'U', $translate = false ) {
 …
                 // Finding the biggest chunk (if the chunk fits, break)
                 $count = floor( $since / $seconds );
                 if ( 0 !== $count ) {
+                if ( ! empty( $count ) ) {
                     break;
+                }
 …
                     // Add to output var
                     if ( 0 !== $count2 ) {
+                    if ( ! empty( $count2 ) ) {
                         $output .= _x( ',', 'Separator in time since', 'bbpress' ) . ' ';
                         $output .= sprintf( translate_nooped_plural( $chunks[ $i + 1 ][1], $count2, 'bbpress' ), bbp_number_format_i18n( $count2 ) );
 …
  * @since 2.6.14
+ *
  * @param string $display_name The author display
+ * @param string $display_name The author display.
  * @return string
  */

trunk/src/includes/common/functions.php

-                      r7379
+                      r7380
 /**
  * bbPress Common Functions
+ * bbPress Common Functions.
+ *
  * Common functions are ones that are used by more than one component, like
 …
 /**
  * Return array of bbPress registered post types
+ * Return array of bbPress registered post types.
+ *
  * @since 2.6.0 bbPress (r6813)
+ *
  * @param array $args Array of arguments to pass into `get_post_types()`
+ * @param array $args Array of arguments to pass into `get_post_types()`.
+ *
  * @return array
 …
 /**
  * Return the unescaped redirect_to request value
+ * Return the unescaped redirect_to request value.
+ *
  * @bbPress (r4655)
+ *
  * @return string The URL to redirect to, if set
+ * @return string The URL to redirect to, if set.
  */
 function bbp_get_redirect_to() {
 …
  * @since 2.0.0 bbPress (r3325)
+ *
  * @param string $original_link Original Link to be modified
  * @param bool $force Override bbp_get_view_all() check
  * @return string The link with 'view=all' appended if necessary
+ * @param string $original_link Original Link to be modified.
+ * @param bool $force Override bbp_get_view_all() check.
+ * @return string The link with 'view=all' appended if necessary.
  */
 function bbp_add_view_all( $original_link = '', $force = false ) {
 …
 /**
  * Remove 'view=all' from query string
+ * Remove 'view=all' from query string.
+ *
  * @since 2.0.0 bbPress (r3325)
+ *
  * @param string $original_link Original Link to be modified
  * @return string The link with 'view=all' appended if necessary
+ * @param string $original_link Original Link to be modified.
+ * @return string The link with 'view=all' appended if necessary.
  */
 function bbp_remove_view_all( $original_link = '' ) {
 …
 /**
  * If current user can and is viewing all topics/replies
+ * If current user can and is viewing all topics/replies.
+ *
  * @since 2.0.0 bbPress (r3325)
+ *
+ * @param string $cap Capability used to ensure user can view all
+ *
+ * @return bool Whether current user can and is viewing all
+ * @param string $cap Capability used to ensure user can view all.
+ * @return bool Whether current user can and is viewing all.
  */
 function bbp_get_view_all( $cap = 'moderate' ) {
 …
 /**
  * Assist pagination by returning correct page number
+ * Assist pagination by returning correct page number.
+ *
  * @since 2.0.0 bbPress (r2628)
+ *
  * @return int Current page number
+ * @return int Current page number.
  */
 function bbp_get_paged() {
 …
  * @since 2.6.0 bbPress (r6481)
+ *
  * @param array $arr Array to get values of
+ * @param array $arr Array to get values of.
+ *
  * @return array
 …
 /**
  * Fix post author id on post save
+ * Fix post author id on post save.
+ *
  * When a logged in user changes the status of an anonymous reply or topic, or
 …
  * @since 2.0.0 bbPress (r2734)
+ *
  * @param array $data Post data
  * @param array $postarr Original post array (includes post id)
  * @return array Data
+ * @param array $data Post data.
+ * @param array $postarr Original post array (includes post id).
+ * @return array Data.
  */
 function bbp_fix_post_author( $data = array(), $postarr = array() ) {
 …
  * @since 2.6.10 bbPress (r7233)
+ *
  * @param string $new_status      New status to use when untrashing. Default: 'draft'
  * @param int    $post_id         Post ID
  * @param string $previous_status Previous post status from '_wp_trash_meta_status' meta key. Default: 'pending'
+ * @param string $new_status      New status to use when untrashing. Default: 'draft'.
+ * @param int    $post_id         Post ID.
+ * @param string $previous_status Previous post status from '_wp_trash_meta_status' meta key. Default: 'pending'.
  */
 function bbp_fix_untrash_post_status( $new_status = 'draft', $post_id = 0, $previous_status = 'pending' ) {
 …
  * @since 2.6.0 bbPress (r6868) Inverted some logic and added unit tests
+ *
  * @param string  $datetime Gets run through strtotime()
+ * @param string  $datetime Gets run through strtotime().
  * @param boolean $utc      Default true. Is the timestamp in UTC?
+ *
 …
  * @since 2.6.0 bbPress (r6424)
+ *
  * @param string $context Provide context for additional filtering
  * @return int Number of days items remain in trash
+ * @param string $context Provide context for additional filtering.
+ * @return int Number of days items remain in trash.
  */
 function bbp_get_trash_days( $context = 'forum' ) {
 …
 /**
  * Get the forum statistics
+ * Get the forum statistics.
+ *
  * @since 2.0.0 bbPress (r2769)
 …
 /**
  * Filter anonymous post data
+ * Filter anonymous post data.
+ *
  * We use REMOTE_ADDR here directly. If you are behind a proxy, you should
 …
  * @since 2.0.0 bbPress (r2734)
+ *
  * @param array $args Optional. If no args are there, then $_POST values are
  * @return bool|array False on errors, values in an array on success
+ * @param array $args Optional. If no args are there, then $_POST values are.
+ * @return bool|array False on errors, values in an array on success.
  */
 function bbp_filter_anonymous_post_data( $args = array() ) {
 …
 /**
  * Sanitize an array of anonymous post author data
+ * Sanitize an array of anonymous post author data.
+ *
  * @since 2.6.0 bbPress (r6400)
 …
 /**
  * Update the relevant meta-data for an anonymous post author
+ * Update the relevant meta-data for an anonymous post author.
+ *
  * @since 2.6.0 bbPress (r6400)
 …
 /**
  * Check for duplicate topics/replies
+ *
  * Check to make sure that a user is not making a duplicate post
+ * Check for duplicate topics/replies.
+ *
+ * Check to make sure that a user is not making a duplicate post.
+ *
  * @since 2.0.0 bbPress (r2763)
+ *
  * @param array $post_data Contains information about the comment
  * @return bool True if it is not a duplicate, false if it is
+ * @param array $post_data Contains information about the comment.
+ * @return bool True if it is not a duplicate, false if it is.
  */
 function bbp_check_for_duplicate( $post_data = array() ) {
 …
 /**
  * Check for flooding
+ * Check for flooding.
+ *
  * Check to make sure that a user is not making too many posts in a short amount
 …
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
+ *                              sanitized (see {@link bbp_filter_anonymous_post_data()}.
  * @param int $author_id Optional. Supply if it's a post by a logged in user.
  *                        Do not supply if supplying $anonymous_data.
  * @return bool True if there is no flooding, false if there is
+ * @return bool True if there is no flooding, false if there is.
  */
 function bbp_check_for_flood( $anonymous_data = array(), $author_id = 0 ) {
 …
 /**
  * Checks topics and replies against the discussion moderation of blocked keys
+ * Checks topics and replies against the discussion moderation of blocked keys.
+ *
  * @since 2.1.0 bbPress (r3581)
 …
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
  * @param int $author_id Topic or reply author ID
  * @param string $title The title of the content
  * @param string $content The content being posted
+ * @param int $author_id Topic or reply author ID.
+ * @param string $title The title of the content.
+ * @param string $content The content being posted.
  * @param mixed  $strict  False for moderation_keys. True for disallowed_keys.
  *                        String for custom keys.
  * @return bool True if test is passed, false if fail
+ * @return bool True if test is passed, false if fail.
  */
 function bbp_check_for_moderation( $anonymous_data = array(), $author_id = 0, $title = '', $content = '', $strict = false ) {
 …
 /**
  * Sends notification emails for new replies to subscribed topics
+ * Sends notification emails for new replies to subscribed topics.
+ *
  * Gets new post ID and check if there are subscribed users to that topic, and
  * if there are, send notifications
+ * if there are, send notifications.
+ *
  * Note: in bbPress 2.6, we've moved away from 1 email per subscriber to 1 email
 …
  * @since 2.6.0 bbPress (r5413)
+ *
  * @param int $reply_id ID of the newly made reply
  * @param int $topic_id ID of the topic of the reply
  * @param int $forum_id ID of the forum of the reply
+ * @param int $reply_id ID of the newly made reply.
+ * @param int $topic_id ID of the topic of the reply.
+ * @param int $forum_id ID of the forum of the reply.
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
  * @param int $reply_author ID of the topic author ID
  * @return bool True on success, false on failure
+ *                              sanitized (see {@link bbp_filter_anonymous_post_data()}.
+ * @param int $reply_author ID of the topic author ID.
+ * @return bool True on success, false on failure.
  */
 function bbp_notify_topic_subscribers( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $reply_author = 0 ) {
 …
 /**
  * Sends notification emails for new topics to subscribed forums
+ * Sends notification emails for new topics to subscribed forums.
+ *
  * Gets new post ID and check if there are subscribed users to that forum, and
  * if there are, send notifications
+ * if there are, send notifications.
+ *
  * Note: in bbPress 2.6, we've moved away from 1 email per subscriber to 1 email
 …
  * @since 2.5.0 bbPress (r5156)
+ *
  * @param int $topic_id ID of the newly made reply
  * @param int $forum_id ID of the forum for the topic
+ * @param int $topic_id ID of the newly made reply.
+ * @param int $forum_id ID of the forum for the topic.
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
  * @param int $topic_author ID of the topic author ID
  * @return bool True on success, false on failure
+ * @param int $topic_author ID of the topic author ID.
+ * @return bool True on success, false on failure.
  */
 function bbp_notify_forum_subscribers( $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $topic_author = 0 ) {
 …
 /**
  * Sends notification emails for new replies to subscribed topics
+ *
  * This function is deprecated. Please use: bbp_notify_topic_subscribers()
+ * Sends notification emails for new replies to subscribed topics.
+ *
+ * This function is deprecated. Please use: bbp_notify_topic_subscribers().
+ *
  * @since 2.0.0 bbPress (r2668)
 …
  * @deprecated 2.6.0 bbPress (r5412)
+ *
  * @param int $reply_id ID of the newly made reply
  * @param int $topic_id ID of the topic of the reply
  * @param int $forum_id ID of the forum of the reply
+ * @param int $reply_id ID of the newly made reply.
+ * @param int $topic_id ID of the topic of the reply.
+ * @param int $forum_id ID of the forum of the reply.
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
  * @param int $reply_author ID of the topic author ID
+ *
  * @return bool True on success, false on failure
+ *                              sanitized (see {@link bbp_filter_anonymous_post_data()}.
+ * @param int $reply_author ID of the topic author ID.
+ *
+ * @return bool True on success, false on failure.
  */
 function bbp_notify_subscribers( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $reply_author = 0 ) {
 …
 /**
  * Return an array of user email addresses from an array of user IDs
+ * Return an array of user email addresses from an array of user IDs.
+ *
  * @since 2.6.0 bbPress (r6722)
 …
 /**
  * Return a clean and reliable logout URL
+ * Return a clean and reliable logout URL.
+ *
  * This function is used to filter `logout_url`. If no $redirect_to value is
 …
  * @since 2.1.0 bbPress (2815)
+ *
  * @param string $url URL used to log out
+ * @param string $url URL used to log out.
  * @param string $redirect_to Where to redirect to?
+ *
  * @return string The url
+ * @return string The url.
  */
 function bbp_logout_url( $url = '', $redirect_to = '' ) {
 …
  * @since 2.1.0 bbPress (r3839)
+ *
  * @param string|array $args Value to merge with $defaults
+ * @param string|array $args Value to merge with $defaults.
  * @param array $defaults Array that serves as the defaults.
  * @param string $filter_key String to key the filters from
+ * @param string $filter_key String to key the filters from.
  * @return array Merged user defined values with defaults.
  */
 …
 /**
  * Adds ability to include or exclude specific post_parent ID's
+ * Adds ability to include or exclude specific post_parent ID's.
+ *
  * @since 2.0.0 bbPress (r2996)
 …
 /**
  * Query the DB and get the last public post_id that has parent_id as post_parent
+ * Query the DB and get the last public post_id that has parent_id as post_parent.
+ *
  * @since 2.0.0 bbPress (r2868)
 …
  * @param int    $parent_id Parent id.
  * @param string $post_type Post type. Defaults to 'post'.
  * @return int The last active post_id
+ * @return int The last active post_id.
  */
 function bbp_get_public_child_last_id( $parent_id = 0, $post_type = 'post' ) {
 …
 /**
  * Query the database for child counts, grouped by type & status
+ * Query the database for child counts, grouped by type & status.
+ *
  * @since 2.6.0 bbPress (r6826)
 …
 /**
  * Filter a list of child counts, from `bbp_get_child_counts()`
+ * Filter a list of child counts, from `bbp_get_child_counts()`.
+ *
  * @since 2.6.0 bbPress (r6826)
+ *
  * @param int    $parent_id  ID of post to get child counts from
  * @param array  $types      Optional. An array of post types to filter by
  * @param array  $statuses   Optional. An array of post statuses to filter by
+ * @param int    $parent_id  ID of post to get child counts from.
+ * @param array  $types      Optional. An array of post types to filter by.
+ * @param array  $statuses   Optional. An array of post statuses to filter by.
+ *
  * @return array A list of objects or object fields.
 …
 /**
  * Query the DB and get a count of public children
+ * Query the DB and get a count of public children.
+ *
  * @since 2.0.0 bbPress (r2868)
 …
  * @param int    $parent_id Parent id.
  * @param string $post_type Post type. Defaults to 'post'.
  * @return int The number of children
+ * @return int The number of children.
  */
 function bbp_get_public_child_count( $parent_id = 0, $post_type = 'post' ) {
 …
+}
 /**
  * Query the DB and get a count of public children
+ * Query the DB and get a count of public children.
+ *
  * @since 2.0.0 bbPress (r2868)
  * @since 2.6.0 bbPress (r5954) Replace direct queries with WP_Query() objects
+ * @since 2.6.0 bbPress (r5954) Replace direct queries with WP_Query() objects.
+ *
  * @param int    $parent_id Parent id.
  * @param string $post_type Post type. Defaults to 'post'.
  * @return int The number of children
+ * @return int The number of children.
  */
 function bbp_get_non_public_child_count( $parent_id = 0, $post_type = 'post' ) {
 …
 /**
  * Query the DB and get the child id's of public children
+ * Query the DB and get the child id's of public children.
+ *
  * @since 2.0.0 bbPress (r2868)
 …
  * @param string $post_type Post type. Defaults to 'post'.
+ *
  * @return array The array of children
+ * @return array The array of children.
  */
 function bbp_get_public_child_ids( $parent_id = 0, $post_type = 'post' ) {
 …
 /**
  * Query the DB and get the child id's of all children
+ * Query the DB and get the child id's of all children.
+ *
  * @since 2.0.0 bbPress (r3325)
+ *
  * @param int $parent_id  Parent id
  * @param string $post_type Post type. Defaults to 'post'
+ *
  * @return array The array of children
+ * @param int $parent_id  Parent id.
+ * @param string $post_type Post type. Defaults to 'post'.
+ *
+ * @return array The array of children.
  */
 function bbp_get_all_child_ids( $parent_id = 0, $post_type = 'post' ) {
 …
  * @since 2.6.0 bbPress (r6699)
+ *
  * @param array $objects Array of objects, fresh from a query
+ *
  * @return bool True if some IDs were cached
+ * @param array $objects Array of objects, fresh from a query.
+ *
+ * @return bool True if some IDs were cached.
  */
 function bbp_update_post_family_caches( $objects = array() ) {
 …
  * @since 2.6.0 bbPress (r6699)
+ *
  * @param array $objects Array of objects, fresh from a query
+ *
  * @return bool True if some IDs were cached
+ * @param array $objects Array of objects, fresh from a query.
+ *
+ * @return bool True if some IDs were cached.
  */
 function bbp_update_post_author_caches( $objects = array() ) {
 …
 /**
  * Get the unfiltered value of a global $post's key
+ *
  * Used most frequently when editing a forum/topic/reply
+ * Get the unfiltered value of a global $post's key.
+ *
+ * Used most frequently when editing a forum/topic/reply.
+ *
  * @since 2.1.0 bbPress (r3694)
+ *
  * @param string $field Name of the key
  * @param string $context How to sanitize - raw|edit|db|display|attribute|js
  * @return string Field value
+ * @param string $field Name of the key.
+ * @param string $context How to sanitize - raw|edit|db|display|attribute|js.
+ * @return string Field value.
  */
 function bbp_get_global_post_field( $field = 'ID', $context = 'edit' ) {
 …
  * @since 2.1.0 bbPress (r4022)
+ *
  * @param string $action Action nonce
  * @param string $query_arg where to look for nonce in $_REQUEST
+ * @param string $action Action nonce.
+ * @param string $query_arg where to look for nonce in $_REQUEST.
  */
 function bbp_verify_nonce_request( $action = '', $query_arg = '_wpnonce' ) {
 …
 /**
  * Used to guess if page exists at requested path
+ * Used to guess if page exists at requested path.
+ *
  * @since 2.0.0 bbPress (r3304)
+ *
  * @param string $path
  * @return mixed False if no page, Page object if true
+ * @return mixed False if no page, Page object if true.
  */
 function bbp_get_page_by_path( $path = '' ) {
 …
  * @since 2.6.0 bbPress (r6583) Use status_header() & nocache_headers()
+ *
  * @param WP_Query $query  The query being checked
+ *
  * @return bool Always returns true
+ * @param WP_Query $query  The query being checked.
+ *
+ * @return bool Always returns true.
  */
 function bbp_set_404( $query = null ) {
 …
 /**
  * Maybe handle the default 404 handling for some bbPress conditions
+ * Maybe handle the default 404 handling for some bbPress conditions.
+ *
  * Some conditions (like private/hidden forums and edits) have their own checks
 …
  * @since 2.6.0 bbPress (r6555)
+ *
  * @param bool $override Whether to override the default handler
  * @param WP_Query $wp_query The posts query being referenced
+ *
  * @return bool False to leave alone, true to override
+ * @param bool $override Whether to override the default handler.
+ * @param WP_Query $wp_query The posts query being referenced.
+ *
+ * @return bool False to leave alone, true to override.
  */
 function bbp_pre_handle_404( $override = false, $wp_query = false ) {
 …
  * @since 2.6.0 bbPress (r6580)
+ *
  * @param mixed $posts Default null. Array of posts (possibly empty)
+ * @param mixed $posts Default null. Array of posts (possibly empty).
  * @param WP_Query $wp_query
+ *

trunk/src/includes/common/locale.php

r7378	r7380
2	2
3	3	/**
4		* bbPress Localization
	4	* bbPress Localization.
5	5	*
6	6	* @package bbPress

trunk/src/includes/common/locks.php

-                      r7379
+                      r7380
  * @since 2.6.0 bbPress (r6340)
+ *
  * @param int $post_id ID of the post to check for editing
+ * @param int $post_id ID of the post to check for editing.
  * @return integer False: not locked or locked by current user. Int: user ID of user with lock.
  */
 …
 /**
  * Mark the post as currently being edited by the current user
+ * Mark the post as currently being edited by the current user.
+ *
  * @since 2.6.0 bbPress (r6340)
+ *
  * @param int $post_id ID of the post to being edited
+ * @param int $post_id ID of the post to being edited.
  * @return bool|array Returns false if the post doesn't exist of there is no current user, or
  *                     an array of the lock time and the user ID.

trunk/src/includes/common/shortcodes.php

-                      r7378
+                      r7380
     /**
+     * @var array Shortcode => function
+     * Shortcode => function.
+     *
+     * @var array
      */
     public $codes = array();

trunk/src/includes/common/template.php

-                      r7379
+                      r7380
  * @since 2.1.0 bbPress (r3979)
+ *
  * @param string $path Additional path with leading slash
+ * @param string $path Additional path with leading slash.
  */
 function bbp_forums_url( $path = '/' ) {
 …
  * @since 2.1.0 bbPress (r3979)
+ *
  * @param string $path Additional path with leading slash
+ * @param string $path Additional path with leading slash.
  */
 function bbp_get_forums_url( $path = '/' ) {
 …
  * @since 2.1.0 bbPress (r3979)
+ *
  * @param string $path Additional path with leading slash
+ * @param string $path Additional path with leading slash.
  */
 function bbp_topics_url( $path = '/' ) {
 …
  * @since 2.1.0 bbPress (r3979)
+ *
  * @param string $path Additional path with leading slash
+ *
  * @return The URL to the topics archive
+ * @param string $path Additional path with leading slash.
+ *
+ * @return The URL to the topics archive.
  */
 function bbp_get_topics_url( $path = '/' ) {
 …
  * @param int $site_id
+ *
  * @return bool True if site is public, false if private
+ * @return bool True if site is public, false if private.
  */
 function bbp_is_site_public( $site_id = 0 ) {
 …
  * @since 2.0.0 bbPress (r2549)
+ *
  * @param int $post_id Possible post_id to check
+ *
  * @return bool True if it's a forum page, false if not
+ * @param int $post_id Possible post_id to check.
+ *
+ * @return bool True if it's a forum page, false if not.
  */
 function bbp_is_forum( $post_id = 0 ) {
 …
  * @global string $pagenow The filename of the current screen.
+ *
  * @return bool True if it's the forum edit page, false if not
+ * @return bool True if it's the forum edit page, false if not.
  */
 function bbp_is_forum_edit() {
 …
  * @since 2.0.0 bbPress (r2549)
+ *
  * @param int $post_id Possible post_id to check
+ *
  * @return bool True if it's a topic page, false if not
+ * @param int $post_id Possible post_id to check.
+ *
+ * @return bool True if it's a topic page, false if not.
  */
 function bbp_is_topic( $post_id = 0 ) {
 …
  * @global string $pagenow The filename of the current screen.
+ *
  * @return bool True if it's the topic edit page, false if not
+ * @return bool True if it's the topic edit page, false if not.
  */
 function bbp_is_topic_edit() {
 …
  * @since 2.0.0 bbPress (r2756)
+ *
  * @return bool True if it's the topic merge page, false if not
+ * @return bool True if it's the topic merge page, false if not.
  */
 function bbp_is_topic_merge() {
 …
  * @since 2.0.0 bbPress (r2756)
+ *
  * @return bool True if it's the topic split page, false if not
+ * @return bool True if it's the topic split page, false if not.
  */
 function bbp_is_topic_split() {
 …
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return bool True if it's a topic tag, false if not
+ * @return bool True if it's a topic tag, false if not.
  */
 function bbp_is_topic_tag() {
 …
  * @global string $taxnow  The taxonomy of the current screen.
+ *
  * @return bool True if editing a topic tag, false if not
+ * @return bool True if editing a topic tag, false if not.
  */
 function bbp_is_topic_tag_edit() {
 …
  * @since 2.0.0 bbPress (r2549)
+ *
  * @param int $post_id Possible post_id to check
+ *
  * @return bool True if it's a reply page, false if not
+ * @param int $post_id Possible post_id to check.
+ *
+ * @return bool True if it's a reply page, false if not.
  */
 function bbp_is_reply( $post_id = 0 ) {
 …
  * @global string $pagenow The filename of the current screen.
+ *
  * @return bool True if it's the reply edit page, false if not
+ * @return bool True if it's the reply edit page, false if not.
  */
 function bbp_is_reply_edit() {
 …
  * Check if current page is a reply move page.
+ *
  * @return bool True if it's the reply move page, false if not
+ * @return bool True if it's the reply move page, false if not.
  */
 function bbp_is_reply_move() {
 …
  * @since 2.0.0 bbPress (r2652)
+ *
  * @return bool True if it's the favorites page, false if not
+ * @return bool True if it's the favorites page, false if not.
  */
 function bbp_is_favorites() {
 …
  * @since 2.0.0 bbPress (r2652)
+ *
  * @return bool True if it's the subscriptions page, false if not
+ * @return bool True if it's the subscriptions page, false if not.
  */
 function bbp_is_subscriptions() {
 …
  * @since 2.0.0 bbPress (r2688)
+ *
  * @return bool True if it's the topics created page, false if not
+ * @return bool True if it's the topics created page, false if not.
  */
 function bbp_is_topics_created() {
 …
  * @since 2.2.0 bbPress (r4225)
+ *
  * @return bool True if it's the replies created page, false if not
+ * @return bool True if it's the replies created page, false if not.
  */
 function bbp_is_replies_created() {
 …
  * @since 2.0.0 bbPress (r2688)
+ *
  * @return bool True if it's the user's home, false if not
+ * @return bool True if it's the user's home, false if not.
  */
 function bbp_is_user_home() {
 …
  * @since 2.1.0 bbPress (r3918)
+ *
  * @return bool True if it's the user's home, false if not
+ * @return bool True if it's the user's home, false if not.
  */
 function bbp_is_user_home_edit() {
 …
  * @since 2.0.0 bbPress (r2688)
+ *
  * @return bool True if it's a user's profile page, false if not
+ * @return bool True if it's a user's profile page, false if not.
  */
 function bbp_is_single_user() {
 …
  * @since 2.0.0 bbPress (r2688)
+ *
  * @return bool True if it's a user's profile edit page, false if not
+ * @return bool True if it's a user's profile edit page, false if not.
  */
 function bbp_is_single_user_edit() {
 …
  * @since 2.2.0 bbPress (r4225)
+ *
  * @return bool True if it's a user's profile page, false if not
+ * @return bool True if it's a user's profile page, false if not.
  */
 function bbp_is_single_user_profile() {
 …
  * @since 2.2.0 bbPress (r4225)
+ *
  * @return bool True if it's a user's topics page, false if not
+ * @return bool True if it's a user's topics page, false if not.
  */
 function bbp_is_single_user_topics() {
 …
  * @since 2.2.0 bbPress (r4225)
+ *
  * @return bool True if it's a user's replies page, false if not
+ * @return bool True if it's a user's replies page, false if not.
  */
 function bbp_is_single_user_replies() {
 …
  * @since 2.6.0 bbPress (r6320)
+ *
  * @return bool True if it's a user's replies page, false if not
+ * @return bool True if it's a user's replies page, false if not.
  */
 function bbp_is_single_user_engagements() {
 …
  * @since 2.0.0 bbPress (r2789)
+ *
  * @global WP_Query $wp_query To check if WP_Query::bbp_is_view is true
+ * @global WP_Query $wp_query To check if WP_Query::bbp_is_view is true.
+ *
  * @return bool Is it a view page?
 …
  * @since 2.3.0 bbPress (r4579)
+ *
  * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true
+ * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true.
+ *
  * @return bool Is it a search page?
 …
  * @since 2.4.0 bbPress (r4919)
+ *
  * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true
+ * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true.
+ *
  * @return bool Is it a search page?
 …
  * @since 2.1.0 bbPress (r3585)
+ *
  * @return bool True if it's the edit page, false if not
+ * @return bool True if it's the edit page, false if not.
  */
 function bbp_is_edit() {
 …
  * @since 2.0.0 bbPress (r3344)
+ *
  * @return bool In a bbPress page
+ * @return bool In a bbPress page.
  */
 function is_bbpress() {
 …
  * @since 2.0.0 bbPress (r2815)
+ *
  * @param string $redirect_to Pass a URL to redirect to
+ * @param string $redirect_to Pass a URL to redirect to.
  */
 function bbp_redirect_to_field( $redirect_to = '' ) {
 …
  *                           textarea|password|select|radio|checkbox
+ *
  * @return string Sanitized value ready for screen display
+ * @return string Sanitized value ready for screen display.
  */
 function bbp_get_sanitize_val( $request = '', $input_type = 'text' ) {
 …
+ *
  * @param int $auto_increment Optional. Default true. Set to false to prevent
  *                            increment
+ *                            increment.
  */
 function bbp_tab_index( $auto_increment = true ) {
 …
+ *
  * @param int $auto_increment Optional. Default true. Set to false to
  *                            prevent the increment
+ *
  * @return int $bbp->tab_index The global tab index
+ *                            prevent the increment.
+ *
+ * @return int $bbp->tab_index The global tab index.
  */
 function bbp_get_tab_index( $auto_increment = true ) {
 …
  * @since 2.6.0 bbPress (r6424)
+ *
  * @param mixed $tab False to skip, any integer to use
+ * @param mixed $tab False to skip, any integer to use.
  */
 function bbp_tab_index_attribute( $tab = false ) {
 …
  * @since 2.6.0 bbPress (r6424)
+ *
  * @param mixed $tab False to skip, any integer to use
+ * @param mixed $tab False to skip, any integer to use.
+ *
  * @return string
 …
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param array $args See {@link bbp_get_dropdown()} for arguments
+ * @param array $args See {@link bbp_get_dropdown()} for arguments.
  */
 function bbp_dropdown( $args = array() ) {
 …
  * Merge topic form fields.
+ *
  * Output the required hidden fields when merging a topic
+ * Output the required hidden fields when merging a topic.
+ *
  * @since 2.0.0 bbPress (r2756)
 …
  * Split topic form fields.
+ *
  * Output the required hidden fields when splitting a topic
+ * Output the required hidden fields when splitting a topic.
+ *
  * @since 2.0.0 bbPress (r2756)
 …
  * Move reply form fields.
+ *
+ * Output the required hidden fields when moving a reply
+ * Output the required hidden fields when moving a reply.
+ *
+ * @since 2.1.0 bbPress (r3586)
  */
 function bbp_move_reply_form_fields() {
 …
  * @since 2.0.0 bbPress (r2789)
+ *
  * @param string $view Optional. View id
+ * @param string $view Optional. View id.
  */
 function bbp_view_id( $view = '' ) {
 …
  * @param string $view Optional. View id.
+ *
  * @return bool|string ID on success, false on failure
+ * @return bool|string ID on success, false on failure.
  */
 function bbp_get_view_id( $view = '' ) {
 …
  * @since 2.0.0 bbPress (r2789)
+ *
  * @param string $view Optional. View id
+ * @param string $view Optional. View id.
  */
 function bbp_view_title( $view = '' ) {
 …
  * @since 2.0.0 bbPress (r2789)
+ *
  * @param string $view Optional. View id
+ *
  * @return bool|string Title on success, false on failure
+ * @param string $view Optional. View id.
+ *
+ * @return bool|string Title on success, false on failure.
  */
 function bbp_get_view_title( $view = '' ) {
 …
  * @since 2.0.0 bbPress (r2789)
+ *
  * @param string $view Optional. View id
+ * @param string $view Optional. View id.
  */
 function bbp_view_url( $view = false ) {
 …
  * @since 2.0.0 bbPress (r2789)
+ *
+ * @param string $view Optional. View id
+ *                     used view id
+ *
+ * @return string View url (or home url if the view was not found )
+ * @param string $view Optional. View id.
+ *
+ * @return string View url (or home url if the view was not found).
  */
 function bbp_get_view_url( $view = false ) {
 …
  * @since 2.0.0 bbPress (r2980)
+ *
  * @return bool True if match, false if not
+ * @return bool True if match, false if not.
  */
 function bbp_is_query_name( $name = '' ) {
 …
  * @since 2.0.0 bbPress (r2695)
+ *
  * @return string To return the query var value
+ * @return string To return the query var value.
  */
 function bbp_get_query_name() {
 …
  * @since 2.0.0 bbPress (r2692)
+ *
  * @param string $name What to set the query var to
+ * @param string $name What to set the query var to.
  */
 function bbp_set_query_name( $name = '' ) {
 …
  * @since 2.0.0 bbPress (r2589)
+ *
  * @param string $sep Separator. Defaults to '&larr;'
  * @param bool $current_page Include the current item
  * @param bool $root Include the root page if one exists
+ *
  * @return string Breadcrumbs
+ * @param string $sep Separator. Defaults to '&larr;'.
+ * @param bool $current_page Include the current item.
+ * @param bool $root Include the root page if one exists.
+ *
+ * @return string Breadcrumbs.
  */
 function bbp_get_breadcrumb( $args = array() ) {
 …
  * @since 2.0.0 bbPress (r2780)
+ *
  * @return string HTML allowed tags entity encoded
+ * @return string HTML allowed tags entity encoded.
  */
 function bbp_get_allowed_tags() {
 …
  * @since 2.0.0 bbPress (r2827)
+ *
  * @param string $redirect_to Redirect to url
+ * @param string $redirect_to Redirect to url.
  */
 function bbp_logout_link( $redirect_to = '' ) {
 …
  * @since 2.0.0 bbPress (r2827)
+ *
  * @param string $redirect_to Redirect to url
  *                            redirect to url
+ *
  * @return string The logout link
+ * @param string $redirect_to Redirect to url.
+ *                            redirect to url.
+ *
+ * @return string The logout link.
  */
 function bbp_get_logout_link( $redirect_to = '' ) {
 …
  *                            various items within the page title.
  * @param string $seplocation Optional. Direction to display title, 'right'.
  *                            separator and separator location
+ *
  * @return string The title
+ *                            separator and separator location.
+ *
+ * @return string The title.
  */
 function bbp_title( $title = '', $sep = '&raquo;', $seplocation = '' ) {
 …
  * @since 2.7.0
+ *
  * @param string      $prepend text displayed before a post title
  * @param int|WP_Post $post    current post object
+ * @param string      $prepend text displayed before a post title.
+ * @param int|WP_Post $post    current post object.
+ *
  * @return string

trunk/src/includes/common/widgets.php

-                      r7379
+                      r7380
 /**
  * bbPress Widgets
+ * bbPress Widgets.
+ *
  * Contains the forum list, topic list, reply list and login form widgets.
 …
 /**
  * bbPress Login Widget
+ *
  * Adds a widget which displays the login form
+ * bbPress Login Widget.
+ *
+ * Adds a widget which displays the login form.
+ *
  * @since 2.0.0 bbPress (r2827)
 …
     /**
      * bbPress Login Widget
+     *
      * Registers the login widget
+     * bbPress Login Widget.
+     *
+     * Registers the login widget.
+     *
      * @since 2.0.0 bbPress (r2827)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.0.0 bbPress (r3389)
 …
     /**
      * Displays the output, the login form
+     * Displays the output, the login form.
+     *
      * @since 2.0.0 bbPress (r2827)
+     *
      * @param array $args Arguments
      * @param array $instance Instance
+     * @param array $args Arguments.
+     * @param array $instance Instance.
      */
     public function widget( $args = array(), $instance = array() ) {
 …
     /**
      * Update the login widget options
+     * Update the login widget options.
+     *
      * @since 2.0.0 bbPress (r2827)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
      */
     public function update( $new_instance, $old_instance ) {
 …
     /**
      * Output the login widget options form
+     * Output the login widget options form.
+     *
      * @since 2.0.0 bbPress (r2827)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function form( $instance = array() ) {
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {
 …
 /**
  * bbPress Views Widget
+ *
  * Adds a widget which displays the view list
+ * bbPress Views Widget.
+ *
+ * Adds a widget which displays the view list.
+ *
  * @since 2.0.0 bbPress (r3020)
 …
     /**
      * bbPress View Widget
+     *
      * Registers the view widget
+     * bbPress View Widget.
+     *
+     * Registers the view widget.
+     *
      * @since 2.0.0 bbPress (r3020)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.0.0 bbPress (r3389)
 …
     /**
      * Displays the output, the view list
+     * Displays the output, the view list.
+     *
      * @since 2.0.0 bbPress (r3020)
+     *
      * @param array $args Arguments
      * @param array $instance Instance
+     * @param array $args Arguments.
+     * @param array $instance Instance.
      */
     public function widget( $args = array(), $instance = array() ) {
 …
     /**
      * Update the view widget options
+     * Update the view widget options.
+     *
      * @since 2.0.0 bbPress (r3020)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
      */
     public function update( $new_instance = array(), $old_instance = array() ) {
 …
     /**
      * Output the view widget options form
+     * Output the view widget options form.
+     *
      * @since 2.0.0 bbPress (r3020)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function form( $instance = array() ) {
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {
 …
 /**
  * bbPress Search Widget
+ *
  * Adds a widget which displays the forum search form
+ * bbPress Search Widget.
+ *
+ * Adds a widget which displays the forum search form.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
     /**
      * bbPress Search Widget
+     *
      * Registers the search widget
+     * bbPress Search Widget.
+     *
+     * Registers the search widget.
+     *
      * @since 2.3.0 bbPress (r4579)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.3.0 bbPress (r4579)
 …
     /**
      * Displays the output, the search form
+     * Displays the output, the search form.
+     *
      * @since 2.3.0 bbPress (r4579)
 …
     /**
      * Update the widget options
+     * Update the widget options.
+     *
      * @since 2.3.0 bbPress (r4579)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
      */
     public function update( $new_instance, $old_instance ) {
 …
     /**
      * Output the search widget options form
+     * Output the search widget options form.
+     *
      * @since 2.3.0 bbPress (r4579)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function form( $instance ) {
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {
 …
 /**
  * bbPress Forum Widget
+ *
  * Adds a widget which displays the forum list
+ * bbPress Forum Widget.
+ *
+ * Adds a widget which displays the forum list.
+ *
  * @since 2.0.0 bbPress (r2653)
 …
     /**
      * bbPress Forum Widget
+     *
      * Registers the forum widget
+     * bbPress Forum Widget.
+     *
+     * Registers the forum widget.
+     *
      * @since 2.0.0 bbPress (r2653)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.0.0 bbPress (r3389)
 …
     /**
      * Displays the output, the forum list
+     * Displays the output, the forum list.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param array $args Arguments
      * @param array $instance Instance
+     * @param array $args Arguments.
+     * @param array $instance Instance.
      */
     public function widget( $args, $instance ) {
 …
     /**
      * Update the forum widget options
+     * Update the forum widget options.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
      */
     public function update( $new_instance, $old_instance ) {
 …
     /**
      * Output the forum widget options form
+     * Output the forum widget options form.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function form( $instance ) {
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {
 …
 /**
  * bbPress Topic Widget
+ *
  * Adds a widget which displays the topic list
+ * bbPress Topic Widget.
+ *
+ * Adds a widget which displays the topic list.
+ *
  * @since 2.0.0 bbPress (r2653)
 …
     /**
      * bbPress Topic Widget
+     *
      * Registers the topic widget
+     * bbPress Topic Widget.
+     *
+     * Registers the topic widget.
+     *
      * @since 2.0.0 bbPress (r2653)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.0.0 bbPress (r3389)
 …
     /**
      * Displays the output, the topic list
+     * Displays the output, the topic list.
+     *
      * @since 2.0.0 bbPress (r2653)
 …
     /**
      * Update the topic widget options
+     * Update the topic widget options.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
      */
     public function update( $new_instance = array(), $old_instance = array() ) {
 …
     /**
      * Output the topic widget options form
+     * Output the topic widget options form.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function form( $instance = array() ) {
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {
 …
 /**
  * bbPress Statistics Widget
+ *
  * Adds a widget which displays the forum statistics
+ * bbPress Statistics Widget.
+ *
+ * Adds a widget which displays the forum statistics.
+ *
  * @since 2.3.0 bbPress (r4509)
 …
     /**
      * bbPress Statistics Widget
+     *
      * Registers the statistics widget
+     * bbPress Statistics Widget.
+     *
+     * Registers the statistics widget.
+     *
      * @since 2.3.0 bbPress (r4509)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.3.0 bbPress (r4509)
 …
     /**
      * Displays the output, the statistics
+     * Displays the output, the statistics.
+     *
      * @since 2.3.0 bbPress (r4509)
+     *
      * @param array $args     Arguments
      * @param array $instance Instance
+     * @param array $args     Arguments.
+     * @param array $instance Instance.
      */
     public function widget( $args = array(), $instance = array() ) {
 …
     /**
      * Update the statistics widget options
+     * Update the statistics widget options.
+     *
      * @since 2.3.0 bbPress (r4509)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
+     *
      * @return array
 …
     /**
      * Output the statistics widget options form
+     * Output the statistics widget options form.
+     *
      * @since 2.3.0 bbPress (r4509)
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {
 …
 /**
  * bbPress Replies Widget
+ *
  * Adds a widget which displays the replies list
+ * bbPress Replies Widget.
+ *
+ * Adds a widget which displays the replies list.
+ *
  * @since 2.0.0 bbPress (r2653)
 …
     /**
      * bbPress Replies Widget
+     *
      * Registers the replies widget
+     * bbPress Replies Widget.
+     *
+     * Registers the replies widget.
+     *
      * @since 2.0.0 bbPress (r2653)
 …
     /**
      * Register the widget
+     * Register the widget.
+     *
      * @since 2.0.0 bbPress (r3389)
 …
     /**
      * Displays the output, the replies list
+     * Displays the output, the replies list.
+     *
      * @since 2.0.0 bbPress (r2653)
 …
     /**
      * Update the reply widget options
+     * Update the reply widget options.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param array $new_instance The new instance options
      * @param array $old_instance The old instance options
+     * @param array $new_instance The new instance options.
+     * @param array $old_instance The old instance options.
      */
     public function update( $new_instance = array(), $old_instance = array() ) {
 …
     /**
      * Output the reply widget options form
+     * Output the reply widget options form.
+     *
      * @since 2.0.0 bbPress (r2653)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function form( $instance = array() ) {
 …
      * @since 2.3.0 bbPress (r4802)
+     *
      * @param $instance Instance
+     * @param $instance Instance.
      */
     public function parse_settings( $instance = array() ) {

trunk/src/includes/core/abstraction.php

-                      r7378
+                      r7380
 /**
  * bbPress Abstractions
+ * bbPress Abstractions.
+ *
  * This file contains functions for abstracting WordPress core functionality
 …
 /**
  * Setup Admin
+ * Setup Admin.
+ *
  * This exists outside of "/includes/admin/" because the converter may need to
 …
 /**
  * Setup Converter
+ * Setup Converter.
+ *
  * This exists outside of "/includes/admin/" because the converter may need to
 …
 /**
  * Lookup and return a global variable
+ * Lookup and return a global variable.
+ *
  * @since 2.5.8 bbPress (r5814)
+ *
  * @param  string  $name     Name of global variable
  * @param  string  $type     Type of variable to check with `is_a()`
  * @param  mixed   $default  Default value to return if no global found
+ *
  * @return mixed   Verified object if valid, Default or null if invalid
+ * @param  string  $name     Name of global variable.
+ * @param  string  $type     Type of variable to check with `is_a()`.
+ * @param  mixed   $default  Default value to return if no global found.
+ *
+ * @return mixed   Verified object if valid, Default or null if invalid.
  */
 function bbp_get_global_object( $name = '', $type = '', $default = null ) {
 …
 /**
  * Get the `$wp_query` global without needing to declare it everywhere
+ * Get the `$wp_query` global without needing to declare it everywhere.
+ *
  * @since 2.6.0 bbPress (r6582)
 …
 /**
  * Get the `$wp_roles` global without needing to declare it everywhere
+ * Get the `$wp_roles` global without needing to declare it everywhere.
+ *
  * @since 2.2.0 bbPress (r4293)
 …
 /**
  * Get the root URL
+ * Get the root URL.
+ *
  * @since 2.5.8 bbPress (r5814)
 …
 /**
  * Get the slug used for paginated requests
+ * Get the slug used for paginated requests.
+ *
  * @since 2.4.0 bbPress (r4926)
 …
  * @since 2.5.8 bbPress (r5814)
+ *
  * @global object $wp_rewrite The WP_Rewrite object
+ * @global object $wp_rewrite The WP_Rewrite object.
+ *
  * @return bool
 …
  * @since 2.6.0 bbPress (r6678)
+ *
  * @param string $pagination_links The HTML links used for pagination
+ * @param string $pagination_links The HTML links used for pagination.
+ *
  * @return string
 …
 /**
  * Parse the WordPress core version number
+ * Parse the WordPress core version number.
+ *
  * @since 2.6.0 bbPress (r6051)
 …
  * @since 2.6.0 bbPress (r6242)
+ *
  * @return bool True if more than 10000 users, false not
+ * @return bool True if more than 10000 users, false not.
  */
 function bbp_is_large_install() {
 …
 /**
  * Get the total number of users on the forums
+ * Get the total number of users on the forums.
+ *
  * @since 2.0.0 bbPress (r2769)
+ *
  * @return int Total number of users
+ * @return int Total number of users.
  */
 function bbp_get_total_users() {
 …
  * @since 2.6.0
+ *
  * @staticvar mixed $rand Null by default, random string on first call
+ * @staticvar mixed $rand Null by default, random string on first call.
+ *
  * @return string
 …
 /**
  * Whether a value has been intercepted
+ * Whether a value has been intercepted.
+ *
  * @since 2.6.0
 …
  * @since 2.6.0
+ *
  * @param string $action Typically the name of the caller function
  * @param array  $args   Typically the results of caller function func_get_args()
+ * @param string $action Typically the name of the caller function.
+ * @param array  $args   Typically the results of caller function func_get_args().
+ *
  * @return mixed         Intercept results. Default bbp_default_intercept().

trunk/src/includes/core/actions.php

-                      r7376
+                      r7380
 /**
  * bbPress Actions
+ * bbPress Actions.
+ *
  * This file contains the actions that are used through-out bbPress. They are
 …
 /**
  * Attach bbPress to WordPress
+ * Attach bbPress to WordPress.
+ *
  * bbPress uses its own internal actions to help aid in third-party plugin
 …
 /**
  * bbp_loaded - Attached to 'plugins_loaded' above
+ * bbp_loaded - Attached to 'plugins_loaded' above.
+ *
  * Attach various loader actions to the bbp_loaded action.
 …
 /**
  * bbp_init - Attached to 'init' above
+ * bbp_init - Attached to 'init' above.
+ *
  * Attach various initialization actions to the init action.
 …
 /**
  * bbp_setup_theme - Attached to 'setup_theme' above
+ * bbp_setup_theme - Attached to 'setup_theme' above.
+ *
  * Attach various theme related actions to the setup_theme action.
 …
 /**
  * bbp_roles_init - Attached to 'wp_roles_init' above
+ * bbp_roles_init - Attached to 'wp_roles_init' above.
+ *
  * Attach various role related actions to the wp_roles_init action.
 …
 /**
  * bbp_register - Attached to 'init' above on 0 priority
+ * bbp_register - Attached to 'init' above on 0 priority.
+ *
  * Attach various initialization actions early to the init action.
 …
 /**
  * bbp_ready - attached to end 'bbp_init' above
+ * bbp_ready - attached to end 'bbp_init' above.
+ *
  * Attach actions to the ready action after bbPress has fully initialized.

trunk/src/includes/core/cache.php

-                      r6585
+                      r7380
 /**
  * bbPress Cache Helpers
+ * bbPress Cache Helpers.
+ *
  * Helper functions used to communicate with WordPress's various caches. Many
 …
     /**
      * @var int Post ID being updated
+     * @var int Post ID being updated.
      */
     private $updating_post = 0;
     /**
      * @var bool The original value of $_wp_suspend_cache_invalidation global
+     * @var bool The original value of $_wp_suspend_cache_invalidation global.
      */
     private $original_cache_invalidation = false;
 …
      * @since 2.1.0 bbPress (r4011)
+     *
+     * @param int $post_id The post ID being updated
+     * @return If invalid post data
+     * @param int $post_id The post ID being updated.
      */
     public function pre_post_update( $post_id = 0 ) {
 …
      * @since 2.1.0 bbPress (r4011)
+     *
+     * @param int $post_id The post ID of the cache being invalidated
+     * @return If invalid post data
+     * @param int $post_id The post ID of the cache being invalidated.
      */
     public function skip_related_posts( $post_id = 0 ) {

trunk/src/includes/core/capabilities.php

-                      r7378
+                      r7380
 /**
  * bbPress Capabilites
+ * bbPress Capabilities.
+ *
  * The functions in this file are used primarily as convenient wrappers for
 …
  * @since 2.0.0 bbPress (r2994)
+ *
  * @todo Map all of these and deprecate
+ *
  * @param string $role Optional. Defaults to The role to load caps for
+ *
  * @return array Capabilities for $role
+ * @todo Map all of these and deprecate.
+ *
+ * @param string $role Optional. Defaults to The role to load caps for.
+ *
+ * @return array Capabilities for $role.
  */
 function bbp_get_caps_for_role( $role = '' ) {
 …
 /**
  * Get the available roles, minus the dynamic roles that come with bbPress
+ * Get the available roles, minus the dynamic roles that come with bbPress.
+ *
  * @since 2.4.0 bbPress (r5064)
 …
  * @since 2.2.0 bbPress (r4290)
+ *
  * @param WP_Roles $wp_roles The array of WP_Role objects that was initialized
+ *
  * @return WP_Roles The main $wp_roles global
+ * @param WP_Roles $wp_roles The array of WP_Role objects that was initialized.
+ *
+ * @return WP_Roles The main $wp_roles global.
  */
 function bbp_add_forums_roles( $wp_roles = null ) {
 …
 /**
  * Helper function to add filter to option_wp_user_roles
+ * Helper function to add filter to option_wp_user_roles.
+ *
  * @since 2.2.0 bbPress (r4363)
 …
  * @deprecated 2.6.0 bbPress (r6105)
+ *
  * @internal Used by bbPress to reinitialize dynamic roles on blog switch
+ * @internal Used by bbPress to reinitialize dynamic roles on blog switch.
+ *
  * @param array $roles
  * @return array Combined array of database roles and dynamic bbPress roles
+ * @return array Combined array of database roles and dynamic bbPress roles.
  */
 function _bbp_reinit_dynamic_roles( $roles = array() ) {
 …
 /**
  * Gets a translated role name from a role ID
+ * Gets a translated role name from a role ID.
+ *
  * @since 2.3.0 bbPress (r4792)
 …
+ *
  * @param string $role_id
  * @return string Translated role name
+ * @return string Translated role name.
  */
 function bbp_get_dynamic_role_name( $role_id = '' ) {
 …
 /**
  * Removes the bbPress roles from the editable roles array
+ * Removes the bbPress roles from the editable roles array.
+ *
  * This used to use array_diff_assoc() but it randomly broke before 2.2 release.
 …
  * @since 2.2.0 bbPress (r4303)
+ *
  * @param array $all_roles All registered roles
+ * @param array $all_roles All registered roles.
  * @return array
  */
 …
 /**
  * The keymaster role for bbPress users
+ * The keymaster role for bbPress users.
+ *
  * @since 2.2.0 bbPress (r4284)
 …
 /**
  * The moderator role for bbPress users
+ * The moderator role for bbPress users.
+ *
  * @since 2.0.0 bbPress (r3410)
 …
 /**
  * The participant role for registered user that can participate in forums
+ * The participant role for registered user that can participate in forums.
+ *
  * @since 2.0.0 bbPress (r3410)
 …
 /**
  * The spectator role is for registered users without any capabilities
+ * The spectator role is for registered users without any capabilities.
+ *
  * @since 2.1.0 bbPress (r3860)
 …
 /**
  * The blocked role is for registered users that cannot spectate or participate
+ * The blocked role is for registered users that cannot spectate or participate.
+ *
  * @since 2.2.0 bbPress (r4284)

trunk/src/includes/core/extend.php

-                      r6284
+                      r7380
 /**
  * bbPress Extentions
+ * bbPress Extensions.
+ *
  * There's a world of really cool plugins out there, and bbPress comes with
 …
 /**
  * Loads Akismet inside the bbPress global class
+ * Loads Akismet inside the bbPress global class.
+ *
  * @since 2.0.0 bbPress (r3277)
+ *
  * @return If bbPress is not active
+ * @return If bbPress is not active.
  */
 function bbp_setup_akismet() {
 …
 /**
  * Requires and creates the BuddyPress extension, and adds component creation
  * action to bp_init hook. @see bbp_setup_buddypress_component()
+ * action to bp_init hook. @see bbp_setup_buddypress_component().
+ *
  * @since 2.0.0 bbPress (r3395)
+ *
  * @return If BuddyPress is not active
+ * @return If BuddyPress is not active.
  */
 function bbp_setup_buddypress() {

trunk/src/includes/core/filters.php

-                      r7378
+                      r7380
 /**
  * Deprecated locale filter
+ * Deprecated locale filter.
+ *
  * @since 2.2.0 bbPress (r4213)
+ *
  * @param string $locale
  * @return string  $domain
+ * @return string $domain
  */
 function _bbp_filter_locale( $locale = '', $domain = '' ) {
 …
 /**
  * Deprecated forums query filter
+ * Deprecated forums query filter.
+ *
  * @since 2.1.0 bbPress (r3961)
 …
 /**
  * Deprecated topics query filter
+ * Deprecated topics query filter.
+ *
  * @since 2.1.0 bbPress (r3961)
 …
 /**
  * Deprecated replies query filter
+ * Deprecated replies query filter.
+ *
  * @since 2.1.0 bbPress (r3961)

trunk/src/includes/core/functions.php

-                      r7190
+                      r7380
 /**
  * bbPress Core Functions
+ * bbPress Core Functions.
+ *
  * @package bbPress
 …
 /**
  * Output the bbPress version
+ * Output the bbPress version.
+ *
  * @since 2.0.0 bbPress (r3468)
 …
     echo bbp_get_version();
+}
+    /**
+     * Return the bbPress version
+     *
+     * @since 2.0.0 bbPress (r3468)
+     *
+     * @retrun string The bbPress version
+     */
+    function bbp_get_version() {
+        return bbpress()->version;
+    }
+/**
+ * Output the bbPress asset version
+/**
+ * Return the bbPress version.
+ *
+ * @since 2.0.0 bbPress (r3468)
+ *
+ * @return string The bbPress version.
+ */
+function bbp_get_version() {
+    return bbpress()->version;
+}
+/**
+ * Output the bbPress asset version.
+ *
  * @since 2.6.7 bbPress (r7188)
 …
     echo bbp_get_asset_version();
+}
+    /**
+     * Return the bbPress asset version
+     *
+     * @since 2.6.7 bbPress (r7188)
+     *
+     * @retrun string The bbPress asset version
+     */
+    function bbp_get_asset_version() {
+        return bbp_doing_script_debug()
+            ? (string) time()
+            : bbp_get_version();
+    }
+/**
+ * Output the bbPress database version
+/**
+ * Return the bbPress asset version.
+ *
+ * @since 2.6.7 bbPress (r7188)
+ *
+ * @return string The bbPress asset version.
+ */
+function bbp_get_asset_version() {
+    return bbp_doing_script_debug()
+        ? (string) time()
+        : bbp_get_version();
+}
+/**
+ * Output the bbPress database version.
+ *
  * @since 2.0.0 bbPress (r3468)
 …
     echo bbp_get_db_version();
+}
+    /**
+     * Return the bbPress database version
+     *
+     * @since 2.0.0 bbPress (r3468)
+     *
+     * @retrun string The bbPress version
+     */
+    function bbp_get_db_version() {
+        return bbpress()->db_version;
+    }
+/**
+ * Output the bbPress database version directly from the database
+/**
+ * Return the bbPress database version.
+ *
+ * @since 2.0.0 bbPress (r3468)
+ *
+ * @return string The bbPress version.
+ */
+function bbp_get_db_version() {
+    return bbpress()->db_version;
+}
+/**
+ * Output the bbPress database version directly from the database.
+ *
  * @since 2.0.0 bbPress (r3468)
 …
     echo bbp_get_db_version_raw();
+}
+    /**
+     * Return the bbPress database version directly from the database
+     *
+     * @since 2.0.0 bbPress (r3468)
+     *
+     * @retrun string The current bbPress version
+     */
+    function bbp_get_db_version_raw() {
+        return get_option( '_bbp_db_version', '' );
+    }
+/**
+ * Return the bbPress database version directly from the database.
+ *
+ * @since 2.0.0 bbPress (r3468)
+ *
+ * @return string The current bbPress version.
+ */
+function bbp_get_db_version_raw() {
+    return get_option( '_bbp_db_version', '' );
+}
 /** Post Meta *****************************************************************/
 /**
  * Update the forum meta ID of a post
+ * Update the forum meta ID of a post.
+ *
  * @since 2.0.0 bbPress (r3181)
+ *
  * @param int $post_id  The post to update
  * @param int $forum_id The forum
+ * @param int $post_id  The post to update.
+ * @param int $forum_id The forum id.
  */
 function bbp_update_forum_id( $post_id = 0, $forum_id = 0 ) {
 …
 /**
  * Update the topic meta ID of a post
+ * Update the topic meta ID of a post.
+ *
  * @since 2.0.0 bbPress (r3181)
+ *
  * @param int $post_id  The post to update
  * @param int $topic_id The topic
+ * @param int $post_id  The post to update.
+ * @param int $topic_id The topic id.
  */
 function bbp_update_topic_id( $post_id = 0, $topic_id = 0 ) {
 …
 /**
  * Update the reply meta ID of a post
+ * Update the reply meta ID of a post.
+ *
  * @since 2.0.0 bbPress (r3181)
+ *
  * @param int $post_id  The post to update
  * @param int $reply_id The reply
+ * @param int $post_id  The post to update.
+ * @param int $reply_id The reply id.
  */
 function bbp_update_reply_id( $post_id = 0, $reply_id = 0 ) {
 …
 /**
  * Update the reply-to meta ID of a post
+ * Update the reply-to meta ID of a post.
+ *
  * @since 2.6.0 bbPress (r5735)
+ *
  * @param int $post_id  The post to update
  * @param int $reply_id The reply ID
+ * @param int $post_id  The post to update.
+ * @param int $reply_id The reply id.
  */
 function bbp_update_reply_to_id( $post_id = 0, $reply_id = 0 ) {
 …
 /**
  * Get the registered views
+ *
  * Does nothing much other than return the {@link $bbp->views} variable
+ * Get the registered views.
+ *
+ * Does nothing much other than return the {@link $bbp->views} variable.
+ *
  * @since 2.0.0 bbPress (r2789)
+ *
  * @return array Views
+ * @return array Views.
  */
 function bbp_get_views() {
 …
 /**
  * Register a bbPress view
+ * Register a bbPress view.
+ *
  * @since 2.0.0 bbPress (r2789)
+ *
  * @param string $view View name
  * @param string $title View title
+ * @param string $view View name.
+ * @param string $title View title.
  * @param mixed $query_args {@link bbp_has_topics()} arguments.
  * @param bool $feed Have a feed for the view? Defaults to true.
  * @param string $capability Capability that the current user must have
+ *
  * @return array The just registered (but processed) view
+ * @param string $capability Capability that the current user must have.
+ *
+ * @return array The just registered (but processed) view.
  */
 function bbp_register_view( $view, $title, $query_args = '', $feed = true, $capability = '' ) {
 …
 /**
  * Deregister a bbPress view
+ * Deregister a bbPress view.
+ *
  * @since 2.0.0 bbPress (r2789)
+ *
+ * @param string $view View name
+ * @return bool False if the view doesn't exist, true on success
+ * @param string $view View name.
+ *
+ * @return bool False if the view doesn't exist, true on success.
  */
 function bbp_deregister_view( $view ) {
 …
 /**
  * Run the query of a topic-view
+ * Run the query of a topic-view.
+ *
  * @since 2.0.0 bbPress (r2789)
+ *
  * @param string $view Optional. View id
+ * @param string $view Optional. View id.
  * @param mixed $new_args New arguments. See {@link bbp_has_topics()}
+ * @return bool False if the view doesn't exist, otherwise if topics are there
+ *
+ * @return bool False if the view doesn't exist, otherwise if topics are there.
  */
 function bbp_view_query( $view = '', $new_args = '' ) {
 …
 /**
  * Return the query arguments of a topic-view
+ * Return the query arguments of a topic-view.
+ *
  * @since 2.0.0 bbPress (r2789)
+ *
+ * @param string $view View name
+ * @return array Query arguments
+ * @param string $view View name.
+ *
+ * @return array Query arguments.
  */
 function bbp_get_view_query_args( $view = '' ) {
 …
 /**
  * Adds an error message to later be output in the theme
+ * Adds an error message to later be output in the theme.
+ *
  * @since 2.0.0 bbPress (r3381)
 …
  * @see WP_Error()
+ *
  * @param string $code Unique code for the error message
  * @param string $message Translated error message
  * @param string $data Any additional data passed with the error message
+ * @param string $code Unique code for the error message.
+ * @param string $message Translated error message.
+ * @param string $data Any additional data passed with the error message.
  */
 function bbp_add_error( $code = '', $message = '', $data = '' ) {
 …
 /**
  * Check if error messages exist in queue
+ * Check if error messages exist in queue.
+ *
  * @since 2.0.0 bbPress (r3381)
 …
  * @deprecated 2.6.0 bbp_make_clickable()
+ *
  * @return string Pattern to match usernames with
+ * @return string Pattern to match usernames with.
  */
 function bbp_find_mentions_pattern() {
 …
  * @deprecated 2.6.0 bbp_make_clickable()
+ *
+ * @param string $content The content
+ * @param string $content The content.
+ *
  * @return bool|array $usernames Existing usernames. False if no matches.
  */
 …
 /**
  * Finds and links @-mentioned users in the content
+ * Finds and links @-mentioned users in the content.
+ *
  * @since 2.2.0 bbPress (r4323)
  * @deprecated 2.6.0 bbp_make_clickable()
+ *
  * @return string $content Content filtered for mentions
+ * @return string $content Content filtered for mentions.
  */
 function bbp_mention_filter( $content = '' ) {
 …
 /**
  * Return the public post status ID
+ * Return the public post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the pending post status ID
+ * Return the pending post status ID.
+ *
  * @since 2.1.0 bbPress (r3581)
 …
 /**
  * Return the private post status ID
+ * Return the private post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the hidden post status ID
+ * Return the hidden post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the closed post status ID
+ * Return the closed post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the spam post status ID
+ * Return the spam post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the trash post status ID
+ * Return the trash post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the orphan post status ID
+ * Return the orphan post status ID.
+ *
  * @since 2.0.0 bbPress (r3504)
 …
 /**
  * Return the unique ID for user profile rewrite rules
+ * Return the unique ID for user profile rewrite rules.
+ *
  * @since 2.1.0 bbPress (r3762)
 …
 /**
  * Return the unique ID for all search rewrite rules
+ * Return the unique ID for all search rewrite rules.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
 /**
  * Return the unique ID for user topics rewrite rules
+ * Return the unique ID for user topics rewrite rules.
+ *
  * @since 2.2.0 bbPress (r4321)
 …
 /**
  * Return the unique ID for user replies rewrite rules
+ * Return the unique ID for user replies rewrite rules.
+ *
  * @since 2.2.0 bbPress (r4321)
 …
 /**
  * Return the unique ID for user favorites rewrite rules
+ * Return the unique ID for user favorites rewrite rules.
+ *
  * @since 2.2.0 bbPress (r4181)
 …
 /**
  * Return the unique ID for user subscriptions rewrite rules
+ * Return the unique ID for user subscriptions rewrite rules.
+ *
  * @since 2.2.0 bbPress (r4181)
 …
 /**
  * Return the unique ID for user engagement rewrite rules
+ * Return the unique ID for user engagement rewrite rules.
+ *
  * @since 2.6.0 bbPress (r6320)
 …
 /**
  * Return the unique ID for topic view rewrite rules
+ * Return the unique ID for topic view rewrite rules.
+ *
  * @since 2.1.0 bbPress (r3762)
 …
 /**
  * Get the id used for paginated requests
+ * Get the id used for paginated requests.
+ *
  * @since 2.4.0 bbPress (r4926)
 …
 /**
  * Return true|false if this is a POST request
+ * Return true|false if this is a POST request.
+ *
  * @since 2.3.0 bbPress (r4790)
 …
 /**
  * Return true|false if this is a GET request
+ * Return true|false if this is a GET request.
+ *
  * @since 2.3.0 bbPress (r4790)
 …
 /**
  * Perform a safe, local redirect somewhere inside the current site
+ * Perform a safe, local redirect somewhere inside the current site.
+ *
  * On some setups, passing the value of wp_get_referer() may result in an empty
 …
 /**
  * Return if debugging scripts or not
+ * Return if debugging scripts or not.
+ *
  * @since 2.6.7 (r7188)
 …
 /**
  * Return if auto-saving or not
+ * Return if auto-saving or not.
+ *
  * @since 2.6.7 (r7188)

trunk/src/includes/core/options.php

-                      r6967
+                      r7380
 /**
  * bbPress Options
+ * bbPress Options.
+ *
  * @package bbPress
 …
  * @since 2.0.0 bbPress (r3421)
+ *
  * @return array Filtered option names and values
+ * @return array Filtered option names and values.
  */
 function bbp_get_default_options() {
 …
 /**
  * Add default options
+ * Add default options.
+ *
  * Hooked to bbp_activate, it is only called once when bbPress is activated.
 …
 /**
  * Delete default options
+ * Delete default options.
+ *
  * Hooked to bbp_uninstall, it is only called once when bbPress is uninstalled.
 …
  * @access private
+ *
  * @param bool   $value  Default value false
  * @param string $option Name of the option
+ *
  * @return mixed false if not overloaded, mixed if set
+ * @param bool   $value  Default value false.
+ * @param string $option Name of the option.
+ *
+ * @return mixed false if not overloaded, mixed if set.
  */
 function bbp_filter_pre_get_option( $value = false, $option = '' ) {
 …
  * @access private
+ *
  * @param bool $value Optional. Default value false
  * @return mixed false if not overloaded, mixed if set
+ * @param bool $value Optional. Default value false.
+ * @return mixed false if not overloaded, mixed if set.
  */
 function bbp_filter_default_option( $default = false, $option = '', $passed_default = false ) {
 …
  * @since 2.0.0 bbPress (r2658)
+ *
  * @param bool $default Optional.Default value true
  * @return bool Is favorites enabled or not
+ * @param bool $default Optional.Default value true.
+ * @return bool Is favorites enabled or not.
  */
 function bbp_is_favorites_active( $default = 1 ) {
 …
  * @since 2.0.0 bbPress (r2658)
+ *
  * @param bool $default Optional.Default value true
  * @return bool Is subscription enabled or not
+ * @param bool $default Optional.Default value true.
+ * @return bool Is subscription enabled or not.
  */
 function bbp_is_subscriptions_active( $default = 1 ) {
 …
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param bool $default Optional.Default value true
  * @return bool Is engagements enabled or not
+ * @param bool $default Optional.Default value true.
+ * @return bool Is engagements enabled or not.
  */
 function bbp_is_engagements_active( $default = 1 ) {
 …
  * @since 2.6.0 bbPress (r6441)
+ *
  * @param bool $default Optional. Default value false
+ * @param bool $default Optional. Default value false.
  * @return bool Is content editing allowed?
  */
 …
  * @since 2.6.0 bbPress (r6441)
+ *
  * @param bool $default Optional. Default value false
+ * @param bool $default Optional. Default value false.
  * @return bool Is content throttling allowed?
  */
 …
 /**
  * Are topic tags allowed
+ * Are topic tags allowed.
+ *
  * @since 2.2.0 bbPress (r4097)
+ *
  * @param bool $default Optional. Default value true
+ * @param bool $default Optional. Default value true.
  * @return bool Are tags allowed?
  */
 …
 /**
  * Are per-forum moderators allowed
+ * Are per-forum moderators allowed.
+ *
  * @since 2.6.0 bbPress (r5834)
 …
 /**
  * Are moderators allowed to edit users
+ * Are moderators allowed to edit users.
+ *
  * @since 2.6.0 bbPress (r6562)
 …
 /**
  * Is forum-wide searching allowed
+ * Is forum-wide searching allowed.
+ *
  * @since 2.4.0 bbPress (r4970)
+ *
  * @param bool $default Optional. Default value true
+ * @param bool $default Optional. Default value true.
  * @return bool Is forum-wide searching allowed?
  */
 …
 /**
  * Are threaded replies allowed
+ * Are threaded replies allowed.
+ *
  * @since 2.4.0 bbPress (r4964)
+ *
  * @param bool $default Optional. Default value false
+ * @param bool $default Optional. Default value false.
  * @return bool Are threaded replies allowed?
  */
 …
 /**
  * Maximum reply thread depth
+ * Maximum reply thread depth.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param int $default Thread replies depth
  * @return int Thread replies depth
+ * @param int $default Thread replies depth.
+ * @return int Thread replies depth.
  */
 function bbp_thread_replies_depth( $default = 2 ) {
 …
 /**
  * Are topic and reply revisions allowed
+ * Are topic and reply revisions allowed.
+ *
  * @since 2.0.0 bbPress (r3412)
+ *
  * @param bool $default Optional. Default value true
+ * @param bool $default Optional. Default value true.
  * @return bool Are revisions allowed?
  */
 …
  * @since 2.0.0 bbPress (r2659)
+ *
  * @param bool $default Optional. Default value
+ * @param bool $default Optional. Default value.
  * @return bool Is anonymous posting allowed?
  */
 …
  * @since 2.0.0 bbPress (r3378)
+ *
  * @param bool $default Optional. Default value false
+ * @param bool $default Optional. Default value false.
  * @return bool Is global access allowed?
  */
 …
 /**
  * Get the default forums role (issued to users on their first visit to the
  * forums) by bbp_set_current_user_default_role() and repair tools
+ * forums) by bbp_set_current_user_default_role() and repair tools.
+ *
  * @since 2.2.0 bbPress (r4294)
+ *
  * @param string $default Optional. Default value empty
  * @return string The default forums user role
+ * @param string $default Optional. Default value empty.
+ * @return string The default forums user role.
  */
 function bbp_get_default_role( $default = 'bbp_participant' ) {
 …
 /**
  * Use the WordPress editor if available
+ * Use the WordPress editor if available.
+ *
  * @since 2.0.0 bbPress (r3386)
+ *
  * @param bool $default Optional. Default value true
+ * @param bool $default Optional. Default value true.
  * @return bool Use WP editor?
  */
 …
 /**
  * Use WordPress's oEmbed API
+ * Use WordPress's oEmbed API.
+ *
  * @since 2.1.0 bbPress (r3752)
+ *
  * @param bool $default Optional. Default value true
+ * @param bool $default Optional. Default value true.
  * @return bool Use oEmbed?
  */
 …
 /**
  * Get the current theme package ID
+ * Get the current theme package ID.
+ *
  * @since 2.1.0 bbPress (r3829)
+ *
  * @param string $default Optional. Default value 'default'
  * @return string ID of the theme-package
+ * @param string $default Optional. Default value 'default'.
+ * @return string ID of the theme-package.
  */
 function bbp_get_theme_package_id( $default = 'default' ) {
 …
 /**
  * Output the maximum length of a title
+ * Output the maximum length of a title.
+ *
  * @since 2.0.0 bbPress (r3246)
+ *
  * @param bool $default Optional. Default value 80
+ * @param bool $default Optional. Default value 80.
  */
 function bbp_title_max_length( $default = 80 ) {
     echo bbp_get_title_max_length( $default );
+}
+    /**
+     * Return the maximum length of a title
+     *
+     * @since 2.0.0 bbPress (r3246)
+     *
+     * @param bool $default Optional. Default value 80
+     * @return int Is anonymous posting allowed?
+     */
+    function bbp_get_title_max_length( $default = 80 ) {
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_title_max_length', (int) get_option( '_bbp_title_max_length', $default ) );
+    }
+/**
+ * Return the maximum length of a title.
+ *
+ * @since 2.0.0 bbPress (r3246)
+ *
+ * @param bool $default Optional. Default value 80.
+ * @return int Is anonymous posting allowed?
+ */
+function bbp_get_title_max_length( $default = 80 ) {
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_title_max_length', (int) get_option( '_bbp_title_max_length', $default ) );
+}
 /**
 …
  * @since 2.6.0 bbPress (r6868)
+ *
  * @param bool $default Optional. Default value 5
+ * @param bool $default Optional. Default value 5.
  */
 function bbp_edit_lock( $default = 5 ) {
     echo bbp_get_edit_lock( $default );
+}
+    /**
+     * Return the number of minutes a topic or reply can be edited after it's
+     * published. Used by `bbp_past_edit_lock()`.
+     *
+     * @since 2.6.0 bbPress (r6868)
+     *
+     * @param bool $default Optional. Default value 5
+     * @return int Is anonymous posting allowed?
+     */
+    function bbp_get_edit_lock( $default = 5 ) {
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_edit_lock', (int) get_option( '_bbp_edit_lock', $default ) );
+    }
+/**
+ * Output the group forums root parent forum id
+/**
+ * Return the number of minutes a topic or reply can be edited after it's
+ * published. Used by `bbp_past_edit_lock()`.
+ *
+ * @since 2.6.0 bbPress (r6868)
+ *
+ * @param bool $default Optional. Default value 5.
+ * @return int Is anonymous posting allowed?
+ */
+function bbp_get_edit_lock( $default = 5 ) {
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_edit_lock', (int) get_option( '_bbp_edit_lock', $default ) );
+}
+/**
+ * Output the group forums root parent forum id.
+ *
  * @since 2.1.0 bbPress (r3575)
+ *
  * @param int $default Optional. Default value
+ * @param int $default Optional. Default value.
  */
 function bbp_group_forums_root_id( $default = 0 ) {
     echo bbp_get_group_forums_root_id( $default );
+}
+    /**
+     * Return the group forums root parent forum id
+     *
+     * @since 2.1.0 bbPress (r3575)
+     *
+     * @param bool $default Optional. Default value 0
+     * @return int The post ID for the root forum
+     */
+    function bbp_get_group_forums_root_id( $default = 0 ) {
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_group_forums_root_id', (int) get_option( '_bbp_group_forums_root_id', $default ) );
+    }
+/**
+ * Checks if BuddyPress Group Forums are enabled
+/**
+ * Return the group forums root parent forum id.
+ *
  * @since 2.1.0 bbPress (r3575)
+ *
+ * @param bool $default Optional. Default value true
+ * @return bool Is group forums enabled or not
+ * @param bool $default Optional. Default value 0.
+ * @return int The post ID for the root forum.
+ */
+function bbp_get_group_forums_root_id( $default = 0 ) {
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_group_forums_root_id', (int) get_option( '_bbp_group_forums_root_id', $default ) );
+}
+/**
+ * Checks if BuddyPress Group Forums are enabled.
+ *
+ * @since 2.1.0 bbPress (r3575)
+ *
+ * @param bool $default Optional. Default value true.
+ * @return bool Is group forums enabled or not.
  */
 function bbp_is_group_forums_active( $default = 1 ) {
 …
 /**
  * Checks if Akismet is enabled
+ * Checks if Akismet is enabled.
+ *
  * @since 2.1.0 bbPress (r3575)
+ *
  * @param bool $default Optional. Default value true
  * @return bool Is Akismet enabled or not
+ * @param bool $default Optional. Default value true.
+ * @return bool Is Akismet enabled or not.
  */
 function bbp_is_akismet_active( $default = 1 ) {
 …
 /**
  * Integrate settings into existing WordPress pages
+ * Integrate settings into existing WordPress pages.
+ *
  * There are 3 possible modes:
 …
  * @since 2.4.0 bbPress (r4932)
+ *
  * @param bool $default Optional. Default value false
  * @return string How to integrate settings
+ * @param bool $default Optional. Default value false.
+ * @return string How to integrate settings.
  */
 function bbp_settings_integration( $default = 'basic' ) {
 …
 /**
  * How to interact with engagements
+ * How to interact with engagements.
+ *
  * There are 3 possible strategies:
 …
  * @since 2.6.0 bbPress (r6875)
+ *
  * @param bool $default Optional. Default value false
  * @return string How to interact with engagements
+ * @param bool $default Optional. Default value false.
+ * @return string How to interact with engagements.
  */
 function bbp_engagements_strategy( $default = 'meta' ) {
 …
 /**
  * Return the root slug
+ * Return the root slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'forums'
+ * @param string $default Optional. Default value 'forums'.
  * @return string
  */
 …
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param bool $default Optional. Default value true
+ * @param bool $default Optional. Default value true.
  * @return bool
  */
 …
  * @since 2.4.0 bbPress (r4932)
+ *
  * @param string $default Optional. Default value 'forums'
+ * @param string $default Optional. Default value 'forums'.
  * @return string
  */
 …
 /**
  * Maybe return the root slug, based on whether or not it's included in the url
+ * Maybe return the root slug, based on whether or not it's included in the url.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'forums'
+ * @param string $default Optional. Default value 'forums'.
  * @return string
  */
 …
 /**
  * Return the single forum slug
+ * Return the single forum slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'forum'
+ * @param string $default Optional. Default value 'forum'.
  * @return string
  */
 …
 /**
  * Return the topic archive slug
+ * Return the topic archive slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'topics'
+ * @param string $default Optional. Default value 'topics'.
  * @return string
  */
 …
 /**
  * Return the reply archive slug
+ * Return the reply archive slug.
+ *
  * @since 2.4.0 bbPress (r4925)
+ *
  * @param string $default Optional. Default value 'replies'
+ * @param string $default Optional. Default value 'replies'.
  * @return string
  */
 …
 /**
  * Return the single topic slug
+ * Return the single topic slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'topic'
+ * @param string $default Optional. Default value 'topic'.
  * @return string
  */
 …
 /**
  * Return the topic-tag taxonomy slug
+ * Return the topic-tag taxonomy slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'topic-tag'
+ * @param string $default Optional. Default value 'topic-tag'.
  * @return string
  */
 …
 /**
  * Return the single reply slug (used mostly for editing)
+ * Return the single reply slug (used mostly for editing).
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'reply'
+ * @param string $default Optional. Default value 'reply'.
  * @return string
  */
 …
 /**
  * Return the single user slug
+ * Return the single user slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'users'
+ * @param string $default Optional. Default value 'users'.
  * @return string
  */
 …
 /**
  * Return the single user favorites slug
+ * Return the single user favorites slug.
+ *
  * @since 2.2.0 bbPress (r4187)
+ *
  * @param string $default Optional. Default value 'favorites'
+ * @param string $default Optional. Default value 'favorites'.
  * @return string
  */
 …
 /**
  * Return the single user subscriptions slug
+ * Return the single user subscriptions slug.
+ *
  * @since 2.2.0 bbPress (r4187)
+ *
  * @param string $default Optional. Default value 'subscriptions'
+ * @param string $default Optional. Default value 'subscriptions'.
  * @return string
  */
 …
 /**
  * Return the single user engagements slug
+ * Return the single user engagements slug.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param string $default Optional. Default value 'engagements'
+ * @param string $default Optional. Default value 'engagements'.
  * @return string
  */
 …
 /**
  * Return the topic view slug
+ * Return the topic view slug.
+ *
  * @since 2.1.0 bbPress (r3759)
+ *
  * @param string $default Optional. Default value 'view'
+ * @param string $default Optional. Default value 'view'.
  * @return string
  */
 …
 /**
  * Return the search slug
+ * Return the search slug.
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @param string $default Optional. Default value 'search'
+ * @param string $default Optional. Default value 'search'.
  * @return string
  */
 …
 /**
  * Return the edit slug
+ * Return the edit slug.
+ *
  * @since 2.6.2 bbPress (r6965)
+ *
  * @param string $default Optional. Default value 'edit'
+ * @param string $default Optional. Default value 'edit'.
  * @return string
  */
 …
 /**
  * Checks if there is a previous BuddyPress Forum configuration
+ * Checks if there is a previous BuddyPress Forum configuration.
+ *
  * @since 2.1.0 bbPress (r3790)
+ *
  * @param string $default Optional. Default empty string
  * @return string The location of the bb-config.php file, if any
+ * @param string $default Optional. Default empty string.
+ * @return string The location of the bb-config.php file, if any.
  */
 function bbp_get_config_location( $default = '' ) {

trunk/src/includes/core/sub-actions.php

-                      r7348
+                      r7380
 /**
  * Plugin Dependency
+ * Plugin Dependency.
+ *
  * The purpose of the following hooks is to mimic the behavior of something
 …
 /**
  * Runs on bbPress activation
+ * Runs on bbPress activation.
+ *
  * @since 2.0.0 bbPress (r2509)
 …
 /**
  * Runs on bbPress deactivation
+ * Runs on bbPress deactivation.
+ *
  * @since 2.0.0 bbPress (r2509)
 …
 /**
  * Runs when uninstalling bbPress
+ * Runs when uninstalling bbPress.
+ *
  * @since 2.0.0 bbPress (r2509)
 …
 /**
  * Main action responsible for constants, globals, and includes
+ * Main action responsible for constants, globals, and includes.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Setup constants
+ * Setup constants.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Setup globals BEFORE includes
+ * Setup globals BEFORE includes.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Include files
+ * Include files.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Setup globals AFTER includes
+ * Setup globals AFTER includes.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Register any objects before anything is initialized
+ * Register any objects before anything is initialized.
+ *
  * @since 2.2.0 bbPress (r4180)
 …
 /**
  * Initialize any code after everything has been loaded
+ * Initialize any code after everything has been loaded.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Initialize roles
+ * Initialize roles.
+ *
  * @since 2.6.0 bbPress (r6106)
+ *
  * @param WP_Roles $wp_roles The array of WP_Role objects that was initialized
+ * @param WP_Roles $wp_roles The array of WP_Role objects that was initialized.
  */
 function bbp_roles_init( $wp_roles ) {
 …
 /**
  * Initialize widgets
+ * Initialize widgets.
+ *
  * @since 2.0.0 bbPress (r3389)
 …
 /**
  * Setup the currently logged-in user
+ * Setup the currently logged-in user.
+ *
  * @link https://bbpress.trac.wordpress.org/ticket/2309
 …
 /**
  * Setup the user engagements strategy
+ * Setup the user engagements strategy.
+ *
  * @since 2.6.0 bbPress (r6875)
 …
 /**
  * Load translations for current language
+ * Load translations for current language.
+ *
  * @since 2.0.0 bbPress (r2599)
 …
 /**
  * Setup the post types
+ * Setup the post types.
+ *
  * @since 2.0.0 bbPress (r2464)
 …
 /**
  * Setup the post statuses
+ * Setup the post statuses.
+ *
  * @since 2.0.0 bbPress (r2727)
 …
 /**
  * Register the built in bbPress taxonomies
+ * Register the built in bbPress taxonomies.
+ *
  * @since 2.0.0 bbPress (r2464)
 …
 /**
  * Register the default bbPress views
+ * Register the default bbPress views.
+ *
  * @since 2.0.0 bbPress (r2789)
 …
 /**
  * Register the default bbPress shortcodes
+ * Register the default bbPress shortcodes.
+ *
  * @since 2.2.0 bbPress (r4211)
 …
 /**
  * Register the default bbPress meta-data
+ * Register the default bbPress meta-data.
+ *
  * @since 2.6.0 bbPress (r46300)
 …
 /**
  * Enqueue bbPress specific CSS and JS
+ * Enqueue bbPress specific CSS and JS.
+ *
  * @since 2.0.0 bbPress (r3373)
 …
 /**
  * Add the bbPress-specific rewrite tags
+ * Add the bbPress-specific rewrite tags.
+ *
  * @since 2.0.0 bbPress (r2753)
 …
 /**
  * Add the bbPress-specific rewrite rules
+ * Add the bbPress-specific rewrite rules.
+ *
  * @since 2.4.0 bbPress (r4918)
 …
 /**
  * Add the bbPress-specific permalink structures
+ * Add the bbPress-specific permalink structures.
+ *
  * @since 2.4.0 bbPress (r4918)
 …
 /**
  * Add the bbPress-specific post status transition action
+ * Add the bbPress-specific post status transition action.
+ *
  * @since 2.6.0 bbPress (r6792)
+ *
  * @param string  $new_status New post status
  * @param string  $old_status Old post status
  * @param WP_Post $post       Post object
+ * @param string  $new_status New post status.
+ * @param string  $old_status Old post status.
+ * @param WP_Post $post       Post object.
  */
 function bbp_transition_post_status( $new_status = '', $old_status = '', $post = false ) {
 …
 /**
  * The main action for hooking into when a user account is updated
+ * The main action for hooking into when a user account is updated.
+ *
  * @since 2.2.0 bbPress (r4304)
+ *
  * @param int $user_id ID of user being edited
+ * @param int $user_id ID of user being edited.
  * @param array $old_user_data The old, unmodified user data
  */
 …
 /**
  * The main action for hooking into a user being registered
+ * The main action for hooking into a user being registered.
+ *
  * @since 2.2.0 bbPress (r4304)
+ *
  * @param int $user_id ID of user being edited
+ * @param int $user_id ID of user being edited.
  */
 function bbp_user_register( $user_id = 0 ) {
 …
 /**
  * bbPress has loaded and initialized everything, and is okay to go
+ * bbPress has loaded and initialized everything, and is okay to go.
+ *
  * @since 2.0.0 bbPress (r2618)
 …
 /**
  * The main action used for redirecting bbPress theme actions that are not
  * permitted by the current_user
+ * permitted by the current_user.
+ *
  * @since 2.1.0 bbPress (r3605)
 …
 /**
  * The main action used for executing code before the theme has been setup
+ * The main action used for executing code before the theme has been setup.
+ *
  * @since 2.1.0 bbPress (r3829)
 …
 /**
  * The main action used for executing code before the theme has been setup
+ * The main action used for executing code before the theme has been setup.
+ *
  * @since 2.1.0 bbPress (r3732)
 …
 /**
  * The main action used for executing code after the theme has been setup
+ * The main action used for executing code after the theme has been setup.
+ *
  * @since 2.1.0 bbPress (r3732)
 …
 /**
  * The main action used for handling theme-side POST requests
+ * The main action used for handling theme-side POST requests.
+ *
  * @since 2.3.0 bbPress (r4550)
 …
 /**
  * The main action used for handling theme-side GET requests
+ * The main action used for handling theme-side GET requests.
+ *
  * @since 2.3.0 bbPress (r4550)
 …
 /**
  * Piggy back filter for WordPress's 'request' filter
+ * Piggy back filter for WordPress's 'request' filter.
+ *
  * @since 2.1.0 bbPress (r3758)
 …
+ *
  * @param string $template
  * @return string Template file to use
+ * @return string Template file to use.
  */
 function bbp_template_include( $template = '' ) {
 …
 /**
  * Generate bbPress-specific rewrite rules
+ * Generate bbPress-specific rewrite rules.
+ *
  * @since 2.0.0 bbPress (r2688)
 …
 /**
  * Filter the allowed themes list for bbPress specific themes
+ * Filter the allowed themes list for bbPress specific themes.
+ *
  * @since 2.0.0 bbPress (r2944)
 …
  * @param array $themes
+ *
  * @return array Array of allowed themes
+ * @return array Array of allowed themes.
  */
 function bbp_allowed_themes( $themes ) {
 …
 /**
  * Maps forum/topic/reply caps to built in WordPress caps
+ * Maps forum/topic/reply caps to built in WordPress caps.
+ *
  * @since 2.0.0 bbPress (r2593)
+ *
  * @param array $caps Capabilities for meta capability
  * @param string $cap Capability name
  * @param int $user_id User id
  * @param array $args Arguments
+ *
  * @return array Array of capabilities
+ * @param array $caps Capabilities for meta capability.
+ * @param string $cap Capability name.
+ * @param int $user_id User id.
+ * @param array $args Arguments.
+ *
+ * @return array Array of capabilities.
  */
 function bbp_map_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {
 …
 /**
  * Filter the arguments used by wp_mail for bbPress specific emails
+ * Filter the arguments used by wp_mail for bbPress specific emails.
+ *
  * @since 2.6.0 bbPress (r6918)
 …
  *                    subject, message, headers, and attachments values.
+ *
  * @return array Array of capabilities
+ * @return array Array of capabilities.
  */
 function bbp_mail( $args = array() ) {

trunk/src/includes/core/template-functions.php

-                      r7378
+                      r7380
 /**
  * bbPress Template Functions
+ * bbPress Template Functions.
+ *
  * This file contains functions necessary to mirror the WordPress core template
 …
 /**
  * Adds bbPress theme support to any active WordPress theme
+ * Adds bbPress theme support to any active WordPress theme.
+ *
  * @since 2.0.0 bbPress (r3032)
+ *
  * @param string $slug
  * @param string $name Optional. Default null
+ * @param string $name Optional. Default null.
  * @return string The template filename if one is located.
  */
 …
 /**
  * Convert an enqueueable file path to a URL
+ * Convert an enqueueable file path to a URL.
+ *
  * @since 2.6.0
 …
  * @since 2.3.0 bbPress (r4652)
+ *
  * @param string $location_callback Callback function that returns the
+ * @param string $location_callback Callback function that returns the.
  * @param int $priority
  * @return bool Whether stack was removed
+ * @return bool Whether stack was removed.
  */
 function bbp_deregister_template_stack( $location_callback = '', $priority = 10 ) {
 …
  * @since 2.6.0 bbPress (r5944) Added support for `WP_Hook`
+ *
  * @global array $wp_filter Stores all of the filters
+ * @global array $wp_filter Stores all of the filters.
  * @global array $merged_filters Merges the filter hooks using this function.
  * @global array $wp_current_filter stores the list of current filters with the current one last
+ * @global array $wp_current_filter stores the list of current filters with the current one last.
+ *
  * @return array The filtered value after all hooked functions are applied to it.
 …
 /**
  * Get a template part in an output buffer, and return it
+ * Get a template part in an output buffer, and return it.
+ *
  * @since 2.4.0 bbPress (r5043)
 …
 /**
  * Retrieve path to a template
+ * Retrieve path to a template.
+ *
  * Used to quickly retrieve the path of a template without including the file
 …
+ *
  * @param string $type Filename without extension.
  * @param array $templates An optional list of template candidates
+ * @param array $templates An optional list of template candidates.
  * @return string Full path to file.
  */
 …
 /**
  * Get the possible subdirectories to check for templates in
+ * Get the possible subdirectories to check for templates in.
+ *
  * @since 2.1.0 bbPress (r3738)
+ *
  * @param array $templates Templates we are looking for
  * @return array Possible subdirectories to look in
+ * @param array $templates Templates we are looking for.
+ * @return array Possible subdirectories to look in.
  */
 function bbp_get_template_locations( $templates = array() ) {
 …
 /**
  * Add template locations to template files being searched for
+ * Add template locations to template files being searched for.
+ *
  * @since 2.1.0 bbPress (r3738)
 …
 /**
  * Add checks for bbPress conditions to parse_query action
+ * Add checks for bbPress conditions to parse_query action.
+ *
  * If it's a user page, WP_Query::bbp_is_single_user is set to true.
 …
  * If it's a reply edit, WP_Query::bbp_is_reply_edit is set to true.
+ *
  * If it's a view page, WP_Query::bbp_is_view is set to true
  * If it's a search page, WP_Query::bbp_is_search is set to true
+ * If it's a view page, WP_Query::bbp_is_view is set to true.
+ * If it's a search page, WP_Query::bbp_is_search is set to true.
+ *
  * @since 2.0.0 bbPress (r2688)

trunk/src/includes/core/template-loader.php

-                      r7379
+                      r7380
 /**
  * bbPress Template Loader
+ * bbPress Template Loader.
+ *
  * @package bbPress
 …
 /**
  * Possibly intercept the template being loaded
+ * Possibly intercept the template being loaded.
+ *
  * Listens to the 'template_include' filter and waits for any bbPress specific
  * template condition to be met. If one is met and the template file exists,
  * it will be used; otherwise
+ * it will be used; otherwise.
+ *
  * Note that the _edit() checks are ahead of their counterparts, to prevent them
 …
  * @param string $template
+ *
  * @return string The path to the template file that is being used
+ * @return string The path to the template file that is being used.
  */
 function bbp_template_include_theme_supports( $template = '' ) {
 …
 /**
  * Set the included template
+ * Set the included template.
+ *
  * @since 2.4.0 bbPress (r4975)
+ *
  * @param mixed $template Default false
  * @return mixed False if empty. Template name if template included
+ * @param mixed $template Default false.
+ * @return mixed False if empty. Template name if template included.
  */
 function bbp_set_template_included( $template = false ) {
 …
  * @since 2.4.0 bbPress (r4975)
+ *
  * @return bool True if yes, false if no
+ * @return bool True if yes, false if no.
  */
 function bbp_is_template_included() {
 …
 /**
  * Get the user profile template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the user profile template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_single_user_template() {
 …
 /**
  * Get the user profile edit template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the user profile edit template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_single_user_edit_template() {
 …
 /**
  * Get the user favorites template
+ * Get the user favorites template.
+ *
  * @since 2.2.0 bbPress (r4225)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_favorites_template() {
 …
 /**
  * Get the user subscriptions template
+ * Get the user subscriptions template.
+ *
  * @since 2.2.0 bbPress (r4225)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_subscriptions_template() {
 …
 /**
  * Get the view template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the view template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_single_view_template() {
 …
 /**
  * Get the search template
+ * Get the search template.
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_search_template() {
 …
 /**
  * Get the single forum template
+ * Get the single forum template.
+ *
  * @since 2.1.0 bbPress (r3922)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_single_forum_template() {
 …
 /**
  * Get the forum archive template
+ * Get the forum archive template.
+ *
  * @since 2.1.0 bbPress (r3922)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_forum_archive_template() {
 …
 /**
  * Get the forum edit template
+ * Get the forum edit template.
+ *
  * @since 2.1.0 bbPress (r3566)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_forum_edit_template() {
 …
 /**
  * Get the single topic template
+ * Get the single topic template.
+ *
  * @since 2.1.0 bbPress (r3922)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_single_topic_template() {
 …
 /**
  * Get the topic archive template
+ * Get the topic archive template.
+ *
  * @since 2.1.0 bbPress (r3922)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_topic_archive_template() {
 …
 /**
  * Get the topic edit template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the topic edit template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_topic_edit_template() {
 …
 /**
  * Get the topic split template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the topic split template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_topic_split_template() {
 …
 /**
  * Get the topic merge template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the topic merge template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_topic_merge_template() {
 …
 /**
  * Get the single reply template
+ * Get the single reply template.
+ *
  * @since 2.1.0 bbPress (r3922)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_single_reply_template() {
 …
 /**
  * Get the reply edit template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
 * @return string Path to template file
+ * Get the reply edit template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+* @return string Path to template file.
  */
 function bbp_get_reply_edit_template() {
 …
 /**
  * Get the reply move template
+ * Get the reply move template.
+ *
  * @since 2.3.0 bbPress (r4521)
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_reply_move_template() {
 …
 /**
  * Get the topic template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the topic template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_topic_tag_template() {
 …
 /**
  * Get the topic edit template
+ *
  * @since 2.0.0 bbPress (r3311)
+ *
  * @return string Path to template file
+ * Get the topic edit template.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ *
+ * @return string Path to template file.
  */
 function bbp_get_topic_tag_edit_template() {
 …
 /**
  * Get the templates to use as the endpoint for bbPress template parts
+ * Get the templates to use as the endpoint for bbPress template parts.
+ *
  * @since 2.0.0 bbPress (r3311)
  * @since 2.6.0 bbPress (r5950) Added `singular.php` to template stack
+ *
  * @return string Path to template file
+ * @return string Path to template file.
  */
 function bbp_get_theme_compat_templates() {

trunk/src/includes/core/theme-compat.php

-                      r7378
+                      r7380
 /**
  * bbPress Theme Compatibility
+ * bbPress Theme Compatibility.
+ *
  * @package bbPress
 …
 /**
  * Theme Compatibility base class
+ * Theme Compatibility base class.
+ *
  * This is only intended to be extended, and is included here as a basic guide
  * for future Template Packs to use. @link bbp_setup_theme_compat()
+ * for future Template Packs to use. @link bbp_setup_theme_compat().
+ *
  * @since 2.0.0 bbPress (r3506)
 …
 /**
  * Gets true/false if page is currently inside theme compatibility
+ * Gets true/false if page is currently inside theme compatibility.
+ *
  * @since 2.0.0 bbPress (r3265)
 …
 /**
  * Sets true/false if page is currently inside theme compatibility
+ * Sets true/false if page is currently inside theme compatibility.
+ *
  * @since 2.0.0 bbPress (r3265)
 …
 /**
  * Set the theme compat templates global
+ * Set the theme compat templates global.
+ *
  * Stash possible template files for the current query. Useful if plugins want
 …
 /**
  * Set the theme compat template global
+ * Set the theme compat template global.
+ *
  * Stash the template file for the current query. Useful if plugins want
 …
 /**
  * Set the theme compat original_template global
+ * Set the theme compat original_template global.
+ *
  * Stash the original template file for the current query. Useful for checking
 …
 /**
  * Is a template the original_template global
+ * Is a template the original_template global.
+ *
  * Stash the original template file for the current query. Useful for checking
 …
 /**
  * Register a new bbPress theme package to the active theme packages array
+ * Register a new bbPress theme package to the active theme packages array.
+ *
  * @since 2.1.0 bbPress (r3829)
 …
+    }
     /** Users *************************************************************/
+    /** Users *****************************************************************/
     if ( bbp_is_single_user_edit() || bbp_is_single_user() ) {
 …
         );
     /** Forums ************************************************************/
+    /** Forums ****************************************************************/
     // Forum archive
 …
         );
     /** Topics ************************************************************/
+    /** Topics ****************************************************************/
     // Topic archive
 …
         );
     /** Replies ***********************************************************/
+    /** Replies ***************************************************************/
     // Reply archive
 …
         );
     /** Views *************************************************************/
+    /** Views *****************************************************************/
     } elseif ( bbp_is_single_view() ) {
 …
         );
     /** Search ************************************************************/
+    /** Search ****************************************************************/
     } elseif ( bbp_is_search() ) {
 …
         );
     /** Topic Tags ********************************************************/
+    /** Topic Tags ************************************************************/
     // Topic Tag Edit
 …
 /**
  * Restores filters from the $bbp global that were removed using
  * bbp_remove_all_filters()
+ * bbp_remove_all_filters().
+ *
  * @since 2.0.0 bbPress (r3251)
 …
 /**
  * Force comments_status to 'closed' for bbPress post types
+ * Force comments_status to 'closed' for bbPress post types.
+ *
  * @since 2.1.0 bbPress (r3589)

trunk/src/includes/core/update.php

-                      r7378
+                      r7380
 /**
  * bbPress Updater
+ * bbPress Updater.
+ *
  * @package bbPress
 …
 /**
  * If there is no raw DB version, this is the first installation
+ * If there is no raw DB version, this is the first installation.
+ *
  * @since 2.1.0 bbPress (r3764)
+ *
  * @return bool True if update, False if not
+ * @return bool True if update, False if not.
  */
 function bbp_is_install() {
 …
 /**
  * Compare the bbPress version to the DB version to determine if updating
+ * Compare the bbPress version to the DB version to determine if updating.
+ *
  * @since 2.0.0 bbPress (r3421)
+ *
  * @return bool True if update, False if not
+ * @return bool True if update, False if not.
  */
 function bbp_is_update() {
 …
 /**
  * Determine if bbPress is being activated
+ * Determine if bbPress is being activated.
+ *
  * Note that this function currently is not used in bbPress core and is here
 …
  * @global string $pagenow The filename of the current screen.
+ *
+ * @return bool True if activating bbPress, false if not
+ * @param string $basename Plugin base name.
+ *
+ * @return bool True if activating bbPress, false if not.
  */
 function bbp_is_activation( $basename = '' ) {
 …
 /**
  * Determine if bbPress is being deactivated
+ * Determine if bbPress is being deactivated.
+ *
  * @since 2.0.0 bbPress (r3421)
 …
  * @global string $pagenow The filename of the current screen.
+ *
+ * @return bool True if deactivating bbPress, false if not
+ * @param string $basename Plugin base name.
+ *
+ * @return bool True if deactivating bbPress, false if not.
  */
 function bbp_is_deactivation( $basename = '' ) {
 …
 /**
  * Update the DB to the latest version
+ * Update the DB to the latest version.
+ *
  * @since 2.0.0 bbPress (r3421)
 …
 /**
  * Setup the bbPress updater
+ * Setup the bbPress updater.
+ *
  * @since 2.0.0 bbPress (r3419)
 …
 /**
  * Runs when a new site is created in a multisite network, and bbPress is active
  * on that site (hooked to `bbp_new_site`)
+ * on that site (hooked to `bbp_new_site`).
+ *
  * @since 2.6.0 bbPress (r6779)
+ *
+ * @param int $site_id Side id.
  */
 function bbp_setup_new_site( $site_id = 0 ) {
 …
 /**
  * Create a default forum, topic, and reply
+ * Create a default forum, topic, and reply.
+ *
  * @since 2.1.0 bbPress (r3767)
+ *
  * @param array $args Array of arguments to override default values
+ * @param array $args Array of arguments to override default values.
  */
 function bbp_create_initial_content( $args = array() ) {
 …
 /**
  * Redirect user to the "What's New" page on activation
+ * Redirect user to the "What's New" page on activation.
+ *
  * @since 2.2.0 bbPress (r4389)
+ *
  * @internal Used internally to redirect bbPress to the about page on activation
+ *
  * @return If network admin or bulk activation
+ * @internal Used internally to redirect bbPress to the about page on activation.
+ *
+ * @return If network admin or bulk activation.
  */
 function bbp_add_activation_redirect() {
 …
 /**
  * Redirect user to "What's New" page on activation
+ * Redirect user to "What's New" page on activation.
+ *
  * @since 2.2.0 bbPress (r4389)
+ *
  * @internal Used internally to redirect bbPress to the about page on activation
+ *
  * @return If no transient, or in network admin, or is bulk activation
+ * @internal Used internally to redirect bbPress to the about page on activation.
+ *
+ * @return If no transient, or in network admin, or is bulk activation.
  */
 function bbp_do_activation_redirect() {
 …
  * @since 2.4.0 bbPress (r4910)
+ *
  * @internal Used to internally make the current user a keymaster on activation
+ *
  * @return If user can't activate plugins or is already a keymaster
+ * @internal Used to internally make the current user a keymaster on activation.
+ *
+ * @return If user can't activate plugins or is already a keymaster.
  */
 function bbp_make_current_user_keymaster() {
 …
 /**
  * Return the number of pending upgrades
+ * Return the number of pending upgrades.
+ *
  * @since 2.6.0 bbPress (r6895)
+ *
  * @param string $type Type of pending upgrades (upgrade|repair|empty)
+ * @param string $type Type of pending upgrades (upgrade|repair|empty).
+ *
  * @return int
 …
 /**
  * Return an array of pending upgrades
+ * Return an array of pending upgrades.
+ *
  * @since 2.6.0 bbPress (r6895)
+ *
  * @param string $type Type of pending upgrades (upgrade|repair|empty)
+ * @param string $type Type of pending upgrades (upgrade|repair|empty).
+ *
  * @return array
 …
 /**
  * Add an upgrade ID to pending upgrades array
+ * Add an upgrade ID to pending upgrades array.
+ *
  * @since 2.6.0 bbPress (r6895)
 …
 /**
  * Add an upgrade ID to pending upgrades array
+ * Add an upgrade ID to pending upgrades array.
+ *
  * @since 2.6.0 bbPress (r6895)
 …
 /**
  * Delete all pending upgrades
+ * Delete all pending upgrades.
+ *
  * @since 2.6.0 bbPress (r6895)
 …
 /**
  * Maybe append an upgrade count to a string
+ * Maybe append an upgrade count to a string.
+ *
  * @since 2.6.0 bbPress (r6896)
+ *
  * @param string $text Text to append count to
  * @param string $type Type of pending upgrades (upgrade|repair|empty)
+ * @param string $text Text to append count to.
+ * @param string $type Type of pending upgrades (upgrade|repair|empty).
+ *
  * @return string

trunk/src/includes/extend/akismet.php

-                      r7379
+                      r7380
 /**
  * Main bbPress Akismet Class
+ * Main bbPress Akismet Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Akismet' ) ) :
 /**
  * Loads Akismet extension
+ * Loads Akismet extension.
+ *
  * @since 2.0.0 bbPress (r3277)
 …
     /**
      * The main bbPress Akismet loader
+     * The main bbPress Akismet loader.
+     *
      * @since 2.0.0 bbPress (r3277)
 …
     /**
      * Setup the admin hooks
+     * Setup the admin hooks.
+     *
      * @since 2.0.0 bbPress (r3277)
 …
     /**
      * Converts topic/reply data into Akismet comment checking format
+     * Converts topic/reply data into Akismet comment checking format.
+     *
      * @since 2.0.0 bbPress (r3277)
 …
      * @param array $post_data
+     *
      * @return array Array of post data
+     * @return array Array of post data.
      */
     public function check_post( $post_data = array() ) {
 …
     /**
      * Submit a post for spamming or hamming
+     * Submit a post for spamming or hamming.
+     *
      * @since 2.0.0 bbPress (r3277)
+     *
      * @param int $post_id
+     * @param int $post_id Post id.
+     *
      * @global string $akismet_api_host
 …
      * @global object $current_site
+     *
      * @return array Array of existing topic terms
+     * @return array Array of existing topic terms.
      */
     public function submit_post( $post_id = 0 ) {
 …
     /**
      * Ping Akismet service and check for spam/ham response
+     * Ping Akismet service and check for spam/ham response.
+     *
      * @since 2.0.0 bbPress (r3277)
+     *
      * @param array $post_data
      * @param string $check Accepts check|submit
      * @param string $spam Accepts spam|ham
+     * @param string $check Accepts check|submit.
+     * @param string $spam Accepts spam|ham.
+     *
      * @global string $akismet_api_host
      * @global string $akismet_api_port
+     *
      * @return array Array of post data
+     * @return array Array of post data.
      */
     private function maybe_spam( $post_data = array(), $check = 'check', $spam = 'spam' ) {
 …
     /**
      * Update post meta after a spam check
+     * Update post meta after a spam check.
+     *
      * @since 2.0.0 bbPress (r3308)
+     *
      * @param int $post_id
+     * @param int $post_id Post id.
      * @param object $_post
+     *
 …
     /**
      * Update Akismet history of a Post
+     * Update Akismet history of a Post.
+     *
      * @since 2.0.0 bbPress (r3308)
 …
     /**
      * Get the Akismet history of a Post
+     * Get the Akismet history of a Post.
+     *
      * @since 2.0.0 bbPress (r3308)
 …
      * @param int $post_id
+     *
      * @return array Array of Akismet history
+     * @return array Array of Akismet history.
      */
     public function get_post_history( $post_id = 0 ) {
 …
     /**
      * Handle any terms submitted with a post flagged as spam
+     * Handle any terms submitted with a post flagged as spam.
+     *
      * @since 2.0.0 bbPress (r3308)
+     *
      * @param string $terms Comma-separated list of terms
+     * @param string $terms Comma-separated list of terms.
      * @param int $topic_id
      * @param int $reply_id
+     *
      * @return array Array of existing topic terms
+     * @return array Array of existing topic terms.
      */
     public function filter_post_terms( $terms = '', $topic_id = 0, $reply_id = 0 ) {
 …
     /**
      * Submit data to Akismet service with unique bbPress User Agent
+     * Submit data to Akismet service with unique bbPress User Agent.
+     *
      * This code is directly taken from the akismet_http_post() function and
 …
      * @since 2.0.0 bbPress (r3466)
+     *
      * @param string $request The request we are sending
      * @param string $host The host to send our request to
      * @param string $path The path from the host
      * @param string $port The port to use
      * @param string $ip Optional Override $host with an IP address
      * @return mixed WP_Error on error, array on success, empty on failure
+     * @param string $request The request we are sending.
+     * @param string $host The host to send our request to.
+     * @param string $path The path from the host.
+     * @param string $port The port to use.
+     * @param string $ip Optional Override $host with an IP address.
+     * @return mixed WP_Error on error, array on success, empty on failure.
      */
     private function http_post( $request, $host, $path, $port = 80, $ip = '' ) {
 …
      * @since 2.6.7 (bbPress r7194)
+     *
      * @param string $host_and_path Scheme-less URL
      * @param array  $http_args     Array of arguments for wp_remote_post()
+     * @param string $host_and_path Scheme-less URL.
+     * @param array  $http_args     Array of arguments for wp_remote_post().
      * @return array
      */
 …
     /**
      * Return a user's roles on this site (including super_admin)
+     * Return a user's roles on this site (including super_admin).
+     *
      * @since 2.3.0 bbPress (r4812)
+     *
      * @param int $user_id
+     * @param int $user_id User id.
+     *
      * @return boolean
 …
     /**
      * Add Aksimet History meta-boxes to topics and replies
+     * Add Aksimet History meta-boxes to topics and replies.
+     *
      * @since 2.4.0 bbPress (r5049)
 …
     /**
      * Output for Akismet History meta-box
+     * Output for Akismet History meta-box.
+     *
      * @since 2.4.0 bbPress (r5049)

trunk/src/includes/extend/buddypress/activity.php

-                      r7378
+                      r7380
 /**
  * bbPress BuddyPress Activity Class
+ * bbPress BuddyPress Activity Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_BuddyPress_Activity' ) ) :
 /**
  * Loads BuddyPress Activity extension
+ * Loads BuddyPress Activity extension.
+ *
  * @since 2.0.0 bbPress (r3395)
 …
     /**
      * The name of the BuddyPress component, used in activity streams
+     * The name of the BuddyPress component, used in activity streams.
+     *
      * @var string
 …
     /**
      * Forum Create Activity Action
+     * Forum Create Activity Action.
+     *
      * @var string
 …
     /**
      * Topic Create Activity Action
+     * Topic Create Activity Action.
+     *
      * @var string
 …
     /**
      * Topic Close Activity Action
+     * Topic Close Activity Action.
+     *
      * @var string
 …
     /**
      * Topic Edit Activity Action
+     * Topic Edit Activity Action.
+     *
      * @var string
 …
     /**
      * Topic Open Activity Action
+     * Topic Open Activity Action.
+     *
      * @var string
 …
     /**
      * Reply Create Activity Action
+     * Reply Create Activity Action.
+     *
      * @var string
 …
     /**
      * Reply Edit Activity Action
+     * Reply Edit Activity Action.
+     *
      * @var string
 …
     /**
      * The bbPress BuddyPress Activity loader
+     * The bbPress BuddyPress Activity loader.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Extension variables
+     * Extension variables.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Setup the actions
+     * Setup the actions.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Setup the filters
+     * Setup the filters.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Register our activity actions with BuddyPress
+     * Register our activity actions with BuddyPress.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Wrapper for recoding bbPress actions to the BuddyPress activity stream
+     *
      * @since 2.0.0 bbPress (r3395)
+     *
      * @param  array $args Array of arguments for bp_activity_add()
+     *
      * @return int   Activity ID if successful, false if not
+     * Wrapper for recoding bbPress actions to the BuddyPress activity stream.
+     *
+     * @since 2.0.0 bbPress (r3395)
+     *
+     * @param  array $args Array of arguments for bp_activity_add().
+     *
+     * @return int   Activity ID if successful, false if not.
      */
     private function record_activity( $args = array() ) {
 …
     /**
      * Wrapper for deleting bbPress actions from BuddyPress activity stream
+     *
      * @since 2.0.0 bbPress (r3395)
+     *
      * @param  array $args Array of arguments for bp_activity_add()
+     *
      * @return int   Activity ID if successful, false if not
+     * Wrapper for deleting bbPress actions from BuddyPress activity stream.
+     *
+     * @since 2.0.0 bbPress (r3395)
+     *
+     * @param  array $args Array of arguments for bp_activity_add().
+     *
+     * @return int   Activity ID if successful, false if not.
      */
     public function delete_activity( $args = array() ) {
 …
     /**
      * Check for an existing activity stream entry for a given post_id
+     *
      * @param int $post_id ID of the topic or reply
      * @return int if an activity id is verified, false if not
+     * Check for an existing activity stream entry for a given post_id.
+     *
+     * @param int $post_id ID of the topic or reply.
+     * @return int if an activity id is verified, false if not.
      */
     private static function get_activity_id( $post_id = 0 ) {
 …
     /**
      * Maybe disable activity stream comments on select actions
+     * Maybe disable activity stream comments on select actions.
+     *
      * @since 2.0.0 bbPress (r3399)
 …
     /**
      * Maybe link directly to topics and replies in activity stream entries
+     * Maybe link directly to topics and replies in activity stream entries.
+     *
      * @since 2.0.0 bbPress (r3399)
 …
      * @param string $link
      * @param mixed $activity_object
      * @return string The link to the activity stream item
+     * @return string The link to the activity stream item.
      */
     public function activity_get_permalink( $link = '', $activity_object = false ) {
 …
     /**
      * Record an activity stream entry when a topic is created or updated
+     * Record an activity stream entry when a topic is created or updated.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
      * @param array $anonymous_data
      * @param int $topic_author_id
      * @return Bail early if topic is by anonymous user
+     * @return Bail early if topic is by anonymous user.
      */
     public function topic_create( $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $topic_author_id = 0 ) {
 …
     /**
      * Delete the activity stream entry when a topic is spammed, trashed, or deleted
+     * Delete the activity stream entry when a topic is spammed, trashed, or deleted.
+     *
      * @param int $topic_id
 …
     /**
      * Update the activity stream entry when a topic status changes
+     * Update the activity stream entry when a topic status changes.
+     *
      * @param int $topic_id
      * @param obj $post
      * @return Bail early if not a topic, or topic is by anonymous user
+     * @return Bail early if not a topic, or topic is by anonymous user.
      */
     public function topic_update( $topic_id = 0, $post = null ) {
 …
     /**
      * Record an activity stream entry when a reply is created
+     * Record an activity stream entry when a reply is created.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
      * @param array $anonymous_data
      * @param int $topic_author_id
      * @return Bail early if topic is by anonymous user
+     * @return Bail early if topic is by anonymous user.
      */
     public function reply_create( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $reply_author_id = 0 ) {
 …
     /**
      * Delete the activity stream entry when a reply is spammed, trashed, or deleted
+     * Delete the activity stream entry when a reply is spammed, trashed, or deleted.
+     *
      * @param int $reply_id
 …
     /**
      * Update the activity stream entry when a reply status changes
+     * Update the activity stream entry when a reply status changes.
+     *
      * @param int $reply_id
      * @param obj $post
      * @return Bail early if not a reply, or reply is by anonymous user
+     * @return Bail early if not a reply, or reply is by anonymous user.
      */
     public function reply_update( $reply_id, $post ) {

trunk/src/includes/extend/buddypress/functions.php

-                      r7379
+                      r7380
 /**
  * Main bbPress BuddyPress Class
+ * Main bbPress BuddyPress Class.
+ *
  * @package bbPress
 …
 /**
  * Return component name/ID ('forums' by default)
+ * Return component name/ID ('forums' by default).
+ *
  * This is used primarily for Notifications integration.
 …
 /**
  * Filter the current bbPress user ID with the current BuddyPress user ID
+ * Filter the current bbPress user ID with the current BuddyPress user ID.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Filter the bbPress is_single_user function with BuddyPress equivalent
+ *
  * @since 2.1.0 bbPress (r3552)
+ *
  * @param bool $is Optional. Default false
  * @return bool True if viewing single user, false if not
+ * Filter the bbPress is_single_user function with BuddyPress equivalent.
+ *
+ * @since 2.1.0 bbPress (r3552)
+ *
+ * @param bool $is Optional. Default false.
+ * @return bool True if viewing single user, false if not.
  */
 function bbp_filter_is_single_user( $is = false ) {
 …
 /**
  * Filter the bbPress is_user_home function with BuddyPress equivalent
+ *
  * @since 2.1.0 bbPress (r3552)
+ *
  * @param bool $is Optional. Default false
  * @return bool True if viewing single user, false if not
+ * Filter the bbPress is_user_home function with BuddyPress equivalent.
+ *
+ * @since 2.1.0 bbPress (r3552)
+ *
+ * @param bool $is Optional. Default false.
+ * @return bool True if viewing single user, false if not.
  */
 function bbp_filter_is_user_home( $is = false ) {
 …
 /**
  * Add the topic title to the <title> if viewing a single group forum topic
+ * Add the topic title to the <title> if viewing a single group forum topic.
+ *
  * @since 2.5.0 bbPress (r5161)
+ *
  * @param string $new_title The title to filter
  * @param string $old_title (Not used)
  * @param string $sep The separator to use
  * @return string The possibly modified title
+ * @param string $new_title The title to filter.
+ * @param string $old_title (Not used).
+ * @param string $sep The separator to u.se
+ * @return string The possibly modified title.
  */
 function bbp_filter_modify_page_title( $new_title = '', $old_title = '', $sep = '' ) {
 …
 /**
  * Hook bbPress topics template into plugins template
+ * Hook bbPress topics template into plugins template.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Hook bbPress replies template into plugins template
+ * Hook bbPress replies template into plugins template.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Hook bbPress engagements template into plugins template
+ * Hook bbPress engagements template into plugins template.
+ *
  * @since 2.6.0 bbPress (r6320)
 …
 /**
  * Hook bbPress favorites template into plugins template
+ * Hook bbPress favorites template into plugins template.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Hook bbPress subscriptions template into plugins template
+ * Hook bbPress subscriptions template into plugins template.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Get the topics created template part
+ * Get the topics created template part.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Get the topics replied to template part
+ * Get the topics replied to template part.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Get the topic engagements template part
+ * Get the topic engagements template part.
+ *
  * @since 2.6.0 bbPress (r6320)
 …
 /**
  * Get the topics favorited template part
+ * Get the topics favorited template part.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Get the topics subscribed template part
+ * Get the topics subscribed template part.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
 /**
  * Clean up the group root setting if the forum is being deleted
+ * Clean up the group root setting if the forum is being deleted.
+ *
  * @since 2.6.0 bbPress (r6479)
+ *
  * @param int $forum_id The forum ID being deleted
+ * @param int $forum_id The forum ID being deleted.
  */
 function bbp_maybe_delete_group_forum_root( $forum_id = 0 ) {
 …
 /**
  * Handle the new group forum root creation
+ * Handle the new group forum root creation.
+ *
  * @since 2.6.0 bbPress (r6479)
 …
 /**
  * Get forum ID's for a group
+ * Get forum ID's for a group.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_get_group_forum_ids( $group_id = 0 ) {
 …
 /**
  * Get group ID's for a forum
+ * Get group ID's for a forum.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $forum_id
+ * @param int $forum_id Forum id.
  */
 function bbp_get_forum_group_ids( $forum_id = 0 ) {
 …
 /**
  * Get forum ID's for a group
+ * Get forum ID's for a group.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_update_group_forum_ids( $group_id = 0, $forum_ids = array() ) {
 …
 /**
  * Update group ID's for a forum
+ * Update group ID's for a forum.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $forum_id
+ * @param int $forum_id Forum id.
  */
 function bbp_update_forum_group_ids( $forum_id = 0, $group_ids = array() ) {
 …
 /**
  * Add a group to a forum
+ * Add a group to a forum.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_add_group_id_to_forum( $forum_id = 0, $group_id = 0 ) {
 …
 /**
  * Remove a forum from a group
+ * Remove a forum from a group.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_add_forum_id_to_group( $group_id = 0, $forum_id = 0 ) {
 …
 /**
  * Remove a group from a forum
+ * Remove a group from a forum.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_remove_group_id_from_forum( $forum_id = 0, $group_id = 0 ) {
 …
 /**
  * Remove a forum from a group
+ * Remove a forum from a group.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_remove_forum_id_from_group( $group_id = 0, $forum_id = 0 ) {
 …
 /**
  * Remove a group from all forums
+ * Remove a group from all forums.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $group_id
+ * @param int $group_id Group id.
  */
 function bbp_remove_group_id_from_all_forums( $group_id = 0 ) {
 …
 /**
  * Remove a forum from all groups
+ * Remove a forum from all groups.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @param int $forum_id
+ * @param int $forum_id Forum id.
  */
 function bbp_remove_forum_id_from_all_groups( $forum_id = 0 ) {
 …
 /**
  * Return true if a forum is a group forum
+ * Return true if a forum is a group forum.
+ *
  * @since 2.3.0 bbPress (r4571)
+ *
  * @param int $forum_id
  * @return bool True if it is a group forum, false if not
+ * @param int $forum_id Forum id.
+ * @return bool True if it is a group forum, false if not.
  */
 function bbp_is_forum_group_forum( $forum_id = 0 ) {
 …
 /**
  * Is the current user an admin of the current group
+ * Is the current user an admin of the current group.
+ *
  * @since 2.3.0 bbPress (r4632)
+ *
  * @return bool If current user is an admin of the current group
+ * @return bool If current user is an admin of the current group.
  */
 function bbp_group_is_admin() {
 …
 /**
  * Is the current user a moderator of the current group
+ * Is the current user a moderator of the current group.
+ *
  * @since 2.3.0 bbPress (r4632)
+ *
  * @return bool If current user is a moderator of the current group
+ * @return bool If current user is a moderator of the current group.
  */
 function bbp_group_is_mod() {
 …
 /**
  * Is the current user a member of the current group
+ * Is the current user a member of the current group.
+ *
  * @since 2.3.0 bbPress (r4632)
+ *
  * @return bool If current user is a member of the current group
+ * @return bool If current user is a member of the current group.
  */
 function bbp_group_is_member() {
 …
 /**
  * Is the current user banned from the current group
+ * Is the current user banned from the current group.
+ *
  * @since 2.3.0 bbPress (r4632)
+ *
  * @return bool If current user is banned from the current group
+ * @return bool If current user is banned from the current group.
  */
 function bbp_group_is_banned() {
 …
 /**
  * Is the current user the creator of the current group
+ * Is the current user the creator of the current group.
+ *
  * @since 2.3.0 bbPress (r4632)
+ *
  * @return bool If current user the creator of the current group
+ * @return bool If current user the creator of the current group.
  */
 function bbp_group_is_creator() {
 …
 /**
  * Return an array of allowed activity actions
+ * Return an array of allowed activity actions.
+ *
  * @since 2.6.0 bbPress (r6370)
 …
      * @since 2.6.0 bbPress (r6370)
+     *
      * @param string               $activity_action Activity action string value
+     * @param string               $activity_action Activity action string value.
      * @param string               $type            The type of post. Expects `topic` or `reply`.
      * @param string               $action          The current action string.
 …
  * @since 2.6.0 bbPress (r6370)
+ *
  * @param string $action   The current action string
  * @param object $activity The BuddyPress activity object
+ * @param string $action   The current action string.
+ * @param object $activity The BuddyPress activity object.
+ *
  * @return string The formatted activity action.
 …
  * @since 2.6.0 bbPress (r6370)
+ *
  * @param string $action   The current action string
  * @param object $activity The BuddyPress activity object
+ * @param string $action   The current action string.
+ * @param object $activity The BuddyPress activity object.
+ *
  * @return string The formatted activity action

trunk/src/includes/extend/buddypress/groups.php

-                      r7379
+                      r7380
 /**
  * bbPress BuddyPress Group Extension Class
+ * bbPress BuddyPress Group Extension Class.
+ *
  * This file is responsible for connecting bbPress to the BuddyPress Groups
 …
 if ( ! class_exists( 'BBP_Forums_Group_Extension' ) && class_exists( 'BP_Group_Extension' ) ) :
 /**
  * Loads Group Extension for Forums Component
+ * Loads Group Extension for Forums Component.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
     /**
      * Setup bbPress group extension variables
+     * Setup bbPress group extension variables.
+     *
      * @since 2.1.0 bbPress (r3552)
 …
     /**
      * Setup the group forums class variables
+     * Setup the group forums class variables.
+     *
      * @since 2.1.0 bbPress (r3552)
 …
     /**
      * Setup the group forums class actions
+     * Setup the group forums class actions.
+     *
      * @since 2.3.0 bbPress (r4552)
 …
     /**
      * Setup the group forums class filters
+     * Setup the group forums class filters.
+     *
      * @since 2.3.0 bbPress (r4552)
 …
     /**
      * The primary display function for group forums
+     * The primary display function for group forums.
+     *
      * @since 2.1.0 bbPress (r3746)
 …
     /**
      * Maybe unset the group forum nav item if group does not have a forum
+     * Maybe unset the group forum nav item if group does not have a forum.
+     *
      * @since 2.3.0 bbPress (r4552)
+     *
      * @return If not viewing a single group
+     * @return If not viewing a single group.
      */
     public function maybe_unset_forum_menu() {
 …
      * @since 2.6.14
+     *
      * @param int $topic_id
+     * @param int $topic_id Topic id.
      */
     public function validate_topic_forum_id( $topic_id = 0 ) {
 …
      * @since 2.6.14
+     *
      * @param int $reply_id
+     * @param int $reply_id Reply id.
      */
     public function validate_reply_to_id( $reply_id = 0 ) {
 …
     /**
      * Show forums and new forum form when editing a group
+     * Show forums and new forum form when editing a group.
+     *
      * @since 2.1.0 bbPress (r3563)
 …
     /**
      * Save the Group Forum data on edit
+     * Save the Group Forum data on edit.
+     *
      * @since 2.0.0 bbPress (r3465)
+     *
      * @param int $group_id (to handle Group Admin UI hook bp_group_admin_edit_after )
+     * @param int $group_id (to handle Group Admin UI hook bp_group_admin_edit_after).
      */
     public function edit_screen_save( $group_id = 0 ) {
 …
     /**
      * Adds a meta-box to BuddyPress Group Admin UI
+     * Adds a meta-box to BuddyPress Group Admin UI.
+     *
      * @since 2.3.0 bbPress (r4814)
 …
     /**
      * Displays the bbPress meta-box in BuddyPress Group Admin UI
+     * Displays the bbPress meta-box in BuddyPress Group Admin UI.
+     *
      * @since 2.3.0 bbPress (r4814)
+     *
      * @param object $item (group object)
+     * @param object $item (group object).
      */
     public function group_admin_ui_display_metabox( $item ) {
 …
     /**
      * Show forums and new forum form when creating a group
+     * Show forums and new forum form when creating a group.
+     *
      * @since 2.0.0 bbPress (r3465)
 …
     /**
      * Save the Group Forum data on create
+     * Save the Group Forum data on create.
+     *
      * @since 2.0.0 bbPress (r3465)
 …
     /**
      * Used to start an output buffer
+     * Used to start an output buffer.
+     *
      * @since 2.1.0 bbPress (r3746)
 …
     /**
      * Used to end an output buffer
+     * Used to end an output buffer.
+     *
      * @since 2.1.0 bbPress (r3746)
 …
     /**
      * Creating a group forum or category (including root for group)
+     * Creating a group forum or category (including root for group).
+     *
      * @since 2.1.0 bbPress (r3653)
 …
      * @param array $forum_args
+     *
      * @return void if no forum_id is available
+     * @return void if no forum_id is available.
      */
     public function new_forum( $forum_args = array() ) {
 …
     /**
      * Removing a group forum or category (including root for group)
+     * Removing a group forum or category (including root for group).
+     *
      * @since 2.1.0 bbPress (r3653)
 …
      * @param array $forum_args
+     *
      * @return void if no forum_id is available
+     * @return void if no forum_id is available.
      */
     public function remove_forum( $forum_args = array() ) {
 …
     /**
      * Listening to BuddyPress Group deletion to remove the forum
+     * Listening to BuddyPress Group deletion to remove the forum.
+     *
      * @since 2.3.0 bbPress (r4815)
+     *
      * @param int $group_id The group ID
+     * @param int $group_id The group ID.
      */
     public function disconnect_forum_from_group( $group_id = 0 ) {
 …
      * Update forum attributes to match those of the associated group.
+     *
      * Fired whenever a group is saved
+     * Fired whenever a group is saved.
+     *
      * @since 2.6.7 bbPress (r7208)
 …
     /**
      * Toggle the enable_forum group setting on or off
+     * Toggle the enable_forum group setting on or off.
+     *
      * @since 2.3.0 bbPress (r4612)
+     *
      * @param int $group_id The group to toggle
      * @param bool $enabled True for on, false for off
      * @return False if group is not found, otherwise return the group
+     * @param int $group_id The group to toggle.
+     * @param bool $enabled True for on, false for off.
+     * @return False if group is not found, otherwise return the group.
      */
     public function toggle_group_forum( $group_id = 0, $enabled = false ) {
 …
     /**
      * Output the forums for a group in the edit screens
+     * Output the forums for a group in the edit screens.
+     *
      * As of right now, bbPress only supports 1-to-1 group forum relationships.
 …
     /**
      * Strip super stickies from the topic query
+     * Strip super stickies from the topic query.
+     *
      * @since 2.3.0 bbPress (r4810)
+     *
      * @access private
      * @param array $super the super sticky post ID's
+     * @param array $super the super sticky post ID's.
      * @return array (empty)
      */
 …
     /**
      * Unset the type super sticky from topic type
+     * Unset the type super sticky from topic type.
+     *
      * @since 2.3.0 bbPress (r4810)
 …
      * @access private
      * @param array $args
      * @return array $args without the to-front link
+     * @return array $args without the to-front link.
      */
     public function unset_super_sticky( $args = array() ) {
 …
     /**
      * Ugly preg_replace to hide the to front admin link
+     * Ugly preg_replace to hide the to front admin link.
+     *
      * @since 2.3.0 bbPress (r4810)
 …
      * @param string $retval
      * @param array $args
      * @return string $retval without the to-front link
+     * @return string $retval without the to-front link.
      */
     public function hide_super_sticky_admin_link( $retval = '', $args = array() ) {
 …
     /**
      * Redirect to the group forum screen
+     * Redirect to the group forum screen.
+     *
      * @since 2.1.0 bbPress (r3653)
 …
     /**
      * Redirect to the group forum screen
+     * Redirect to the group forum screen.
+     *
      * @since 2.1.0 bbPress (r3653)
 …
     /**
      * Redirect to the group admin forum edit screen
+     * Redirect to the group admin forum edit screen.
+     *
      * @since 2.1.0 bbPress (r3653)
 …
     /**
      * Maybe map a bbPress forum/topic/reply permalink to the corresponding group
+     * Maybe map a bbPress forum/topic/reply permalink to the corresponding group.
+     *
      * @since 2.2.0 bbPress (r4266)
+     *
      * @param int $post_id
      * @return Bail early if not a group forum post
+     * @return Bail early if not a group forum post.
      * @return string
      */
 …
     /**
      * Map a forum permalink to its corresponding group
+     * Map a forum permalink to its corresponding group.
+     *
      * @since 2.1.0 bbPress (r3802)
 …
     /**
      * Map a topic permalink to its group forum
+     * Map a topic permalink to its group forum.
+     *
      * @since 2.1.0 bbPress (r3802)
 …
     /**
      * Map a reply permalink to its group forum
+     * Map a reply permalink to its group forum.
+     *
      * @since 2.1.0 bbPress (r3802)
 …
     /**
      * Map a reply edit link to its group forum
+     * Map a reply edit link to its group forum.
+     *
      * @since 2.2.0 bbPress (r4266)
 …
     /**
      * Map a post link to its group forum
+     * Map a post link to its group forum.
+     *
      * @since 2.2.0 bbPress (r4266)
 …
     /**
      * Map a page link to its group forum
+     * Map a page link to its group forum.
+     *
      * @since 2.2.0 bbPress (r4266)
 …
     /**
      * Map a custom post type link to its group forum
+     * Map a custom post type link to its group forum.
+     *
      * @since 2.2.0 bbPress (r4266)
 …
     /**
      * Fix pagination of topics on forum view
+     * Fix pagination of topics on forum view.
+     *
      * @since 2.2.0 bbPress (r4266)
 …
     /**
      * Fix pagination of replies on topic view
+     * Fix pagination of replies on topic view.
+     *
      * @since 2.2.0 bbPress (r4266)
 …
      * @since 2.6.14
+     *
      * @param  object $query  Verified query object
      * @param  string $type   Type of variable to compare to
      * @return mixed  Verified object if valid, Default or null if invalid
+     * @param  object $query  Verified query object.
+     * @param  string $type   Type of variable to compare to.
+     * @return mixed  Verified object if valid, Default or null if invalid.
      */
     public function rewrite_pagination( $query, $type = '' ) {

trunk/src/includes/extend/buddypress/loader.php

-                      r7379
+                      r7380
 /**
  * bbPress BuddyPress Component Class
+ * bbPress BuddyPress Component Class.
+ *
  * bbPress and BuddyPress are designed to connect together seamlessly and
 …
 if ( ! class_exists( 'BBP_Forums_Component' ) ) :
 /**
  * Loads Forums Component
+ * Loads Forums Component.
+ *
  * @since 2.1.0 bbPress (r3552)
 …
     /**
      * BuddyPress Members component shim
+     * BuddyPress Members component shim.
+     *
      * @since 2.0.0
 …
     /**
      * BuddyPress Activity component shim
+     * BuddyPress Activity component shim.
+     *
      * @since 2.0.0
 …
     /**
      * Start the forums component creation process
+     * Start the forums component creation process.
+     *
      * @since 2.1.0 bbPress (r3552)
 …
     /**
      * Include BuddyPress classes and functions
+     * Include BuddyPress classes and functions.
      */
     public function includes( $includes = array() ) {
 …
     /**
      * Setup globals
+     * Setup globals.
+     *
      * The BP_FORUMS_SLUG constant is deprecated, and only used here for
 …
     /**
      * Setup the actions
+     * Setup the actions.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Instantiate classes for BuddyPress integration
+     * Instantiate classes for BuddyPress integration.
+     *
      * @since 2.0.0 bbPress (r3395)
 …
     /**
      * Setup BuddyBar navigation
+     * Setup BuddyBar navigation.
+     *
      * @since 2.1.0 bbPress (r3552)
 …
     /**
      * Set up the admin bar
+     * Set up the admin bar.
+     *
      * @since 2.1.0 bbPress (r3552)
 …
     /**
      * Sets up the title for pages and <title>
+     * Sets up the title for pages and <title>.
+     *
      * @since 2.1.0 bbPress (r3552)

trunk/src/includes/extend/buddypress/members.php

-                      r7311
+                      r7380
 /**
  * bbPress BuddyPress Members Class
+ * bbPress BuddyPress Members Class.
+ *
  * @package bbPress
 …
 if ( ! class_exists( 'BBP_Forums_Members' ) ) :
 /**
  * Member profile modifications
+ * Member profile modifications.
+ *
  * @since 2.2.0 bbPress (r4395)
 …
     /**
      * Main constructor for modifying bbPress profile links
+     * Main constructor for modifying bbPress profile links.
+     *
      * @since 2.2.0 bbPress (r4395)
 …
     /**
      * Setup the actions
+     * Setup the actions.
+     *
      * @since 2.2.0 bbPress (r4395)
 …
     /**
      * Setup the filters
+     * Setup the filters.
+     *
      * @since 2.2.0 bbPress (r4395)
 …
     /**
      * Override bbPress profile URL with BuddyPress profile URL
+     * Override bbPress profile URL with BuddyPress profile URL.
+     *
      * @since 2.0.0 bbPress (r3401)
 …
     /**
      * Override bbPress topics created URL with BuddyPress profile URL
+     * Override bbPress topics created URL with BuddyPress profile URL.
+     *
      * @since 2.6.0 bbPress (r3721)
 …
     /**
      * Override bbPress replies created URL with BuddyPress profile URL
+     * Override bbPress replies created URL with BuddyPress profile URL.
+     *
      * @since 2.6.0 bbPress (r3721)
 …
     /**
      * Override bbPress favorites URL with BuddyPress profile URL
+     * Override bbPress favorites URL with BuddyPress profile URL.
+     *
      * @since 2.1.0 bbPress (r3721)
 …
     /**
      * Override bbPress subscriptions URL with BuddyPress profile URL
+     * Override bbPress subscriptions URL with BuddyPress profile URL.
+     *
      * @since 2.1.0 bbPress (r3721)
 …
     /**
      * Override bbPress engagements URL with BuddyPress profile URL
+     * Override bbPress engagements URL with BuddyPress profile URL.
+     *
      * @since 2.6.0 bbPress (r6320)
 …
+     *
      * @global WP_Query $wp_query
      * @return If not viewing your own profile
+     * @return If not viewing your own profile.
      */
     public function set_member_forum_query_vars() {
 …
     /**
      * Private method used to concatenate user IDs and slugs into URLs
+     * Private method used to concatenate user IDs and slugs into URLs.
+     *
      * @since 2.6.0 bbPress (r6803)

trunk/src/includes/extend/buddypress/notifications.php

-                      r7378
+                      r7380
 /**
  * bbPress BuddyPress Notifications
+ * bbPress BuddyPress Notifications.
+ *
  * @package bbPress
 …
 /**
  * Format the BuddyBar/Toolbar notifications
+ * Format the BuddyBar/Toolbar notifications.
+ *
  * @since 2.5.0 bbPress (r5155)
 …
 /**
  * Mark notifications as read when reading a topic
+ * Mark notifications as read when reading a topic.
+ *
  * @since 2.5.0 bbPress (r5155)
+ *
  * @return If not trying to mark a notification as read
+ * @return If not trying to mark a notification as read.
  */
 function bbp_buddypress_mark_notifications( $action = '' ) {

trunk/src/includes/forums/capabilities.php

-                      r7378
+                      r7380
 /**
  * bbPress Forum Capabilites
+ * bbPress Forum Capabilities.
+ *
  * Used to map forum capabilities to WordPress's existing capabilities.
 …
 /**
  * Return forum capabilities
+ * Return forum capabilities.
+ *
  * @since 2.0.0 bbPress (r2593)
+ *
  * @return array Forum capabilities
+ * @return array Forum capabilities.
  */
 function bbp_get_forum_caps() {
 …
 /**
  * Maps forum capabilities
+ * Maps forum capabilities.
+ *
  * @since 2.2.0 bbPress (r4242)
+ *
  * @param array $caps Capabilities for meta capability
  * @param string $cap Capability name
  * @param int $user_id User id
  * @param array $args Arguments
  * @return array Actual capabilities for meta capability
+ * @param array $caps Capabilities for meta capability.
+ * @param string $cap Capability name.
+ * @param int $user_id User id.
+ * @param array $args Arguments.
+ * @return array Actual capabilities for meta capability.
  */
 function bbp_map_forum_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {
 …
  * @param int $forum_id Forum id.
+ *
  * @return bool Return true if user is moderator of forum
+ * @return bool Return true if user is moderator of forum.
  */
 function bbp_is_user_forum_moderator( $user_id = 0, $forum_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r6426)
+ *
  * @param array $forum_ids Forum IDs to check if the user ID is a moderator of
  * @param int   $user_id   User ID to check if is a moderator of forums
+ * @param array $forum_ids Forum IDs to check if the user ID is a moderator of.
+ * @param int   $user_id   User ID to check if is a moderator of forums.
+ *
  * @return array

trunk/src/includes/forums/functions.php

-                      r7379
+                      r7380
  * @since 2.0.0 bbPress (r3349)
+ *
+ * @param array $forum_data Forum post data
+ * @param array $forum_meta Forum meta data
+ * @param array $forum_data Forum post data.
+ * @param array $forum_meta Forum meta data.
+ *
+ * @return int|false Forum ID on success, false on failure.
  */
 function bbp_insert_forum( $forum_data = array(), $forum_meta = array() ) {
 …
 /**
  * Handles the front end forum submission
+ *
  * @param string $action The requested action to compare this function to
+ * Handles the front end forum submission.
+ *
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_new_forum_handler( $action = '' ) {
 …
 /**
  * Handles the front end edit forum submission
+ *
  * @param string $action The requested action to compare this function to
+ * Handles the front end edit forum submission.
+ *
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_edit_forum_handler( $action = '' ) {
 …
 /**
  * Handle the saving of core forum metadata (Status, Visibility, and Type)
+ * Handle the saving of core forum metadata (Status, Visibility, and Type).
+ *
  * @since 2.1.0 bbPress (r3678)
+ *
  * @param int $forum_id
  * @return If forum ID is empty
+ * @param int $forum_id.
+ * @return If forum ID is empty.
  */
 function bbp_save_forum_extras( $forum_id = 0 ) {
 …
         /**
          * Allow custom forum visibility save actions
+         * Allow custom forum visibility save actions.
+         *
          * @since 2.6.0 bbPress (r5855)
+         *
          * @param int    $forum_id       The forum ID
          * @param string $old_visibility The current forum visibility
          * @param string $new_visibility The new forum visibility
+         * @param int    $forum_id       The forum ID.
+         * @param string $old_visibility The current forum visibility.
+         * @param string $new_visibility The new forum visibility.
          */
         do_action( 'bbp_update_forum_visibility', $forum_id, $old_visibility, $new_visibility );
 …
 /**
  * Closes a forum
+ * Closes a forum.
+ *
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id forum id
  * @return mixed False or {@link WP_Error} on failure, forum id on success
+ * @param int $forum_id forum id.
+ * @return mixed False or {@link WP_Error} on failure, forum id on success.
  */
 function bbp_close_forum( $forum_id = 0 ) {
 …
 /**
  * Opens a forum
+ * Opens a forum.
+ *
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id forum id
  * @return mixed False or {@link WP_Error} on failure, forum id on success
+ * @param int $forum_id forum id.
+ * @return mixed False or {@link WP_Error} on failure, forum id on success.
  */
 function bbp_open_forum( $forum_id = 0 ) {
 …
 /**
  * Make the forum a category
+ * Make the forum a category.
+ *
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool False on failure, true on success
+ * @param int $forum_id Optional. Forum id.
+ * @return bool False on failure, true on success.
  */
 function bbp_categorize_forum( $forum_id = 0 ) {
 …
 /**
  * Remove the category status from a forum
+ * Remove the category status from a forum.
+ *
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool False on failure, true on success
+ * @param int $forum_id Optional. Forum id.
+ * @return bool False on failure, true on success.
  */
 function bbp_normalize_forum( $forum_id = 0 ) {
 …
 /**
  * Mark the forum as public
+ * Mark the forum as public.
+ *
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool False on failure, true on success
+ * @param int $forum_id Optional. Forum id.
+ * @return bool False on failure, true on success.
  */
 function bbp_publicize_forum( $forum_id = 0, $current_visibility = '' ) {
 …
 /**
  * Mark the forum as private
+ * Mark the forum as private.
+ *
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool False on failure, true on success
+ * @param int $forum_id Optional. Forum id.
+ * @return bool False on failure, true on success.
  */
 function bbp_privatize_forum( $forum_id = 0, $current_visibility = '' ) {
 …
 /**
  * Mark the forum as hidden
+ * Mark the forum as hidden.
+ *
  * @since 2.0.0 bbPress (r2996)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool False on failure, true on success
+ * @param int $forum_id Optional. Forum id.
+ * @return bool False on failure, true on success.
  */
 function bbp_hide_forum( $forum_id = 0, $current_visibility = '' ) {
 …
 /**
  * Recaches the private and hidden forums
+ * Re-caches the private and hidden forums.
+ *
  * @since 2.4.0 bbPress (r5017)
+ *
  * @return array An array of the status code and the message
+ * @return array An array of the status code and the message.
  */
 function bbp_repair_forum_visibility() {
 …
 /**
  * Remove a deleted forum from all user subscriptions
+ * Remove a deleted forum from all user subscriptions.
+ *
  * @since 2.5.0 bbPress (r5156)
+ *
  * @param int $forum_id Get the forum ID to remove
+ * @param int $forum_id Get the forum ID to remove.
  */
 function bbp_remove_forum_from_all_subscriptions( $forum_id = 0 ) {
 …
 /**
  * Bump the total topic count of a forum
+ * Bump the total topic count of a forum.
+ *
  * @since 2.1.0 bbPress (r3825)
 …
+ *
  * @param int $forum_id The forum id.
- * @return void
  */
 function bbp_increase_forum_topic_count( $forum_id = 0 ) {
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_decrease_forum_topic_count( $forum_id = 0 ) {
 …
 /**
  * Bump the total topic count of a forum
+ * Bump the total topic count of a forum.
+ *
  * @since 2.1.0 bbPress (r3825)
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_increase_forum_topic_count_hidden( $forum_id = 0 ) {
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_decrease_forum_topic_count_hidden( $forum_id = 0 ) {
 …
 /**
  * Bump the total topic count of a forum
+ * Bump the total topic count of a forum.
+ *
  * @since 2.1.0 bbPress (r3825)
+ *
  * @param int $forum_id Optional. Forum id.
  * @param int $difference Optional. Default 1
  * @param bool $update_ancestors Optional. Default true
+ * @param int $difference Optional. Default 1.
+ * @param bool $update_ancestors Optional. Default true.
+ *
  * @return int Forum topic count
 …
 /**
  * Bump the total topic count of a forum
+ * Bump the total topic count of a forum.
+ *
  * @since 2.6.0 bbPress (r6922)
+ *
  * @param int $forum_id Optional. Forum id.
  * @param int $difference Optional. Default 1
  * @param bool $update_ancestors Optional. Default true
+ * @param int $difference Optional. Default 1.
+ * @param bool $update_ancestors Optional. Default true.
+ *
  * @return int Forum topic count
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_increase_forum_reply_count( $forum_id = 0 ) {
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_decrease_forum_reply_count( $forum_id = 0 ) {
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_increase_forum_reply_count_hidden( $forum_id = 0 ) {
 …
+ *
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_decrease_forum_reply_count_hidden( $forum_id = 0 ) {
 …
+ *
  * @param int $topic_id The topic id.
+ *
- * @return void
  */
 function bbp_approved_unapproved_topic_update_forum_reply_count( $topic_id = 0 ) {
 …
 /**
  * Update the forum last topic id
+ * Update the forum last topic id.
+ *
  * @since 2.0.0 bbPress (r2625)
 …
  * @param int $forum_id Optional. Forum id.
  * @param int $topic_id Optional. Topic id.
  * @return int Id of the forums most recent topic
+ * @return int Id of the forums most recent topic.
  */
 function bbp_update_forum_last_topic_id( $forum_id = 0, $topic_id = 0 ) {
 …
 /**
  * Update the forum last reply id
+ * Update the forum last reply id.
+ *
  * @since 2.0.0 bbPress (r2625)
 …
  * @param int $forum_id Optional. Forum id.
  * @param int $reply_id Optional. Reply id.
  * @return int Id of the forums most recent reply
+ * @return int Id of the forums most recent reply.
  */
 function bbp_update_forum_last_reply_id( $forum_id = 0, $reply_id = 0 ) {
 …
 /**
  * Update the forum last active post id
+ * Update the forum last active post id.
+ *
  * @since 2.0.0 bbPress (r2860)
 …
  * @param int $forum_id Optional. Forum id.
  * @param int $active_id Optional. Active post id.
  * @return int Id of the forums last active post
+ * @return int Id of the forums last active post.
  */
 function bbp_update_forum_last_active_id( $forum_id = 0, $active_id = 0 ) {
 …
 /**
  * Update the forums last active date/time (aka freshness)
+ * Update the forums last active date/time (aka freshness).
+ *
  * @since 2.0.0 bbPress (r2680)
 …
  * @param string $new_time Optional. New time in mysql format.
+ *
  * @return string MySQL timestamp of last active topic or reply
+ * @return string MySQL timestamp of last active topic or reply.
  */
 function bbp_update_forum_last_active_time( $forum_id = 0, $new_time = '' ) {
 …
 /**
  * Update the forum sub-forum count
+ * Update the forum sub-forum count.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @param int $subforums Optional. Number of subforums
  * @return bool True on success, false on failure
+ * @param int $forum_id Optional. Forum id.
+ * @param int $subforums Optional. Number of subforums.
+ * @return bool True on success, false on failure.
  */
 function bbp_update_forum_subforum_count( $forum_id = 0, $subforums = false ) {
 …
 /**
  * Adjust the total topic count of a forum
+ * Adjust the total topic count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
 …
  *                       is a topic or a forum. If it's a topic, its parent,
  *                       i.e. the forum is automatically retrieved.
  * @param bool $total_count Optional. To return the total count or normal count?
  * @return int Forum topic count
+ * @param bool $total_count Optional. To return the total count or normal count.
+ * @return int Forum topic count.
  */
 function bbp_update_forum_topic_count( $forum_id = 0 ) {
 …
 /**
  * Adjust the total hidden topic count of a forum (hidden includes trashed,
  * spammed and pending topics)
+ * spammed and pending topics).
+ *
  * @since 2.0.0 bbPress (r2888)
 …
  * @param int $topic_count Optional. Set the topic count manually.
+ *
  * @return int Topic hidden topic count
+ * @return int Topic hidden topic count.
  */
 function bbp_update_forum_topic_count_hidden( $forum_id = 0, $topic_count = false ) {
 …
 /**
  * Adjust the total reply count of a forum
+ * Adjust the total reply count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
  * @since 2.6.0 bbPress (r5954) Replace direct queries with WP_Query() objects
+ * @since 2.6.0 bbPress (r5954) Replace direct queries with WP_Query() objects.
+ *
  * @param int  $forum_id Optional. Forum id or topic id. It is checked whether it
 …
  *                       i.e. the forum is automatically retrieved.
+ *
  * @return int Forum reply count
+ * @return int Forum reply count.
  */
 function bbp_update_forum_reply_count( $forum_id = 0 ) {
 …
 /**
  * Adjust the total hidden reply count of a forum
+ * Adjust the total hidden reply count of a forum.
+ *
  * @since 2.6.0 bbPress (r6922)
 …
  *                       i.e. the forum is automatically retrieved.
+ *
  * @return int Forum reply count
+ * @return int Forum reply count.
  */
 function bbp_update_forum_reply_count_hidden( $forum_id = 0 ) {
 …
 /**
  * Return an associative array of available topic statuses
+ * Return an associative array of available topic statuses.
+ *
  * Developers note: these statuses are actually stored as meta data, and
 …
  * @since 2.4.0 bbPress (r5059)
+ *
  * @param int $forum_id   Optional. Forum id.
+ * @param int $forum_id Optional. Forum id.
+ *
  * @return array
 …
 /**
  * Return an associative array of forum types
+ * Return an associative array of forum type.
+ *
  * @since 2.4.0 bbPress (r5059)
+ *
  * @param int $forum_id   Optional. Forum id.
+ * @param int $forum_id Optional. Forum id.
+ *
  * @return array
 …
  * @since 2.4.0 bbPress (r5059)
+ *
  * @param int $forum_id   Optional. Forum id.
+ * @param int $forum_id Optional. Forum id.
+ *
  * @return array
 …
 /**
  * Returns the hidden forum ids
+ * Returns the hidden forum ids.
+ *
  * Only hidden forum ids are returned. Public and private ids are not.
 …
 /**
  * Returns the private forum ids
+ * Returns the private forum ids.
+ *
  * Only private forum ids are returned. Public and hidden ids are not.
 …
  * @since 2.6.0 bbPress (r6425)
+ *
  * @return array Forum IDs to exclude, or an empty array
+ * @return array Forum IDs to exclude, or an empty array.
  */
 function bbp_get_excluded_forum_ids() {
 …
  * @since 2.0.0 bbPress (r3291)
+ *
  * @param string Optional. The type of value to return. (string|array|meta_query)
+ * @param string Optional. The type of value to return (string|array|meta_query).
  */
 function bbp_exclude_forum_ids( $type = 'string' ) {
 …
 /**
  * Returns the forum's topic ids
+ *
  * Only topics with published and closed statuses are returned
+ * Returns the forum's topic ids.
+ *
+ * Only topics with published and closed statuses are returned.
+ *
  * @since 2.0.0 bbPress (r2908)
+ *
  * @param int $forum_id Forum id
+ * @param int $forum_id Forum id.
  */
 function bbp_forum_query_topic_ids( $forum_id ) {
 …
 /**
  * Returns the forum's subforum ids
+ *
  * Only forums with published status are returned
+ * Returns the forum's subforum ids.
+ *
+ * Only forums with published status are returned.
+ *
  * @since 2.0.0 bbPress (r2908)
+ *
  * @param int $forum_id Forum id
+ * @param int $forum_id Forum id.
  */
 function bbp_forum_query_subforum_ids( $forum_id ) {
 …
 /**
  * Returns the forum's last reply id
+ * Returns the forum's last reply id.
+ *
  * @since 2.0.0 bbPress (r2908)
  * @since 2.6.0 bbPress (r5954) Replace direct queries with WP_Query() objects
+ * @since 2.6.0 bbPress (r5954) Replace direct queries with WP_Query() objects.
+ *
  * @param int $forum_id Forum id.
 …
 /**
  * Check if it's a hidden forum or a topic or reply of a hidden forum and if
  * the user can't view it, then sets a 404
+ * the user can't view it, then sets a 404.
+ *
  * @since 2.0.0 bbPress (r2996)
 …
 /**
  * Check if it's a private forum or a topic or reply of a private forum and if
  * the user can't view it, then sets a 404
+ * the user can't view it, then sets a 404.
+ *
  * @since 2.0.0 bbPress (r2996)
 …
 /**
  * Redirect if unauthorized user is attempting to edit a forum
+ * Redirect if unauthorized user is attempting to edit a forum.
+ *
  * @since 2.1.0 bbPress (r3607)
 …
 /**
  * Delete all topics (and their replies) for a specific forum ID
+ * Delete all topics (and their replies) for a specific forum ID.
+ *
  * @since 2.1.0 bbPress (r3668)
+ *
  * @param int $forum_id
- * @return If forum is not valid
  */
 function bbp_delete_forum_topics( $forum_id = 0 ) {
 …
 /**
  * Trash all topics inside a forum
+ * Trash all topics inside a forum.
+ *
  * @since 2.1.0 bbPress (r3668)
+ *
  * @param int $forum_id
- * @return If forum is not valid
  */
 function bbp_trash_forum_topics( $forum_id = 0 ) {
 …
 /**
  * Untrash all topics inside a forum
+ * Untrash all topics inside a forum.
+ *
  * @since 2.1.0 bbPress (r3668)
+ *
  * @param int $forum_id
- * @return If forum is not valid
  */
 function bbp_untrash_forum_topics( $forum_id = 0 ) {
 …
 /**
  * Called before trashing a forum
+ * Called before trashing a forum.
+ *
  * This function is supplemental to the actual forum being trashed which is
 …
 /**
  * Called before untrashing a forum
+ * Called before untrashing a forum.
+ *
  * @since 2.1.0 bbPress (r3668)
 …
 /**
  * Called after deleting a forum
+ * Called after deleting a forum.
+ *
  * Try not to use this action. All meta & taxonomy terms have already been
 …
 /**
  * Called after trashing a forum
+ * Called after trashing a forum.
+ *
  * @since 2.1.0 bbPress (r3668)
 …
 /**
  * Called after untrashing a forum
+ * Called after untrashing a forum.
+ *
  * @since 2.1.0 bbPress (r3668)

trunk/src/includes/forums/template.php

-                      r7379
+                      r7380
 /**
  * bbPress Forum Template Tags
+ * bbPress Forum Template Tags.
+ *
  * @package bbPress
 …
 /**
  * Output the unique id of the custom post type for forums
+ * Output the unique id of the custom post type for forums.
+ *
  * @since 2.0.0 bbPress (r2857)
 …
 /**
  * Return the unique id of the custom post type for forums
+ * Return the unique id of the custom post type for forums.
+ *
  * @since 2.0.0 bbPress (r2857)
+ *
  * @return string The unique forum post type id
+ * @return string The unique forum post type id.
  */
 function bbp_get_forum_post_type() {
 …
 /**
  * Return array of labels used by the forum post type
+ * Return array of labels used by the forum post type.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return array of forum post type rewrite settings
+ * Return array of forum post type rewrite settings.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return array of features the forum post type supports
+ * Return array of features the forum post type supports.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
  * @param array $args All the arguments supported by {@link WP_Query}
+ *
  * @return object Multidimensional array of forum information
+ * @return object Multidimensional array of forum information.
  */
 function bbp_has_forums( $args = array() ) {
 …
 /**
  * Whether there are more forums available in the loop
+ * Whether there are more forums available in the loop.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @return object Forum information
+ * @return object Forum information.
  */
 function bbp_forums() {
 …
 /**
  * Loads up the current forum in the loop
+ * Loads up the current forum in the loop.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @return object Forum information
+ * @return object Forum information.
  */
 function bbp_the_forum() {
 …
 /**
  * Output forum id
+ * Output forum id.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param $forum_id Optional. Used to check emptiness
+ * @param $forum_id Optional. Used to check emptiness.
  */
 function bbp_forum_id( $forum_id = 0 ) {
 …
 /**
  * Return the forum id
+ * Return the forum id.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param $forum_id Optional. Used to check emptiness
  * @return int The forum id
+ * @param $forum_id Optional. Used to check emptiness.
+ * @return int The forum id.
  */
 function bbp_get_forum_id( $forum_id = 0 ) {
 …
 /**
  * Gets a forum
+ * Gets a forum.
+ *
  * @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()}
+ *
  * @return mixed Null if error or forum (in specified form) if success
+ * @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()}.
+ *
+ * @return mixed Null if error or forum (in specified form) if success.
  */
 function bbp_get_forum( $forum, $output = OBJECT, $filter = 'raw' ) {
 …
 /**
  * Output the link to the forum
+ * Output the link to the forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  * @param string $redirect_to Optional. Pass a redirect value for use with
  *                              shortcodes and other fun things.
 …
 /**
  * Return the link to the forum
+ * Return the link to the forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  * @param string $redirect_to Optional. Pass a redirect value for use with
  *                              shortcodes and other fun things.
+ *
  * @return string Permanent link to forum
+ * @return string Permanent link to forum.
  */
 function bbp_get_forum_permalink( $forum_id = 0, $redirect_to = '' ) {
 …
 /**
  * Output the title of the forum
+ * Output the title of the forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_title( $forum_id = 0 ) {
 …
 /**
  * Return the title of the forum
+ * Return the title of the forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Title of forum
+ * @param int $forum_id Optional. Forum id.
+ * @return string Title of forum.
  */
 function bbp_get_forum_title( $forum_id = 0 ) {
 …
 /**
  * Output the forum archive title
+ * Output the forum archive title.
+ *
  * @since 2.0.0 bbPress (r3249)
+ *
  * @param string $title Default text to use as title
+ * @param string $title Default text to use as title.
  */
 function bbp_forum_archive_title( $title = '' ) {
 …
 /**
  * Return the forum archive title
+ * Return the forum archive title.
+ *
  * @since 2.0.0 bbPress (r3249)
+ *
  * @param string $title Default text to use as title
+ *
  * @return string The forum archive title
+ * @param string $title Default text to use as title.
+ *
+ * @return string The forum archive title.
  */
 function bbp_get_forum_archive_title( $title = '' ) {
 …
 /**
  * Output the content of the forum
+ * Output the content of the forum.
+ *
  * @since 2.0.0 bbPress (r2780)
+ *
  * @param int $forum_id Optional. Topic id
+ * @param int $forum_id Optional. Topic id.
  */
 function bbp_forum_content( $forum_id = 0 ) {
 …
 /**
  * Return the content of the forum
+ * Return the content of the forum.
+ *
  * @since 2.0.0 bbPress (r2780)
+ *
  * @param int $forum_id Optional. Topic id
+ *
  * @return string Content of the forum
+ * @param int $forum_id Optional. Topic id.
+ *
+ * @return string Content of the forum.
  */
 function bbp_get_forum_content( $forum_id = 0 ) {
 …
 /**
  * Allow forum rows to have administrative actions
+ * Allow forum rows to have administrative actions.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @todo Links and filter
+ * @todo Links and filter.
  */
 function bbp_forum_row_actions() {
 …
 /**
  * Output the forums last active ID
+ * Output the forums last active ID.
+ *
  * @since 2.0.0 bbPress (r2860)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_active_id( $forum_id = 0 ) {
 …
 /**
  * Return the forums last active ID
+ * Return the forums last active ID.
+ *
  * @since 2.0.0 bbPress (r2860)
+ *
  * @param int $forum_id Optional. Forum id
  *                        the last active id and forum id
  * @return int Forum's last active id
+ * @param int $forum_id Optional. Forum id.
+ *                        the last active id and forum id.
+ * @return int Forum's last active id.
  */
 function bbp_get_forum_last_active_id( $forum_id = 0 ) {
 …
 /**
  * Output the forums last update date/time (aka freshness)
+ * Output the forums last update date/time (aka freshness).
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_active_time( $forum_id = 0 ) {
 …
 /**
  * Return the forums last update date/time (aka freshness)
+ * Return the forums last update date/time (aka freshness).
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Forum last update date/time (freshness)
+ * @param int $forum_id Optional. Forum id.
+ * @return string Forum last update date/time (freshness).
  */
 function bbp_get_forum_last_active_time( $forum_id = 0 ) {
 …
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_get_forum_freshness_link( $forum_id = 0 ) {
 …
 /**
  * Output parent ID of a forum, if exists
+ * Output parent ID of a forum, if exists.
+ *
  * @since 2.1.0 bbPress (r3675)
+ *
  * @param int $forum_id Forum ID
+ * @param int $forum_id Forum ID.
  */
 function bbp_forum_parent_id( $forum_id = 0 ) {
 …
 /**
  * Return ID of forum parent, if exists
+ * Return ID of forum parent, if exists.
+ *
  * @since 2.1.0 bbPress (r3675)
+ *
  * @param int $forum_id Optional. Forum id
  * @return int Forum parent
+ * @param int $forum_id Optional. Forum id.
+ * @return int Forum parent id.
  */
 function bbp_get_forum_parent_id( $forum_id = 0 ) {
 …
 /**
  * Return array of parent forums
+ * Return array of parent forums.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @return array Forum ancestors
+ * @param int $forum_id Optional. Forum id.
+ * @return array Forum ancestors.
  */
 function bbp_get_forum_ancestors( $forum_id = 0 ) {
 …
 /**
  * Return subforums of given forum
+ * Return subforums of given forum.
+ *
  * @since 2.0.0 bbPress (r2747)
+ *
  * @param array $args All the arguments supported by {@link WP_Query}
  * @return mixed false if none, array of subs if yes
+ * @param array $args All the arguments supported by {@link WP_Query}.
+ * @return mixed false if none, array of subs if yes.
  */
 function bbp_forum_get_subforums( $args = array() ) {
 …
 /**
  * Output a list of forums (can be used to list subforums)
+ * Output a list of forums (can be used to list subforums).
+ *
  * @since 2.0.0 bbPress (r2708)
 …
 /**
  * Output the forum subscription link
+ * Output the forum subscription link.
+ *
  * @since 2.5.0 bbPress (r5156)
 …
 /**
  * Get the forum subscription link
+ *
  * A custom wrapper for bbp_get_user_subscribe_link()
+ * Get the forum subscription link.
+ *
+ * A custom wrapper for bbp_get_user_subscribe_link().
+ *
  * @since 2.5.0 bbPress (r5156)
 …
 /**
  * Output the forum's last topic id
+ * Output the forum's last topic id.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_topic_id( $forum_id = 0 ) {
 …
 /**
  * Return the forum's last topic id
+ * Return the forum's last topic id.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
  * @return int Forum's last topic id
+ * @param int $forum_id Optional. Forum id.
+ * @return int Forum's last topic id.
  */
 function bbp_get_forum_last_topic_id( $forum_id = 0 ) {
 …
 /**
  * Output the title of the last topic inside a forum
+ * Output the title of the last topic inside a forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_topic_title( $forum_id = 0 ) {
 …
 /**
  * Return the title of the last topic inside a forum
+ * Return the title of the last topic inside a forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Forum's last topic's title
+ * @param int $forum_id Optional. Forum id.
+ * @return string Forum's last topic's title.
  */
 function bbp_get_forum_last_topic_title( $forum_id = 0 ) {
 …
 /**
  * Output the link to the last topic in a forum
+ * Output the link to the last topic in a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_topic_permalink( $forum_id = 0 ) {
 …
 /**
  * Return the link to the last topic in a forum
+ * Return the link to the last topic in a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Permanent link to topic
+ * @param int $forum_id Optional. Forum id.
+ * @return string Permanent link to topic.
  */
 function bbp_get_forum_last_topic_permalink( $forum_id = 0 ) {
 …
 /**
  * Return the author ID of the last topic of a forum
+ * Return the author ID of the last topic of a forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @return int Forum's last topic's author id
+ * @param int $forum_id Optional. Forum id.
+ * @return int Forum's last topic's author id.
  */
 function bbp_get_forum_last_topic_author_id( $forum_id = 0 ) {
 …
 /**
  * Output link to author of last topic of forum
+ * Output link to author of last topic of forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_topic_author_link( $forum_id = 0 ) {
 …
 /**
  * Return link to author of last topic of forum
+ * Return link to author of last topic of forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Forum's last topic's author link
+ * @param int $forum_id Optional. Forum id.
+ * @return string Forum's last topic's author link.
  */
 function bbp_get_forum_last_topic_author_link( $forum_id = 0 ) {
 …
 /**
  * Output the forums last reply id
+ * Output the forums last reply id.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_reply_id( $forum_id = 0 ) {
 …
 /**
  * Return the forums last reply id
+ * Return the forums last reply id.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
  * @return int Forum's last reply id
+ * @param int $forum_id Optional. Forum id.
+ * @return int Forum's last reply id.
  */
 function bbp_get_forum_last_reply_id( $forum_id = 0 ) {
 …
 /**
  * Output the title of the last reply inside a forum
+ *
  * @param int $forum_id Optional. Forum id
+ * Output the title of the last reply inside a forum.
+ *
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_reply_title( $forum_id = 0 ) {
 …
 /**
  * Return the title of the last reply inside a forum
+ *
  * @param int $forum_id Optional. Forum id
+ * Return the title of the last reply inside a forum.
+ *
+ * @param int $forum_id Optional. Forum id.
  * @return string
  */
 …
 /**
  * Output the link to the last reply in a forum
+ * Output the link to the last reply in a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_reply_permalink( $forum_id = 0 ) {
 …
 /**
  * Return the link to the last reply in a forum
+ * Return the link to the last reply in a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ *
  * @return string Permanent link to the forum's last reply
+ * @param int $forum_id Optional. Forum id.
+ *
+ * @return string Permanent link to the forum's last reply.
  */
 function bbp_get_forum_last_reply_permalink( $forum_id = 0 ) {
 …
 /**
  * Output the url to the last reply in a forum
+ * Output the url to the last reply in a forum.
+ *
  * @since 2.0.0 bbPress (r2683)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_reply_url( $forum_id = 0 ) {
 …
 /**
  * Return the url to the last reply in a forum
+ * Return the url to the last reply in a forum.
+ *
  * @since 2.0.0 bbPress (r2683)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Paginated URL to latest reply
+ * @param int $forum_id Optional. Forum id.
+ * @return string Paginated URL to latest reply.
  */
 function bbp_get_forum_last_reply_url( $forum_id = 0 ) {
 …
 /**
  * Output author ID of last reply of forum
+ * Output author ID of last reply of forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_reply_author_id( $forum_id = 0 ) {
 …
 /**
  * Return author ID of last reply of forum
+ * Return author ID of last reply of forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @return int Forum's last reply author id
+ * @param int $forum_id Optional. Forum id.
+ * @return int Forum's last reply author id.
  */
 function bbp_get_forum_last_reply_author_id( $forum_id = 0 ) {
 …
 /**
  * Output link to author of last reply of forum
+ * Output link to author of last reply of forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_last_reply_author_link( $forum_id = 0 ) {
 …
 /**
  * Return link to author of last reply of forum
+ * Return link to author of last reply of forum.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Link to author of last reply of forum
+ * @param int $forum_id Optional. Forum id.
+ * @return string Link to author of last reply of forum.
  */
 function bbp_get_forum_last_reply_author_link( $forum_id = 0 ) {
 …
 /**
  * Output the topics link of the forum
+ * Output the topics link of the forum.
+ *
  * @since 2.0.0 bbPress (r2883)
+ *
  * @param int $forum_id Optional. Topic id
+ * @param int $forum_id Optional. Topic id.
  */
 function bbp_forum_topics_link( $forum_id = 0 ) {
 …
 /**
  * Return the topics link of the forum
+ * Return the topics link of the forum.
+ *
  * @since 2.0.0 bbPress (r2883)
+ *
  * @param int $forum_id Optional. Topic id
+ * @param int $forum_id Optional. Topic id.
  */
 function bbp_get_forum_topics_link( $forum_id = 0 ) {
 …
 /**
  * Output total sub-forum count of a forum
+ * 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
+ * @param int $forum_id Optional. Forum id to check.
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_forum_subforum_count( $forum_id = 0, $integer = false ) {
 …
 /**
  * Return total subforum count of a forum
+ * Return total subforum count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
  * @param boolean $integer Optional. Whether or not to format the result
  * @return int Forum's subforum count
+ * @param int $forum_id Optional. Forum id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return int Forum's subforum count.
  */
 function bbp_get_forum_subforum_count( $forum_id = 0, $integer = false ) {
 …
 /**
  * Output total topic count of a forum
+ * Output total topic count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Return total topic count of a forum
+ * Return total topic count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  * @param bool $total_count Optional. To get the total count or normal
  *                           count? Defaults to total.
  * @param boolean $integer Optional. Whether or not to format the result
  * @return int Forum topic count
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return int Forum topic count.
  */
 function bbp_get_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Output total reply count of a forum
+ * Output total reply count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Return total post count of a forum
+ * Return total post count of a forum.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
  * @return int Forum reply count
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return int Forum reply count.
  */
 function bbp_get_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Output total post count of a forum
+ * Output total post count of a forum.
+ *
  * @since 2.0.0 bbPress (r2954)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_forum_post_count( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Return total post count of a forum
+ * Return total post count of a forum.
+ *
  * @since 2.0.0 bbPress (r2954)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
  * @return int Forum post count
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return int Forum post count.
  */
 function bbp_get_forum_post_count( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Output total hidden topic count of a forum (hidden includes trashed, spammed,
  * and pending topics)
+ * 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 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
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_forum_topic_count_hidden( $forum_id = 0, $total_count = true, $integer = null ) {
 …
 /**
  * Return total hidden topic count of a forum (hidden includes trashed,
  * spammed and pending topics)
+ * 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 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
  * @return int Topic hidden topic count
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return int Topic hidden topic count.
  */
 function bbp_get_forum_topic_count_hidden( $forum_id = 0, $total_count = true, $integer = null ) {
 …
 /**
  * Output total hidden reply count of a forum (hidden includes trashed, spammed,
  * and pending replies)
+ * and pending replies).
+ *
  * @since 2.6.0 bbPress (r6922)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_forum_reply_count_hidden( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Return total hidden reply count of a forum (hidden includes trashed,
  * spammed and pending replies)
+ * spammed and pending replies).
+ *
  * @since 2.6.0 bbPress (r6922)
+ *
  * @param int $forum_id Optional. Forum id
+ * @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
  * @return int Forum reply count
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return int Forum reply count.
  */
 function bbp_get_forum_reply_count_hidden( $forum_id = 0, $total_count = true, $integer = false ) {
 …
 /**
  * Output the status of the forum
+ * Output the status of the forum.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_status( $forum_id = 0 ) {
 …
 /**
  * Return the status of the forum
+ * Return the status of the forum.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Status of forum
+ * @param int $forum_id Optional. Forum id.
+ * @return string Status of forum.
  */
 function bbp_get_forum_status( $forum_id = 0 ) {
 …
 /**
  * Output the visibility of the forum
+ * Output the visibility of the forum.
+ *
  * @since 2.0.0 bbPress (r2997)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_visibility( $forum_id = 0 ) {
 …
 /**
  * Return the visibility of the forum
+ * Return the visibility of the forum.
+ *
  * @since 2.0.0 bbPress (r2997)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Status of forum
+ * @param int $forum_id Optional. Forum id.
+ * @return string Status of forum.
  */
 function bbp_get_forum_visibility( $forum_id = 0 ) {
 …
 /**
  * Output the type of the forum
+ * Output the type of the forum.
+ *
  * @since 2.1.0 bbPress (r3563)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_type( $forum_id = 0 ) {
 …
  * @since 2.1.0 bbPress (r3563)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool Whether the forum is a category or not
+ * @param int $forum_id Optional. Forum id.
+ * @return bool Whether the forum is a category or not.
  */
 function bbp_get_forum_type( $forum_id = 0 ) {
 …
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
  * @return bool Whether the forum is a category or not
+ * @param int $forum_id Optional. Forum id.
+ * @return bool Whether the forum is a category or not.
  */
 function bbp_is_forum_category( $forum_id = 0 ) {
 …
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  * @param bool $check_ancestors Check if the ancestors are open (only
  *                               if they're a category)
  * @return bool Whether the forum is open or not
+ *                               if they're a category).
+ * @return bool Whether the forum is open or not.
  */
 function bbp_is_forum_open( $forum_id = 0, $check_ancestors = true ) {
 …
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  * @param bool $check_ancestors Check if the ancestors are closed (only
  *                               if they're a category)
  * @return bool True if closed, false if not
+ *                               if they're a category).
+ * @return bool True if closed, false if not.
  */
 function bbp_is_forum_closed( $forum_id = 0, $check_ancestors = true ) {
 …
 /**
  * Check if the forum status is a specific one, also maybe checking ancestors
+ * Check if the forum status is a specific one, also maybe checking ancestors.
+ *
  * @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 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.
  *      'OR' means only one forum from the tree needs to match;
  *      'AND' means all forums must match. The default is 'AND'.
  * @return bool True if match, false if not
+ * @return bool True if match, false if not.
  */
 function bbp_is_forum_status( $forum_id, $status_name, $check_ancestors = true, $operator = 'AND' ) {
 …
  * @since 2.0.0 bbPress (r2997)
+ *
  * @param int $forum_id Optional. Forum id
  * @param bool $check_ancestors Check if the ancestors are public
  * @return bool True if closed, false if not
+ * @param int $forum_id Optional. Forum id.
+ * @param bool $check_ancestors Check if the ancestors are public.
+ * @return bool True if closed, false if not.
  */
 function bbp_is_forum_public( $forum_id = 0, $check_ancestors = true ) {
 …
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $forum_id Optional. Forum id
  * @param bool $check_ancestors Check if the ancestors are private
  * @return bool True if private, false if not
+ * @param int $forum_id Optional. Forum id.
+ * @param bool $check_ancestors Check if the ancestors are private.
+ * @return bool True if private, false if not.
  */
 function bbp_is_forum_private( $forum_id = 0, $check_ancestors = true ) {
 …
  * @since 2.0.0 bbPress (r2997)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  * @param bool $check_ancestors Check if the ancestors are private (only if
  *                               they're a category)
  * @return bool True if hidden, false if not
+ *                               they're a category).
+ * @return bool True if hidden, false if not.
  */
 function bbp_is_forum_hidden( $forum_id = 0, $check_ancestors = true ) {
 …
 /**
  * Check the forum visibility ID
+ * Check the forum visibility ID.
+ *
  * @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 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.
  *      'OR' means only one forum from the tree needs to match;
  *      'AND' means all forums must match. The default is 'AND'.
  * @return bool True if match, false if not
+ * @return bool True if match, false if not.
  */
 function bbp_is_forum_visibility( $forum_id, $status_name, $check_ancestors = true, $operator = 'AND' ) {
 …
 /**
  * Output the author ID of the forum
+ * Output the author ID of the forum.
+ *
  * @since 2.1.0 bbPress (r3675)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_author_id( $forum_id = 0 ) {
 …
 /**
  * Return the author ID of the forum
+ * Return the author ID of the forum.
+ *
  * @since 2.1.0 bbPress (r3675)
+ *
  * @param int $forum_id Optional. Forum id
+ *
  * @return string Author of forum
+ * @param int $forum_id Optional. Forum id.
+ *
+ * @return string Author of forum.
  */
 function bbp_get_forum_author_id( $forum_id = 0 ) {
 …
 /**
  * Output the author of the forum
+ * Output the author of the forum.
+ *
  * @since 2.1.0 bbPress (r3675)
+ *
  * @param int $forum_id Optional. Forum id
+ * @param int $forum_id Optional. Forum id.
  */
 function bbp_forum_author_display_name( $forum_id = 0 ) {
 …
 /**
  * Return the author of the forum
+ * Return the author of the forum.
+ *
  * @since 2.1.0 bbPress (r3675)
+ *
  * @param int $forum_id Optional. Forum id
  * @return string Author of forum
+ * @param int $forum_id Optional. Forum id.
+ * @return string Author of forum.
  */
 function bbp_get_forum_author_display_name( $forum_id = 0 ) {
 …
 /**
  * Output the row class of a forum
+ * 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
+ * @param array Extra classes you can pass when calling this function.
  */
 function bbp_forum_class( $forum_id = 0, $classes = array() ) {
 …
 /**
  * Return the row class of a forum
+ * Return 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
  * @return string Row class of the forum
+ * @param int $forum_id Optional. Forum ID.
+ * @param array Extra classes you can pass when calling this function.
+ * @return string Row class of the forum.
  */
 function bbp_get_forum_class( $forum_id = 0, $classes = array() ) {
 …
  * @since 2.0.0 bbPress (r2860)
+ *
  * @param array $args Arguments passed to alter output
+ * @param array $args Arguments passed to alter output.
  */
 function bbp_single_forum_description( $args = array() ) {
 …
  *  - after: After the text
  *  - size: Size of the avatar
  * @return string Filtered forum description
+ * @return string Filtered forum description.
  */
 function bbp_get_single_forum_description( $args = array() ) {
 …
 /**
  * Output the value of forum title field
+ * Output the value of forum title field.
+ *
  * @since 2.1.0 bbPress (r3551)
 …
 /**
  * Return the value of forum title field
+ * Return the value of forum title field.
+ *
  * @since 2.1.0 bbPress (r3551)
+ *
  * @return string Value of forum title field
+ * @return string Value of forum title field.
  */
 function bbp_get_form_forum_title() {
 …
 /**
  * Output the value of forum content field
+ * Output the value of forum content field.
+ *
  * @since 2.1.0 bbPress (r3551)
 …
 /**
  * Return the value of forum content field
+ * Return the value of forum content field.
+ *
  * @since 2.1.0 bbPress (r3551)
+ *
  * @return string Value of forum content field
+ * @return string Value of forum content field.
  */
 function bbp_get_form_forum_content() {
 …
 /**
  * Output value of forum moderators field
+ * Output value of forum moderators field.
+ *
  * @since 2.6.0 bbPress (r5837)
 …
 /**
  * Return value of forum moderators field
+ * Return value of forum moderators field.
+ *
  * @since 2.6.0 bbPress (r5837)
+ *
  * @return string Value of forum mods field
+ * @return string Value of forum mods field.
  */
 function bbp_get_form_forum_moderators() {
 …
 /**
  * Output value of forum parent
+ * Output value of forum parent.
+ *
  * @since 2.1.0 bbPress (r3551)
 …
 /**
  * Return value of forum parent
+ * Return value of forum parent.
+ *
  * @since 2.1.0 bbPress (r3551)
+ *
  * @return string Value of topic content field
+ * @return string Value of topic content field.
  */
 function bbp_get_form_forum_parent() {
 …
 /**
  * Output value of forum type
+ * Output value of forum type.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
 /**
  * Return value of forum type
+ * Return value of forum type.
+ *
  * @since 2.1.0 bbPress (r3563)
+ *
  * @return string Value of topic content field
+ * @return string Value of topic content field.
  */
 function bbp_get_form_forum_type() {
 …
 /**
  * Output value of forum visibility
+ * Output value of forum visibility.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
 /**
  * Return value of forum visibility
+ * Return value of forum visibility.
+ *
  * @since 2.1.0 bbPress (r3563)
+ *
  * @return string Value of topic content field
+ * @return string Value of topic content field.
  */
 function bbp_get_form_forum_visibility() {
 …
 /**
  * Output checked value of forum subscription
+ * Output checked value of forum subscription.
+ *
  * @since 2.5.0 bbPress (r5156)
 …
 /**
  * Return checked value of forum subscription
+ * Return checked value of forum subscription.
+ *
  * @since 2.5.0 bbPress (r5156)
+ *
  * @return string Checked value of forum subscription
+ * @return string Checked value of forum subscription.
  */
 function bbp_get_form_forum_subscribed() {
 …
 /**
  * Output value forum type dropdown
+ * Output value forum type dropdown.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
 /**
  * Return the forum type dropdown
+ * Return the forum type dropdown.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
 /**
  * Output value forum status dropdown
+ * Output value forum status dropdown.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
 /**
  * Return the forum status dropdown
+ * Return the forum status dropdown.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
  *  - forum_id: Forum id
  *  - selected: Override the selected option
  * @return string HTML select list for selecting forum status
+ * @return string HTML select list for selecting forum status.
  */
 function bbp_get_form_forum_status_dropdown( $args = array() ) {
 …
 /**
  * Output value forum visibility dropdown
+ * Output value forum visibility dropdown.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
 /**
  * Return the forum visibility dropdown
+ * Return the forum visibility dropdown.
+ *
  * @since 2.1.0 bbPress (r3563)
 …
  *  - forum_id: Forum id
  *  - selected: Override the selected option
  * @return string HTML select list for selecting forum visibility
+ * @return string HTML select list for selecting forum visibility.
  */
 function bbp_get_form_forum_visibility_dropdown( $args = array() ) {
 …
  * @since 2.6.0 bbPress (r5558)
+ *
  * @return boolean True if is a post request with valid nonce
+ * @return boolean True if is a post request with valid nonce.
  */
 function bbp_is_forum_form_post_request() {
 …
 /**
  * Output the link for the forum feed
+ * Output the link for the forum feed.
+ *
  * @since 2.0.0 bbPress (r3172)
 …
 /**
  * Retrieve the link for the forum feed
+ * Retrieve the link for the forum feed.
+ *
  * @since 2.0.0 bbPress (r3172)
 …
 /**
  * Output the link for the forum replies feed
+ * Output the link for the forum replies feed.
+ *
  * @since 2.0.0 bbPress (r3172)
 …
 /**
  * Retrieve the link for the forum replies feed
+ * Retrieve the link for the forum replies feed.
+ *
  * @since 2.0.0 bbPress (r3172)

trunk/src/includes/replies/capabilities.php

-                      r7378
+                      r7380
 /**
  * bbPress Reply Capabilites
+ * bbPress Reply Capabilities.
+ *
  * Used to map reply capabilities to WordPress's existing capabilities.
 …
 /**
  * Return reply capabilities
+ * Return reply capabilities.
+ *
  * @since 2.0.0 bbPress (r2593)
+ *
  * @return array Reply capabilities
+ * @return array Reply capabilities.
  */
 function bbp_get_reply_caps() {
 …
 /**
  * Maps topic capabilities
+ * Maps topic capabilities.
+ *
  * @since 2.2.0 bbPress (r4242)
 …
  * @param array  $args    Arguments.
+ *
  * @return array Actual capabilities for meta capability
+ * @return array Actual capabilities for meta capability.
  */
 function bbp_map_reply_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {

trunk/src/includes/replies/functions.php

-                      r7379
+                      r7380
  * @since 2.0.0 bbPress (r3349)
+ *
+ * @param array $reply_data Forum post data
+ * @param array $reply_meta Forum meta data
+ * @param array $reply_data Forum post data.
+ * @param array $reply_meta Forum meta data.
+ *
+ * @return int|false Reply ID on success, false on failure.
  */
 function bbp_insert_reply( $reply_data = array(), $reply_meta = array() ) {
 …
  * @param int $topic_id The topic id.
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_insert_reply_update_counts( $reply_id = 0, $topic_id = 0, $forum_id = 0 ) {
 …
 /**
  * Handles the front end reply submission
+ * Handles the front end reply submission.
+ *
  * @since 2.0.0 bbPress (r2574)
 …
  * @param string $action The requested action to compare this function to
  *                    id, anonymous data, reply author, edit (false), and
  *                    the reply to id
+ *                    the reply to id.
  */
 function bbp_new_reply_handler( $action = '' ) {
 …
 /**
  * Handles the front end edit reply submission
+ * Handles the front end edit reply submission.
+ *
  * @param string $action The requested action to compare this function to
  *                    id, anonymous data, reply author, bool true (for edit),
  *                    and the reply to id
+ *                       id, anonymous data, reply author, bool true (for edit),
+ *                       and the reply to id.
  */
 function bbp_edit_reply_handler( $action = '' ) {
 …
 /**
  * Handle all the extra meta stuff from posting a new reply or editing a reply
+ *
  * @param int $reply_id Optional. Reply id
  * @param int $topic_id Optional. Topic id
  * @param int $forum_id Optional. Forum id
+ * Handle all the extra meta stuff from posting a new reply or editing a reply.
+ *
+ * @param int $reply_id Optional. Reply id.
+ * @param int $topic_id Optional. Topic id.
+ * @param int $forum_id Optional. Forum id.
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
  * @param int $author_id Author id
+ *                              sanitized (see {@link bbp_filter_anonymous_post_data()}.
+ * @param int $author_id Author id.
  * @param bool $is_edit Optional. Is the post being edited? Defaults to false.
  * @param int $reply_to Optional. Reply to id
+ * @param int $reply_to Optional. Reply to id.
  */
 function bbp_update_reply( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $author_id = 0, $is_edit = false, $reply_to = 0 ) {
 …
 /**
  * Walk up the ancestor tree from the current reply, and update all the counts
+ * Walk up the ancestor tree from the current reply, and update all the counts.
+ *
  * @since 2.0.0 bbPress (r2884)
+ *
  * @param int $reply_id Optional. Reply id
  * @param string $last_active_time Optional. Last active time
  * @param int $forum_id Optional. Forum id
  * @param int $topic_id Optional. Topic id
+ * @param int $reply_id Optional. Reply id.
+ * @param string $last_active_time Optional. Last active time.
+ * @param int $forum_id Optional. Forum id.
+ * @param int $topic_id Optional. Topic id.
  * @param bool $refresh If set to true, unsets all the previous parameters.
  *                       Defaults to true
+ *                       Defaults to true.
  */
 function bbp_update_reply_walker( $reply_id, $last_active_time = '', $forum_id = 0, $topic_id = 0, $refresh = true ) {
 …
 /**
  * Update the reply with its forum id it is in
+ * Update the reply with its forum id it is in.
+ *
  * @since 2.0.0 bbPress (r2855)
+ *
  * @param int $reply_id Optional. Reply id to update
  * @param int $forum_id Optional. Forum id
  * @return bool The forum id of the reply
+ * @param int $reply_id Optional. Reply id to update.
+ * @param int $forum_id Optional. Forum id.
+ * @return bool The forum id of the reply.
  */
 function bbp_update_reply_forum_id( $reply_id = 0, $forum_id = 0 ) {
 …
 /**
  * Update the reply with its topic id it is in
+ * Update the reply with its topic id it is in.
+ *
  * @since 2.0.0 bbPress (r2855)
+ *
  * @param int $reply_id Optional. Reply id to update
  * @param int $topic_id Optional. Topic id
  * @return bool The topic id of the reply
+ * @param int $reply_id Optional. Reply id to update.
+ * @param int $topic_id Optional. Topic id.
+ * @return bool The topic id of the reply.
  */
 function bbp_update_reply_topic_id( $reply_id = 0, $topic_id = 0 ) {
 …
 /*
  * Update the meta data with its parent reply-to id, of a reply
+ * Update the meta data with its parent reply-to id, of a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param int $reply_id Reply id to update
  * @param int $reply_to Optional. Reply to id
  * @return bool The parent reply id of the reply
+ * @param int $reply_id Reply id to update.
+ * @param int $reply_to Optional. Reply to id.
+ * @return bool The parent reply id of the reply.
  */
 function bbp_update_reply_to( $reply_id = 0, $reply_to = 0 ) {
 …
 /**
  * Get all ancestors to a reply
+ * Get all ancestors to a reply.
+ *
  * Because settings can be changed, this function does not care if hierarchical
 …
 /**
  * Update the revision log of the reply
+ * Update the revision log of the reply.
+ *
  * @since 2.0.0 bbPress (r2782)
 …
  *  - reason: Reason for editing
  *  - revision_id: Revision id
  * @return mixed False on failure, true on success
+ * @return mixed False on failure, true on success.
  */
 function bbp_update_reply_revision_log( $args = array() ) {
 …
 /**
  * Move reply handler
+ *
  * Handles the front end move reply submission
+ * Move reply handler.
+ *
+ * Handles the front end move reply submission.
+ *
  * @since 2.3.0 bbPress (r4521)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_move_reply_handler( $action = '' ) {
 …
 /**
  * Fix counts on reply move
+ * Fix counts on reply move.
+ *
  * When a reply is moved, update the counts of source and destination topic
 …
  * @since 2.3.0 bbPress (r4521)
+ *
  * @param int $move_reply_id Move reply id
  * @param int $source_topic_id Source topic id
  * @param int $destination_topic_id Destination topic id
+ * @param int $move_reply_id Move reply id.
+ * @param int $source_topic_id Source topic id.
+ * @param int $destination_topic_id Destination topic id.
  */
 function bbp_move_reply_count( $move_reply_id, $source_topic_id, $destination_topic_id ) {
 …
 /**
  * Handles the front end spamming/unspamming and trashing/untrashing/deleting of
  * replies
+ * replies.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_toggle_reply_handler( $action = '' ) {
 …
 /**
  * Do the actual reply toggling
+ * Do the actual reply toggling.
+ *
  * This function is used by `bbp_toggle_reply_handler()` to do the actual heavy
 …
 /**
  * Return an associative array of available reply statuses
+ * Return an associative array of available reply statuses.
+ *
  * @since 2.6.0 bbPress (r5399)
+ *
  * @param int $reply_id   Optional. Reply id.
+ * @param int $reply_id Optional. Reply id.
+ *
  * @return array
 …
 /**
  * Return array of available reply toggle actions
+ * Return array of available reply toggle actions.
+ *
  * @since 2.6.0 bbPress (r6133)
+ *
  * @param int $reply_id   Optional. Reply id.
+ * @param int $reply_id Optional. Reply id.
+ *
  * @return array
 …
 /**
  * Marks a reply as spam
+ * Marks a reply as spam.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param int $reply_id Reply id
  * @return mixed False or {@link WP_Error} on failure, reply id on success
+ * @param int $reply_id Reply id.
+ * @return mixed False or {@link WP_Error} on failure, reply id on success.
  */
 function bbp_spam_reply( $reply_id = 0 ) {
 …
 /**
  * Unspams a reply
+ * Unspams a reply.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param int $reply_id Reply id
  * @return mixed False or {@link WP_Error} on failure, reply id on success
+ * @param int $reply_id Reply id.
+ * @return mixed False or {@link WP_Error} on failure, reply id on success.
  */
 function bbp_unspam_reply( $reply_id = 0 ) {
 …
 /**
  * Approves a reply
+ * Approves a reply.
+ *
  * @since 2.6.0 bbPress (r5506)
+ *
  * @param int $reply_id Reply id
  * @return mixed False or {@link WP_Error} on failure, reply id on success
+ * @param int $reply_id Reply id.
+ * @return mixed False or {@link WP_Error} on failure, reply id on success.
  */
 function bbp_approve_reply( $reply_id = 0 ) {
 …
 /**
  * Unapproves a reply
+ * Unapproves a reply.
+ *
  * @since 2.6.0 bbPress (r5506)
+ *
  * @param int $reply_id Reply id
  * @return mixed False or {@link WP_Error} on failure, reply id on success
+ * @param int $reply_id Reply id.
+ * @return mixed False or {@link WP_Error} on failure, reply id on success.
  */
 function bbp_unapprove_reply( $reply_id = 0 ) {
 …
 /**
+ * Called before deleting a reply
+ * Called before deleting a reply.
+ *
+ * @since 2.0.0 bbPress (r2895)
  */
 function bbp_delete_reply( $reply_id = 0 ) {
 …
 /**
+ * Called before trashing a reply
+ * Called before trashing a reply.
+ *
+ * @since 2.0.0 bbPress (r2895)
  */
 function bbp_trash_reply( $reply_id = 0 ) {
 …
 /**
+ * Called before untrashing (restoring) a reply
+ * Called before untrashing (restoring) a reply.
+ *
+ * @since 2.0.0 bbPress (r2895)
  */
 function bbp_untrash_reply( $reply_id = 0 ) {
 …
 /**
  * Called after deleting a reply
+ * Called after deleting a reply.
+ *
  * @since 2.0.0 bbPress (r2993)
 …
 /**
  * Called after trashing a reply
+ * Called after trashing a reply.
+ *
  * @since 2.0.0 bbPress (r2993)
 …
 /**
  * Called after untrashing (restoring) a reply
+ * Called after untrashing (restoring) a reply.
+ *
  * @since 2.0.0 bbPress (r2993)
 …
 /**
  * Return the replies per page setting
+ * Return the replies per page setting.
+ *
  * @since 2.0.0 bbPress (r3540)
+ *
  * @param int $default Default replies per page (15)
+ * @param int $default Default replies per page (15).
  * @return int
  */
 …
 /**
  * Return the replies per RSS page setting
+ * Return the replies per RSS page setting.
+ *
  * @since 2.0.0 bbPress (r3540)
+ *
  * @param int $default Default replies per page (25)
+ * @param int $default Default replies per page (25).
  * @return int
  */
 …
 /**
  * Check if autoembeds are enabled and hook them in if so
+ * Check if auto-embeds are enabled and hook them in if so.
+ *
  * @since 2.1.0 bbPress (r3752)
 …
 /**
  * Used by bbp_has_replies() to add the lead topic post to the posts loop
+ * Used by bbp_has_replies() to add the lead topic post to the posts loop.
+ *
  * This function filters the 'post_where' of the WP_Query, and changes the query
 …
 /**
  * Redirect if unauthorized user is attempting to edit a reply
+ * Redirect if unauthorized user is attempting to edit a reply.
+ *
  * @since 2.1.0 bbPress (r3605)
 …
+ *
  * @since 2.4.0 bbPress (r4944)
  * @since 2.6.0 bbPress (r6245) Always false on user profile reply pages
+ *
  * @param bool $default Optional. Default value true
+ * @since 2.6.0 bbPress (r6245) Always false on user profile reply pages.
+ *
+ * @param bool $default Optional. Default value true.
+ *
  * @return bool Are replies threaded?
 …
 /**
  * List threaded replies
+ * List threaded replies.
+ *
  * @since 2.4.0 bbPress (r4944)
 …
 /**
  * Validate a `reply_to` field for hierarchical replies
+ * Validate a `reply_to` field for hierarchical replies.
+ *
  * Checks for 2 scenarios:

trunk/src/includes/replies/template.php

-                      r7379
+                      r7380
 /**
  * bbPress Reply Template Tags
+ * bbPress Reply Template Tags.
+ *
  * @package bbPress
 …
 /**
  * Return the unique id of the custom post type for replies
+ * Return the unique id of the custom post type for replies.
+ *
  * @since 2.0.0 bbPress (r2857)
 …
 /**
  * Return the unique id of the custom post type for replies
+ * Return the unique id of the custom post type for replies.
+ *
  * @since 2.0.0 bbPress (r2857)
+ *
+ *                        post type id
+ * @return string The unique reply post type id
+ * @return string The unique reply post type id.
  */
 function bbp_get_reply_post_type() {
 …
 /**
  * Return array of labels used by the reply post type
+ * Return array of labels used by the reply post type.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return array of reply post type rewrite settings
+ * Return array of reply post type rewrite settings.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return array of features the reply post type supports
+ * Return array of features the reply post type supports.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * The main reply loop. WordPress makes this easy for us
+ * The main reply loop. WordPress makes this easy for us.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param array $args All the arguments supported by {@link WP_Query}
  * @return object Multidimensional array of reply information
+ * @param array $args All the arguments supported by {@link WP_Query}.
+ * @return object Multidimensional array of reply information.
  */
 function bbp_has_replies( $args = array() ) {
 …
 /**
  * Whether there are more replies available in the loop
+ * Whether there are more replies available in the loop.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @return object Replies information
+ * @return object Replies information.
  */
 function bbp_replies() {
 …
 /**
  * Loads up the current reply in the loop
+ * Loads up the current reply in the loop.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @return object Reply information
+ * @return object Reply information.
  */
 function bbp_the_reply() {
 …
 /**
  * Output reply id
+ * Output reply id.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param $reply_id Optional. Used to check emptiness
+ * @param $reply_id Optional. Used to check emptiness.
  */
 function bbp_reply_id( $reply_id = 0 ) {
 …
 /**
  * Return the id of the reply in a replies loop
+ * Return the id of the reply in a replies loop.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param $reply_id Optional. Used to check emptiness
  * @return int The reply id
+ * @param $reply_id Optional. Used to check emptiness.
+ * @return int The reply id.
  */
 function bbp_get_reply_id( $reply_id = 0 ) {
 …
 /**
  * Gets a reply
+ * Gets a reply.
+ *
  * @since 2.0.0 bbPress (r2787)
+ *
  * @param int|object $reply reply id or reply object
  * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT
  * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}
  * @return mixed Null if error or reply (in specified form) if success
+ * @param int|object $reply reply id or reply object.
+ * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT.
+ * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}.
+ * @return mixed Null if error or reply (in specified form) if success.
  */
 function bbp_get_reply( $reply, $output = OBJECT, $filter = 'raw' ) {
 …
 /**
  * Output the link to the reply in the reply loop
+ * Output the link to the reply in the reply loop.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_permalink( $reply_id = 0 ) {
 …
 /**
  * Return the link to the reply
+ * Return the link to the reply.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
+ *
  * @return string Permanent link to reply
+ * @param int $reply_id Optional. Reply id.
+ *
+ * @return string Permanent link to reply.
  */
 function bbp_get_reply_permalink( $reply_id = 0 ) {
 …
 /**
  * Output the paginated url to the reply in the reply loop
+ * Output the paginated url to the reply in the reply loop.
+ *
  * @since 2.0.0 bbPress (r2679)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_url( $reply_id = 0 ) {
 …
 /**
  * Return the paginated url to the reply in the reply loop
+ * Return the paginated url to the reply in the reply loop.
+ *
  * @since 2.0.0 bbPress (r2679)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  * @param string $redirect_to Optional. Pass a redirect value for use with
  *                              shortcodes and other fun things.
  * @return string Link to reply relative to paginated topic
+ * @return string Link to reply relative to paginated topic.
  */
 function bbp_get_reply_url( $reply_id = 0, $redirect_to = '' ) {
 …
 /**
  * Output the title of the reply
+ * Output the title of the reply.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_title( $reply_id = 0 ) {
 …
 /**
  * Return the title of the reply
+ * Return the title of the reply.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Title of reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Title of reply.
  */
 function bbp_get_reply_title( $reply_id = 0 ) {
 …
  * @since 2.5.0 bbPress (r5177)
+ *
  * @param string $post_title Required. Reply Title
  * @param int $post_id Required. Reply ID
  * @return string Title of reply
+ * @param string $post_title Required. Reply Title.
+ * @param int $post_id Required. Reply ID.
+ * @return string Title of reply.
  */
 function bbp_get_reply_title_fallback( $post_title = '', $post_id = 0 ) {
 …
 /**
  * Output the content of the reply
+ * Output the content of the reply.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. reply id
+ * @param int $reply_id Optional. reply id.
  */
 function bbp_reply_content( $reply_id = 0 ) {
 …
 /**
  * Return the content of the reply
+ * Return the content of the reply.
+ *
  * @since 2.0.0 bbPress (r2780)
+ *
  * @param int $reply_id Optional. reply id
  * @return string Content of the reply
+ * @param int $reply_id Optional. reply id.
+ * @return string Content of the reply.
  */
 function bbp_get_reply_content( $reply_id = 0 ) {
 …
 /**
  * Output the excerpt of the reply
+ * Output the excerpt of the reply.
+ *
  * @since 2.0.0 bbPress (r2751)
+ *
  * @param int $reply_id Optional. Reply id
  * @param int $length Optional. Length of the excerpt. Defaults to 100 letters
+ * @param int $reply_id Optional. Reply id.
+ * @param int $length Optional. Length of the excerpt. Defaults to 100 letters.
  */
 function bbp_reply_excerpt( $reply_id = 0, $length = 100 ) {
 …
 /**
  * Return the excerpt of the reply
+ * Return the excerpt of the reply.
+ *
  * @since 2.0.0 bbPress (r2751)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  * @param int $length Optional. Length of the excerpt. Defaults to 100
  *                     letters
  * @return string Reply Excerpt
+ *                     letters.
+ * @return string Reply Excerpt.
  */
 function bbp_get_reply_excerpt( $reply_id = 0, $length = 100 ) {
 …
 /**
  * Output the post date and time of a reply
+ * Output the post date and time of a reply.
+ *
  * @since 2.2.0 bbPress (r4155)
+ *
  * @param int $reply_id Optional. Reply id.
  * @param bool $humanize Optional. Humanize output using time_since
  * @param bool $gmt Optional. Use GMT
+ * @param bool $humanize Optional. Humanize output using time_since.
+ * @param bool $gmt Optional. Use GMT.
  */
 function bbp_reply_post_date( $reply_id = 0, $humanize = false, $gmt = false ) {
 …
 /**
  * Return the post date and time of a reply
+ * Return the post date and time of a reply.
+ *
  * @since 2.2.0 bbPress (r4155)
+ *
  * @param int $reply_id Optional. Reply id.
  * @param bool $humanize Optional. Humanize output using time_since
  * @param bool $gmt Optional. Use GMT
+ * @param bool $humanize Optional. Humanize output using time_since.
+ * @param bool $gmt Optional. Use GMT.
  * @return string
  */
 …
 /**
  * Append revisions to the reply content
+ * Append revisions to the reply content.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param string $content Optional. Content to which we need to append the revisions to
  * @param int $reply_id Optional. Reply id
  * @return string Content with the revisions appended
+ * @param string $content Optional. Content to which we need to append the revisions to.
+ * @param int $reply_id Optional. Reply id.
+ * @return string Content with the revisions appended.
  */
 function bbp_reply_content_append_revisions( $content = '', $reply_id = 0 ) {
 …
 /**
  * Output the revision log of the reply
+ * Output the revision log of the reply.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_revision_log( $reply_id = 0 ) {
 …
 /**
  * Return the formatted revision log of the reply
+ * Return the formatted revision log of the reply.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Revision log of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Revision log of the reply.
  */
 function bbp_get_reply_revision_log( $reply_id = 0 ) {
 …
 /**
  * Return the raw revision log of the reply
+ * Return the raw revision log of the reply.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Raw revision log of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Raw revision log of the reply.
  */
 function bbp_get_reply_raw_revision_log( $reply_id = 0 ) {
 …
 /**
  * Return the revisions of the reply
+ * Return the revisions of the reply.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $reply_id Optional. Reply id
  * @return WP_Post[]|int[] reply revisions
+ * @param int $reply_id Optional. Reply id.
+ * @return WP_Post[]|int[] reply revisions.
  */
 function bbp_get_reply_revisions( $reply_id = 0 ) {
 …
 /**
  * Return the revision count of the reply
+ * Return the revision count of the reply.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $reply_id Optional. Reply id
  * @param boolean $integer Optional. Whether or not to format the result
  * @return string reply revision count
+ * @param int $reply_id Optional. Reply id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ * @return string reply revision count.
  */
 function bbp_get_reply_revision_count( $reply_id = 0, $integer = false ) {
 …
 /**
  * Output the status of the reply
+ * Output the status of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_status( $reply_id = 0 ) {
 …
 /**
  * Return the status of the reply
+ * Return the status of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Status of reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Status of reply.
  */
 function bbp_get_reply_status( $reply_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r6391)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  * @return bool True if public, false if not.
  */
 …
  * @since 2.6.0 bbPress (r6922) Returns false if topic is also not published
+ *
  * @param int $reply_id Optional. Topic id
+ * @param int $reply_id Optional. Topic id.
  * @return bool True if published, false if not.
  */
 …
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  * @return bool True if spam, false if not.
  */
 …
  * @since 2.0.0 bbPress (r2884)
+ *
  * @param int $reply_id Optional. Topic id
+ * @param int $reply_id Optional. Topic id.
  * @return bool True if spam, false if not.
  */
 …
  * @since 2.6.0 bbPress (r5507)
+ *
  * @param int $reply_id Optional. Topic id
+ * @param int $reply_id Optional. Topic id.
  * @return bool True if pending, false if not.
  */
 …
  * @since 2.6.0 bbPress (r5507)
+ *
  * @param int $reply_id Optional. Topic id
+ * @param int $reply_id Optional. Topic id.
  * @return bool True if private, false if not.
  */
 …
  * @since 2.0.0 bbPress (r2753)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  * @return bool True if the post is by an anonymous user, false if not.
  */
 …
  * Deprecated. Use bbp_reply_author_display_name() instead.
+ *
  * Output the author of the reply
+ * Output the author of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
 …
  * @deprecated 2.5.0 bbPress (r5119)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_author( $reply_id = 0 ) {
 …
  * Deprecated. Use bbp_get_reply_author_display_name() instead.
+ *
  * Return the author of the reply
+ * Return the author of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
 …
  * @deprecated 2.5.0 bbPress (r5119)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Author of reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Author of reply.
  */
 function bbp_get_reply_author( $reply_id = 0 ) {
 …
 /**
  * Output the author ID of the reply
+ * Output the author ID of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_author_id( $reply_id = 0 ) {
 …
 /**
  * Return the author ID of the reply
+ * Return the author ID of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Author id of reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Author id of reply.
  */
 function bbp_get_reply_author_id( $reply_id = 0 ) {
 …
 /**
  * Output the author display_name of the reply
+ * Output the author display_name of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_author_display_name( $reply_id = 0 ) {
 …
 /**
  * Return the author display_name of the reply
+ * Return the author display_name of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string The display name of the author of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string The display name of the author of the reply.
  */
 function bbp_get_reply_author_display_name( $reply_id = 0 ) {
 …
 /**
  * Output the author avatar of the reply
+ * Output the author avatar of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
  * @param int $size Optional. Size of the avatar. Defaults to 40
+ * @param int $reply_id Optional. Reply id.
+ * @param int $size Optional. Size of the avatar. Defaults to 40.
  */
 function bbp_reply_author_avatar( $reply_id = 0, $size = 40 ) {
 …
 /**
  * Return the author avatar of the reply
+ * Return the author avatar of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
  * @param int $size Optional. Size of the avatar. Defaults to 40
  * @return string Avatar of author of the reply
+ * @param int $size Optional. Size of the avatar. Defaults to 40.
+ * @return string Avatar of author of the reply.
  */
 function bbp_get_reply_author_avatar( $reply_id = 0, $size = 40 ) {
 …
 /**
  * Output the author link of the reply
+ * Output the author link of the reply.
+ *
  * @since 2.0.0 bbPress (r2717)
 …
 /**
  * Return the author link of the reply
+ * Return the author link of the reply.
+ *
  * @since 2.0.0 bbPress (r2717)
+ *
  * @param array $args Optional. If an integer, it is used as reply id.
  * @return string Author link of reply
+ * @return string Author link of reply.
  */
 function bbp_get_reply_author_link( $args = array() ) {
 …
 /**
  * Output the author url of the reply
+ * Output the author url of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_author_url( $reply_id = 0 ) {
 …
 /**
  * Return the author url of the reply
+ * Return the author url of the reply.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Author URL of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string Author URL of the reply.
  */
 function bbp_get_reply_author_url( $reply_id = 0 ) {
 …
 /**
  * Output the reply author email address
+ * Output the reply author email address.
+ *
  * @since 2.0.0 bbPress (r3445)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_author_email( $reply_id = 0 ) {
 …
 /**
  * Return the reply author email address
+ * Return the reply author email address.
+ *
  * @since 2.0.0 bbPress (r3445)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Reply author email address
+ * @param int $reply_id Optional. Reply id.
+ * @return string Reply author email address.
  */
 function bbp_get_reply_author_email( $reply_id = 0 ) {
 …
 /**
  * Output the reply author role
+ * Output the reply author role.
+ *
  * @since 2.1.0 bbPress (r3860)
 …
 /**
  * Return the reply author role
+ * Return the reply author role.
+ *
  * @since 2.1.0 bbPress (r3860)
+ *
  * @param array $args Optional.
  * @return string Reply author role
+ * @return string Reply author role.
  */
 function bbp_get_reply_author_role( $args = array() ) {
 …
 /**
  * Output the topic title a reply belongs to
+ * Output the topic title a reply belongs to.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_topic_title( $reply_id = 0 ) {
 …
 /**
  * Return the topic title a reply belongs to
+ * Return the topic title a reply belongs to.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string The topic title of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return string The topic title of the reply.
  */
 function bbp_get_reply_topic_title( $reply_id = 0 ) {
 …
 /**
  * Output the topic id a reply belongs to
+ * Output the topic id a reply belongs to.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_topic_id( $reply_id = 0 ) {
 …
 /**
  * Return the topic id a reply belongs to
+ * Return the topic id a reply belongs to.
+ *
  * @since 2.0.0 bbPress (r2553)
+ *
  * @param int $reply_id Optional. Reply id
  * @return int The topic id of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return int The topic id of the reply.
  */
 function bbp_get_reply_topic_id( $reply_id = 0 ) {
 …
 /**
  * Output the forum id a reply belongs to
+ * Output the forum id a reply belongs to.
+ *
  * @since 2.0.0 bbPress (r2679)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_forum_id( $reply_id = 0 ) {
 …
 /**
  * Return the forum id a reply belongs to
+ * Return the forum id a reply belongs to.
+ *
  * @since 2.0.0 bbPress (r2679)
+ *
  * @param int $reply_id Optional. Reply id
+ *
  * @return int The forum id of the reply
+ * @param int $reply_id Optional. Reply id.
+ *
+ * @return int The forum id of the reply.
  */
 function bbp_get_reply_forum_id( $reply_id = 0 ) {
 …
 /**
  * Output the ancestor reply id of a reply
+ * Output the ancestor reply id of a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_ancestor_id( $reply_id = 0 ) {
 …
 /**
  * Return the ancestor reply id of a reply
+ * Return the ancestor reply id of a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param in $reply_id Reply id
+ * @param in $reply_id Reply id.
  */
 function bbp_get_reply_ancestor_id( $reply_id = 0 ) {
 …
 /**
  * Output the reply to id of a reply
+ * Output the reply to id of a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_to( $reply_id = 0 ) {
 …
 /**
  * Return the reply to id of a reply
+ * Return the reply to id of a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param int $reply_id Optional. Reply id
  * @return int The parent reply id of the reply
+ * @param int $reply_id Optional. Reply id.
+ * @return int The parent reply id of the reply.
  */
 function bbp_get_reply_to( $reply_id = 0 ) {
 …
 /**
  * Output the link for the reply to
+ * Output the link for the reply to.
+ *
  * @since 2.4.0 bbPress (r4944)
 …
 /**
  * Return the link for a reply to a reply
+ * Return the link for a reply to a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param array $args Arguments
  * @return string Link for a reply to a reply
+ * @param array $args Arguments.
+ * @return string Link for a reply to a reply.
  */
 function bbp_get_reply_to_link( $args = array() ) {
 …
 /**
  * Output the reply to a reply cancellation link
+ * Output the reply to a reply cancellation link.
+ *
  * @since 2.4.0 bbPress (r4944)
 …
 /**
  * Return the cancellation link for a reply to a reply
+ * Return the cancellation link for a reply to a reply.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @param string $text The cancel text
  * @return string The cancellation link
+ * @param string $text The cancel text.
+ * @return string The cancellation link.
  */
 function bbp_get_cancel_reply_to_link( $text = '' ) {
 …
 /**
  * Output the numeric position of a reply within a topic
+ * Output the numeric position of a reply within a topic.
+ *
  * @since 2.0.0 bbPress (r2984)
+ *
  * @param int $reply_id Optional. Reply id
  * @param int $topic_id Optional. Topic id
+ * @param int $reply_id Optional. Reply id.
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_reply_position( $reply_id = 0, $topic_id = 0 ) {
 …
 /**
  * Return the numeric position of a reply within a topic
+ * Return the numeric position of a reply within a topic.
+ *
  * @since 2.0.0 bbPress (r2984)
+ *
  * @param int $reply_id Optional. Reply id
  * @param int $topic_id Optional. Topic id
  * @return int Reply position
+ * @param int $reply_id Optional. Reply id.
+ * @param int $topic_id Optional. Topic id.
+ * @return int Reply position.
  */
 function bbp_get_reply_position( $reply_id = 0, $topic_id = 0 ) {
 …
 /**
  * Output admin links for reply
+ * Output admin links for reply.
+ *
  * @since 2.0.0 bbPress (r2667)
 …
 /**
  * Return admin links for reply
+ * Return admin links for reply.
+ *
  * @since 2.0.0 bbPress (r2667)
 …
  *  - links: Array of the links to display. By default, edit, trash,
  *            spam, reply move, and topic split links are displayed
  * @return string Reply admin links
+ * @return string Reply admin links.
  */
 function bbp_get_reply_admin_links( $args = array() ) {
 …
 /**
  * Output the edit link of the reply
+ * Output the edit link of the reply.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param array $args See {@link bbp_get_reply_edit_link()}
+ * @param array $args See {@link bbp_get_reply_edit_link()}.
  */
 function bbp_reply_edit_link( $args = array() ) {
 …
 /**
  * Return the edit link of the reply
+ * Return the edit link of the reply.
+ *
  * @since 2.0.0 bbPress (r2740)
 …
  *  - link_after: HTML after the link
  *  - edit_text: Edit text. Defaults to 'Edit'
  * @return string Reply edit link
+ * @return string Reply edit link.
  */
 function bbp_get_reply_edit_link( $args = array() ) {
 …
 /**
  * Output URL to the reply edit page
+ * Output URL to the reply edit page.
+ *
  * @since 2.0.0 bbPress (r2753)
+ *
  * @param int $reply_id Optional. Reply id
+ * @param int $reply_id Optional. Reply id.
  */
 function bbp_reply_edit_url( $reply_id = 0 ) {
 …
 /**
  * Return URL to the reply edit page
+ * Return URL to the reply edit page.
+ *
  * @since 2.0.0 bbPress (r2753)
+ *
  * @param int $reply_id Optional. Reply id
  * @return string Reply edit url
+ * @param int $reply_id Optional. Reply id.
+ * @return string Reply edit url.
  */
 function bbp_get_reply_edit_url( $reply_id = 0 ) {
 …
 /**
  * Output the trash link of the reply
+ * Output the trash link of the reply.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param array $args See {@link bbp_get_reply_trash_link()}
+ * @param array $args See {@link bbp_get_reply_trash_link()}.
  */
 function bbp_reply_trash_link( $args = array() ) {
 …
 /**
  * Return the trash link of the reply
+ * Return the trash link of the reply.
+ *
  * @since 2.0.0 bbPress (r2740)
 …
  *  - restore_text: Restore text
  *  - delete_text: Delete text
  * @return string Reply trash link
+ * @return string Reply trash link.
  */
 function bbp_get_reply_trash_link( $args = array() ) {
 …
 /**
  * Output the spam link of the reply
+ * Output the spam link of the reply.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param array $args See {@link bbp_get_reply_spam_link()}
+ * @param array $args See {@link bbp_get_reply_spam_link()}.
  */
 function bbp_reply_spam_link( $args = array() ) {
 …
 /**
  * Return the spam link of the reply
+ * Return the spam link of the reply.
+ *
  * @since 2.0.0 bbPress (r2740)
 …
  *  - spam_text: Spam text
  *  - unspam_text: Unspam text
  * @return string Reply spam link
+ * @return string Reply spam link.
  */
 function bbp_get_reply_spam_link( $args = array() ) {
 …
 /**
  * Move reply link
+ *
  * Output the move link of the reply
+ * Move reply link.
+ *
+ * Output the move link of the reply.
+ *
  * @since 2.3.0 bbPress (r4521)
+ *
  * @param array $args See {@link bbp_get_reply_move_link()}
+ * @param array $args See {@link bbp_get_reply_move_link()}.
  */
 function bbp_reply_move_link( $args = array() ) {
 …
 /**
  * Get move reply link
+ *
  * Return the move link of the reply
+ * Get move reply link.
+ *
+ * Return the move link of the reply.
+ *
  * @since 2.3.0 bbPress (r4521)
 …
  *  - move_text: Move text
  *  - move_title: Move title attribute
  * @return string Reply move link
+ * @return string Reply move link.
  */
 function bbp_get_reply_move_link( $args = array() ) {
 …
 /**
  * Split topic link
+ *
  * Output the split link of the topic (but is bundled with each reply)
+ * Split topic link.
+ *
+ * Output the split link of the topic (but is bundled with each reply).
+ *
  * @since 2.0.0 bbPress (r2756)
+ *
  * @param array $args See {@link bbp_get_topic_split_link()}
+ * @param array $args See {@link bbp_get_topic_split_link()}.
  */
 function bbp_topic_split_link( $args = array() ) {
 …
 /**
  * Get split topic link
+ *
  * Return the split link of the topic (but is bundled with each reply)
+ * Get split topic link.
+ *
+ * Return the split link of the topic (but is bundled with each reply).
+ *
  * @since 2.0.0 bbPress (r2756)
 …
  *  - split_text: Split text
  *  - split_title: Split title attribute
  * @return string Topic split link
+ * @return string Topic split link.
  */
 function bbp_get_topic_split_link( $args = array() ) {
 …
 /**
  * Output the approve link of the reply
+ * Output the approve link of the reply.
+ *
  * @since 2.6.0 bbPress (r5507)
+ *
  * @param array $args See {@link bbp_get_reply_approve_link()}
+ * @param array $args See {@link bbp_get_reply_approve_link()}.
  */
 function bbp_reply_approve_link( $args = array() ) {
 …
 /**
  * Return the approve link of the reply
+ * Return the approve link of the reply.
+ *
  * @since 2.6.0 bbPress (r5507)
 …
  *  - approve_text: Approve text
  *  - unapprove_text: Unapprove text
  * @return string Reply approve link
+ * @return string Reply approve link.
  */
 function bbp_get_reply_approve_link( $args = array() ) {
 …
 /**
  * Output the row class of a reply
+ * Output the row class of a reply.
+ *
  * @since 2.0.0 bbPress (r2678)
+ *
  * @param int $reply_id Optional. Reply ID
  * @param array Extra classes you can pass when calling this function
+ * @param int $reply_id Optional. Reply ID.
+ * @param array Extra classes you can pass when calling this function.
  */
 function bbp_reply_class( $reply_id = 0, $classes = array() ) {
 …
 /**
  * Return the row class of a reply
+ * Return the row class of a reply.
+ *
  * @since 2.0.0 bbPress (r2678)
+ *
  * @param int $reply_id Optional. Reply ID
  * @param array Extra classes you can pass when calling this function
  * @return string Row class of the reply
+ * @param int $reply_id Optional. Reply ID.
+ * @param array Extra classes you can pass when calling this function.
+ * @return string Row class of the reply.
  */
 function bbp_get_reply_class( $reply_id = 0, $classes = array() ) {
 …
 /**
  * Return the base URL used inside of pagination links
+ * Return the base URL used inside of pagination links.
+ *
  * @since 2.6.0 bbPress (r6679)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  * @return string
  */
 …
 /**
  * Output the topic pagination count
+ * Output the topic pagination count.
+ *
  * The results are unescaped by design, to allow them to be filtered freely via
 …
 /**
  * Return the topic pagination count
+ * Return the topic pagination count.
+ *
  * @since 2.0.0 bbPress (r2519)
+ *
  * @return string Topic pagination count
+ * @return string Topic pagination count.
  */
 function bbp_get_topic_pagination_count() {
 …
 /**
  * Output topic pagination links
+ * Output topic pagination links.
+ *
  * @since 2.0.0 bbPress (r2519)
 …
 /**
  * Return topic pagination links
+ * Return topic pagination links.
+ *
  * @since 2.0.0 bbPress (r2519)
+ *
  * @return string Topic pagination links
+ * @return string Topic pagination links.
  */
 function bbp_get_topic_pagination_links() {
 …
 /**
  * Output the value of reply content field
+ * Output the value of reply content field.
+ *
  * @since 2.0.0 bbPress (r3130)
 …
 /**
  * Return the value of reply content field
+ * Return the value of reply content field.
+ *
  * @since 2.0.0 bbPress (r3130)
+ *
  * @return string Value of reply content field
+ * @return string Value of reply content field.
  */
 function bbp_get_form_reply_content() {
 …
 /**
  * Output the value of the reply to field
+ * Output the value of the reply to field.
+ *
  * @since 2.4.0 bbPress (r4944)
 …
 /**
  * Return the value of reply to field
+ * Return the value of reply to field.
+ *
  * @since 2.4.0 bbPress (r4944)
+ *
  * @return string Value of reply to field
+ * @return string Value of reply to field.
  */
 function bbp_get_form_reply_to() {
 …
  * @since 2.6.0 bbPress (r5387)
+ *
  * @param int $reply_id
+ * @param int $reply_id Reply id.
  */
 function bbp_reply_to_dropdown( $reply_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5387)
+ *
  * @param int $reply_id
+ *
  * @return string The dropdown
+ * @param int $reply_id Reply id.
+ *
+ * @return string The dropdown.
  */
 function bbp_get_reply_to_dropdown( $reply_id = 0 ) {
 …
 /**
  * Output checked value of reply log edit field
+ * Output checked value of reply log edit field.
+ *
  * @since 2.0.0 bbPress (r3130)
 …
 /**
  * Return checked value of reply log edit field
+ * Return checked value of reply log edit field.
+ *
  * @since 2.0.0 bbPress (r3130)
+ *
  * @return string Reply log edit checked value
+ * @return string Reply log edit checked value.
  */
 function bbp_get_form_reply_log_edit() {
 …
 /**
  * Output the value of the reply edit reason
+ * Output the value of the reply edit reason.
+ *
  * @since 2.0.0 bbPress (r3130)
 …
 /**
  * Return the value of the reply edit reason
+ * Return the value of the reply edit reason.
+ *
  * @since 2.0.0 bbPress (r3130)
+ *
  * @return string Reply edit reason value
+ * @return string Reply edit reason value.
  */
 function bbp_get_form_reply_edit_reason() {
 …
 /**
  * Output value reply status dropdown
+ * Output value reply status dropdown.
+ *
  * @since 2.6.0 bbPress (r5399)
 …
 /**
  * Returns reply status dropdown
+ * Returns reply status dropdown.
+ *
  * This dropdown is only intended to be seen by users with the 'moderate'
 …
  * @since 2.6.0 bbPress (r5558)
+ *
  * @return boolean True if is a post request with valid nonce
+ * @return boolean True if is a post request with valid nonce.
  */
 function bbp_is_reply_form_post_request() {

trunk/src/includes/search/functions.php

-                      r7333
+                      r7380
 /**
  * bbPress Search Functions
+ * bbPress Search Functions.
+ *
  * @package bbPress
 …
 /**
  * Run the search query
+ * Run the search query.
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @param mixed $new_args New arguments
  * @return bool False if no results, otherwise if search results are there
+ * @param mixed $new_args New arguments.
+ * @return bool False if no results, otherwise if search results are there.
  */
 function bbp_search_query( $new_args = array() ) {
 …
 /**
  * Return the search query args
+ * Return the search query arguments.
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @return array Query arguments
+ * @return array Query arguments.
  */
 function bbp_get_search_query_args() {
 …
 /**
  * Redirect to search results page if needed
+ * Redirect to search results page if needed.
+ *
  * @since 2.4.0 bbPress (r4928)
+ *
  * @return If a redirect is not needed
+ * @return If a redirect is not needed.
  */
 function bbp_search_results_redirect() {
 …
 /**
  * Return an array of search types
+ * Return an array of search types.
+ *
  * @since 2.6.0 bbPress (r6903)
 …
  * @since 2.6.0 bbPress (r6903)
+ *
  * @param string $query_arg s|fs|ts|rs
+ * @param string $query_arg s|fs|ts|rs.
+ *
  * @return mixed

trunk/src/includes/search/template.php

-                      r7378
+                      r7380
 /**
  * bbPress Search Template Tags
+ * bbPress Search Template Tags.
+ *
  * @package bbPress
 …
  * @since 2.3.0 bbPress (r4579)
+ *
  * @param array $args All the arguments supported by {@link WP_Query}
  * @return object Multidimensional array of search information
+ * @param array $args All the arguments supported by {@link WP_Query}.
+ * @return object Multidimensional array of search information.
  */
 function bbp_has_search_results( $args = array() ) {
 …
 /**
  * Whether there are more search results available in the loop
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @return object Search information
+ * Whether there are more search results available in the loop.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @return object Search information.
  */
 function bbp_search_results() {
 …
 /**
  * Loads up the current search result in the loop
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @return object Search information
+ * Loads up the current search result in the loop.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @return object Search information.
  */
 function bbp_the_search_result() {
 …
 /**
  * Output the search page title
+ * Output the search page title.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
+}
     /**
+     * Get the search page title
+     *
      * @since 2.3.0 bbPress (r4579)
      */
     function bbp_get_search_title() {
         // Get search terms
         $search_terms = bbp_get_search_terms();
         // No search terms specified
         if ( empty( $search_terms ) ) {
             $title = esc_html__( 'Search', 'bbpress' );
         // Include search terms in title
         } else {
             /* translators: %s: Search query terms */
             $title = sprintf( esc_html__( "Search Results for '%s'", 'bbpress' ), esc_attr( $search_terms ) );
+        }
         // Filter & return
         return apply_filters( 'bbp_get_search_title', $title, $search_terms );
+    }
 /**
  * Output the search url
+/**
+ * Get the search page title.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ */
+function bbp_get_search_title() {
+    // Get search terms
+    $search_terms = bbp_get_search_terms();
+    // No search terms specified
+    if ( empty( $search_terms ) ) {
+        $title = esc_html__( 'Search', 'bbpress' );
+    // Include search terms in title
+    } else {
+        /* translators: %s: Search query terms */
+        $title = sprintf( esc_html__( "Search Results for '%s'", 'bbpress' ), esc_attr( $search_terms ) );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_search_title', $title, $search_terms );
+}
+/**
+ * Output the search url.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
     echo esc_url( bbp_get_search_url() );
+}
+    /**
+     * Return the search url
+     *
+     * @since 2.3.0 bbPress (r4579)
+     *
+     * @return string Search url
+     */
+    function bbp_get_search_url() {
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            // Run through home_url()
+            $url = bbp_get_root_url() . bbp_get_search_slug();
+            $url = user_trailingslashit( $url );
+            $url = home_url( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_search_rewrite_id() => ''
+                ),
+                home_url( '/' )
+            );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_search_url', $url );
+    }
+/**
+ * Output the search results url
+/**
+ * Return the search url.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @return string Search url.
+ */
+function bbp_get_search_url() {
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        // Run through home_url()
+        $url = bbp_get_root_url() . bbp_get_search_slug();
+        $url = user_trailingslashit( $url );
+        $url = home_url( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_search_rewrite_id() => ''
+            ),
+            home_url( '/' )
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_search_url', $url );
+}
+/**
+ * Output the search results url.
+ *
  * @since 2.4.0 bbPress (r4928)
 …
     echo esc_url( bbp_get_search_results_url() );
+}
+    /**
+     * Return the search url
+     *
+     * @since 2.4.0 bbPress (r4928)
+     *
+     * @return string Search url
+     */
+    function bbp_get_search_results_url() {
+        // Get the search terms
+        $search_terms = bbp_get_search_terms();
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            // Root search URL
+            $url = bbp_get_root_url() . bbp_get_search_slug();
+            // Append search terms
+            if ( ! empty( $search_terms ) ) {
+                $url = trailingslashit( $url ) . urlencode( $search_terms );
+            }
+            // Run through home_url()
+            $url = user_trailingslashit( $url );
+            $url = home_url( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_search_rewrite_id() => urlencode( $search_terms )
+                ),
+                home_url( '/' )
+            );
+/**
+ * Return the search url.
+ *
+ * @since 2.4.0 bbPress (r4928)
+ *
+ * @return string Search url.
+ */
+function bbp_get_search_results_url() {
+    // Get the search terms
+    $search_terms = bbp_get_search_terms();
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        // Root search URL
+        $url = bbp_get_root_url() . bbp_get_search_slug();
+        // Append search terms
+        if ( ! empty( $search_terms ) ) {
+            $url = trailingslashit( $url ) . urlencode( $search_terms );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_search_results_url', $url );
+    }
+/**
+ * Output the search terms
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @param string $search_terms Optional. Search terms
+        // Run through home_url()
+        $url = user_trailingslashit( $url );
+        $url = home_url( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_search_rewrite_id() => urlencode( $search_terms )
+            ),
+            home_url( '/' )
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_search_results_url', $url );
+}
+/**
+ * Output the search terms.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @param string $search_terms Optional. Search terms.
  */
 function bbp_search_terms( $search_terms = '' ) {
 …
+}
+    /**
+     * Get the search terms
+     *
+     * @since 2.3.0 bbPress (r4579)
+     *
+     * If search terms are supplied, those are used. Otherwise check the
+     * search rewrite id query var.
+     *
+     * @param string $passed_terms Optional. Search terms
+     * @return bool|string Search terms on success, false on failure
+     */
+    function bbp_get_search_terms( $passed_terms = '' ) {
+        // Sanitize terms if they were passed in
+        if ( ! empty( $passed_terms ) ) {
+            $search_terms = sanitize_title( $passed_terms );
+        // Use query variable if not
+/**
+ * Get the search terms.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * If search terms are supplied, those are used. Otherwise check the
+ * search rewrite id query var.
+ *
+ * @param string $passed_terms Optional. Search terms.
+ * @return bool|string Search terms on success, false on failure.
+ */
+function bbp_get_search_terms( $passed_terms = '' ) {
+    // Sanitize terms if they were passed in
+    if ( ! empty( $passed_terms ) ) {
+        $search_terms = sanitize_title( $passed_terms );
+    // Use query variable if not
+    } else {
+        // Global
+        $search_terms = get_query_var( bbp_get_search_rewrite_id(), null );
+        // Searching globally
+        if ( ! is_null( $search_terms ) ) {
+            $search_terms = wp_unslash( $search_terms );
+        // Other searches
         } else {
+            // Global
+            $search_terms = get_query_var( bbp_get_search_rewrite_id(), null );
+            // Searching globally
+            if ( ! is_null( $search_terms ) ) {
+                $search_terms = wp_unslash( $search_terms );
+            // Other searches
+            } else {
+                // Get known search type IDs
+                $types = bbp_get_search_type_ids();
+                // Filterable, so make sure types exist
+                if ( ! empty( $types ) ) {
+                    // Loop through types
+                    foreach ( $types as $type ) {
+                        // Look for search terms
+                        $terms = bbp_sanitize_search_request( $type );
+                        // Skip if no terms
+                        if ( empty( $terms ) ) {
+                            continue;
+                        }
+                        // Set terms if not empty
+                        $search_terms = $terms;
+            // Get known search type IDs
+            $types = bbp_get_search_type_ids();
+            // Filterable, so make sure types exist
+            if ( ! empty( $types ) ) {
+                // Loop through types
+                foreach ( $types as $type ) {
+                    // Look for search terms
+                    $terms = bbp_sanitize_search_request( $type );
+                    // Skip if no terms
+                    if ( empty( $terms ) ) {
+                        continue;
+                    }
+                    // Set terms if not empty
+                    $search_terms = $terms;
+                }
+            }
+        }
+        // Trim whitespace & decode if non-empty string, or set to false
+        $search_terms = ! empty( $search_terms ) && is_string( $search_terms )
+            ? urldecode( trim( $search_terms ) )
+            : false;
+        // Filter & return
+        return apply_filters( 'bbp_get_search_terms', $search_terms, $passed_terms );
+    }
+    }
+    // Trim whitespace & decode if non-empty string, or set to false
+    $search_terms = ! empty( $search_terms ) && is_string( $search_terms )
+        ? urldecode( trim( $search_terms ) )
+        : false;
+    // Filter & return
+    return apply_filters( 'bbp_get_search_terms', $search_terms, $passed_terms );
+}
 /** Pagination ****************************************************************/
 /**
  * Return the base URL used inside of pagination links
+ * Return the base URL used inside of pagination links.
+ *
  * @since 2.6.0 bbPress (r6679)
 …
 /**
  * Output the search result pagination count
+ * Output the search result pagination count.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
 /**
  * Return the search results pagination count
+ *
  * @since 2.3.0 bbPress (r4579)
+ *
  * @return string Search pagination count
+ * Return the search results pagination count.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @return string Search pagination count.
  */
 function bbp_get_search_pagination_count() {
 …
 /**
  * Output search pagination links
+ * Output search pagination links.
+ *
  * @since 2.3.0 bbPress (r4579)
 …
+}
     /**
+     * Return search pagination links
+     *
      * @since 2.3.0 bbPress (r4579)
+     *
+     * @return string Search pagination links
      */
     function bbp_get_search_pagination_links() {
         $bbp = bbpress();
         if ( ! isset( $bbp->search_query->pagination_links ) || empty( $bbp->search_query->pagination_links ) ) {
             return false;
+        }
         // Filter & return
         return apply_filters( 'bbp_get_search_pagination_links', $bbp->search_query->pagination_links );
+    }
+/**
+ * Return search pagination links.
+ *
+ * @since 2.3.0 bbPress (r4579)
+ *
+ * @return string Search pagination links.
+ */
+function bbp_get_search_pagination_links() {
+    $bbp = bbpress();
+    if ( ! isset( $bbp->search_query->pagination_links ) || empty( $bbp->search_query->pagination_links ) ) {
+        return false;
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_search_pagination_links', $bbp->search_query->pagination_links );
+}

trunk/src/includes/topics/capabilities.php

-                      r7378
+                      r7380
 /**
  * bbPress Topic Capabilites
+ * bbPress Topic Capabilities.
+ *
  * Used to map topic capabilities to WordPress's existing capabilities.
 …
 /**
  * Return topic capabilities
+ * Return topic capabilities.
+ *
  * @since 2.0.0 bbPress (r2593)
+ *
  * @return array Topic capabilities
+ * @return array Topic capabilities.
  */
 function bbp_get_topic_caps() {
 …
 /**
  * Return topic tag capabilities
+ * Return topic tag capabilities.
+ *
  * @since 2.0.0 bbPress (r2593)
+ *
+ *
+ * @return array Topic tag capabilities
+ * @return array Topic tag capabilities.
  */
 function bbp_get_topic_tag_caps() {
 …
 /**
  * Maps topic capabilities
+ * Maps topic capabilities.
+ *
  * @since 2.2.0 bbPress (r4242)
 …
  * @param array  $args    Arguments.
+ *
  * @return array Actual capabilities for meta capability
+ * @return array Actual capabilities for meta capability.
  */
 function bbp_map_topic_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {
 …
 /**
  * Maps topic tag capabilities
+ * Maps topic tag capabilities.
+ *
  * @since 2.2.0 bbPress (r4242)
+ *
  * @param array $caps Capabilities for meta capability
  * @param string $cap Capability name
  * @param int $user_id User id
  * @param array $args Arguments
+ *
  * @return array Actual capabilities for meta capability
+ * @param array $caps Capabilities for meta capability.
+ * @param string $cap Capability name.
+ * @param int $user_id User id.
+ * @param array $args Arguments.
+ *
+ * @return array Actual capabilities for meta capability.
  */
 function bbp_map_topic_tag_meta_caps( $caps, $cap, $user_id, $args ) {

trunk/src/includes/topics/functions.php

-                      r7379
+                      r7380
 /**
  * bbPress Topic Functions
+ * bbPress Topic Functions.
+ *
  * @package bbPress
 …
  * @since 2.0.0 bbPress (r3349)
+ *
+ * @param array $topic_data Forum post data
+ * @param array $topic_meta Forum meta data
+ * @param array $topic_data Forum post data.
+ * @param array $topic_meta Forum meta data.
+ *
+ * @return int|false Topic ID on success, false on failure.
  */
 function bbp_insert_topic( $topic_data = array(), $topic_meta = array() ) {
 …
 /**
  * Handles the front end topic submission
+ *
  * @param string $action The requested action to compare this function to
+ * Handles the front end topic submission.
+ *
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_new_topic_handler( $action = '' ) {
 …
 /**
  * Handles the front end edit topic submission
+ *
  * @param string $action The requested action to compare this function to
+ * Handles the front end edit topic submission.
+ *
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_edit_topic_handler( $action = '' ) {
 …
 /**
  * Handle all the extra meta stuff from posting a new topic
+ *
  * @param int $topic_id Optional. Topic id
  * @param int $forum_id Optional. Forum id
+ * Handle all the extra meta stuff from posting a new topic.
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @param int $forum_id Optional. Forum id.
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
  * @param int $author_id Author id
+ * @param int $author_id Author id.
  * @param bool $is_edit Optional. Is the post being edited? Defaults to false.
  */
 …
  * @since 2.0.0 bbPress (r2800)
+ *
  * @param int $topic_id Topic id
  * @param string $last_active_time Optional. Last active time
  * @param int $forum_id Optional. Forum id
  * @param int $reply_id Optional. Reply id
+ * @param int $topic_id Topic id.
+ * @param string $last_active_time Optional. Last active time.
+ * @param int $forum_id Optional. Forum id.
+ * @param int $reply_id Optional. Reply id.
  * @param bool $refresh Reset all the previous parameters? Defaults to true.
  */
 …
 /**
  * Merge topic handler
+ *
  * Handles the front end merge topic submission
+ * Merge topic handler.
+ *
+ * Handles the front end merge topic submission.
+ *
  * @since 2.0.0 bbPress (r2756)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_merge_topic_handler( $action = '' ) {
 …
 /**
  * Fix counts on topic merge
+ * Fix counts on topic merge.
+ *
  * When a topic is merged, update the counts of source and destination topic
 …
  * @since 2.0.0 bbPress (r2756)
+ *
  * @param int $destination_topic_id Destination topic id
  * @param int $source_topic_id Source topic id
  * @param int $source_topic_forum_id Source topic's forum id
+ * @param int $destination_topic_id Destination topic id.
+ * @param int $source_topic_id Source topic id.
+ * @param int $source_topic_forum_id Source topic's forum id.
  */
 function bbp_merge_topic_count( $destination_topic_id, $source_topic_id, $source_topic_forum_id ) {
 …
 /**
  * Split topic handler
+ *
  * Handles the front end split topic submission
+ * Split topic handler.
+ *
+ * Handles the front end split topic submission.
+ *
  * @since 2.0.0 bbPress (r2756)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_split_topic_handler( $action = '' ) {
 …
 /**
  * Fix counts on topic split
+ * Fix counts on topic split.
+ *
  * When a topic is split, update the counts of source and destination topic
 …
  * @since 2.0.0 bbPress (r2756)
+ *
  * @param int $from_reply_id From reply id
  * @param int $source_topic_id Source topic id
  * @param int $destination_topic_id Destination topic id
+ * @param int $from_reply_id From reply id.
+ * @param int $source_topic_id Source topic id.
+ * @param int $destination_topic_id Destination topic id.
  */
 function bbp_split_topic_count( $from_reply_id, $source_topic_id, $destination_topic_id ) {
 …
 /**
  * Handles the front end tag management (renaming, merging, destroying)
+ * Handles the front end tag management (renaming, merging, destroying).
+ *
  * @since 2.0.0 bbPress (r2768)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_edit_topic_tag_handler( $action = '' ) {
 …
 /**
  * Return an associative array of available topic statuses
+ * Return an associative array of available topic statuses.
+ *
  * @since 2.4.0 bbPress (r5059)
+ *
  * @param int $topic_id   Optional. Topic id.
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return array
 …
 /**
  * Return an associative array of topic sticky types
+ * Return an associative array of topic sticky types.
+ *
  * @since 2.4.0 bbPress (r5059)
+ *
  * @param int $topic_id   Optional. Topic id.
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return array
 …
 /**
  * Return array of available topic toggle actions
+ * Return array of available topic toggle actions.
+ *
  * @since 2.6.0 bbPress (r6133)
+ *
  * @param int $topic_id   Optional. Topic id.
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return array
 …
 /**
  * Return sticky topics of a forum
+ * Return sticky topics of a forum.
+ *
  * @since 2.0.0 bbPress (r2592)
+ *
  * @param int $forum_id Optional. If not passed, super stickies are returned.
+ * @return array IDs of sticky topics of a forum or super stickies
+ *
+ * @return array IDs of sticky topics of a forum or super stickies.
  */
 function bbp_get_stickies( $forum_id = 0 ) {
 …
 /**
  * Return topics stuck to front page of the forums
+ * Return topics stuck to front page of the forums.
+ *
  * @since 2.0.0 bbPress (r2592)
+ *
  * @return array IDs of super sticky topics
+ * @return array IDs of super sticky topics.
  */
 function bbp_get_super_stickies() {
 …
 /**
  * Handles the front end opening/closing, spamming/unspamming,
  * sticking/unsticking and trashing/untrashing/deleting of topics
+ * sticking/unsticking and trashing/untrashing/deleting of topics.
+ *
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_toggle_topic_handler( $action = '' ) {
 …
 /**
  * Do the actual topic toggling
+ * Do the actual topic toggling.
+ *
  * This function is used by `bbp_toggle_topic_handler()` to do the actual heavy
 …
 /**
  * Remove a deleted topic from all user favorites
+ * Remove a deleted topic from all user favorites.
+ *
  * @since 2.0.0 bbPress (r2652)
+ *
  * @param int $topic_id Get the topic id to remove
+ * @param int $topic_id Get the topic id to remove.
  */
 function bbp_remove_topic_from_all_favorites( $topic_id = 0 ) {
 …
 /**
  * Remove a deleted topic from all user subscriptions
+ * Remove a deleted topic from all user subscriptions.
+ *
  * @since 2.0.0 bbPress (r2652)
+ *
  * @param int $topic_id Get the topic id to remove
+ * @param int $topic_id Get the topic id to remove.
  */
 function bbp_remove_topic_from_all_subscriptions( $topic_id = 0 ) {
 …
 /**
  * Bump the total reply count of a topic
+ * Bump the total reply count of a topic.
+ *
  * @since 2.1.0 bbPress (r3825)
+ *
  * @param int $topic_id   Optional. Topic id.
+ * @param int $difference Optional. Default 1
+ * @return int Topic reply count
+ * @param int $difference Optional. Default 1.
+ *
+ * @return int Topic reply count.
  */
 function bbp_bump_topic_reply_count( $topic_id = 0, $difference = 1 ) {
 …
+ *
  * @param int $topic_id The topic id.
+ *
- * @return void
  */
 function bbp_increase_topic_reply_count( $topic_id = 0 ) {
 …
+ *
  * @param int $topic_id The topic id.
+ *
- * @return void
  */
 function bbp_decrease_topic_reply_count( $topic_id = 0 ) {
 …
 /**
  * Bump the total hidden reply count of a topic
+ * Bump the total hidden reply count of a topic.
+ *
  * @since 2.1.0 bbPress (r3825)
+ *
  * @param int $topic_id   Optional. Topic id.
+ * @param int $difference Optional. Default 1
+ * @return int Topic hidden reply count
+ * @param int $difference Optional. Default 1.
+ *
+ * @return int Topic hidden reply count.
  */
 function bbp_bump_topic_reply_count_hidden( $topic_id = 0, $difference = 1 ) {
 …
+ *
  * @param int $topic_id The topic id.
+ *
- * @return void
  */
 function bbp_increase_topic_reply_count_hidden( $topic_id = 0 ) {
 …
+ *
  * @param int $topic_id The topic id.
+ *
- * @return void
  */
 function bbp_decrease_topic_reply_count_hidden( $topic_id = 0 ) {
 …
  * @param int $topic_id The topic id.
  * @param int $forum_id The forum id.
+ *
- * @return void
  */
 function bbp_insert_topic_update_counts( $topic_id = 0, $forum_id = 0 ) {
 …
  * @since 2.0.0 bbPress (r2855)
+ *
  * @param int $topic_id Optional. Topic id to update
+ * @param int $topic_id Optional. Topic id to update.
  * @param int $forum_id Optional. Forum id
+ * @return int Forum id
+ *
+ * @return int Forum id.
  */
 function bbp_update_topic_forum_id( $topic_id = 0, $forum_id = 0 ) {
 …
 /**
  * Update the topic's topic id
+ * Update the topic's topic id.
+ *
  * @since 2.0.0 bbPress (r2954)
+ *
+ * @param int $topic_id Optional. Topic id to update
+ * @return int Topic id
+ * @param int $topic_id Optional. Topic id to update.
+ *
+ * @return int Topic id.
  */
 function bbp_update_topic_topic_id( $topic_id = 0 ) {
 …
 /**
  * Adjust the total reply count of a topic
+ * Adjust the total reply count of a topic.
+ *
  * @since 2.0.0 bbPress (r2467)
+ *
  * @param int $topic_id Optional. Topic id to update
+ * @param int $topic_id Optional. Topic id to update.
  * @param int $reply_count Optional. Set the reply count manually.
+ * @return int Topic reply count
+ *
+ * @return int Topic reply count.
  */
 function bbp_update_topic_reply_count( $topic_id = 0, $reply_count = false ) {
 …
 /**
  * Adjust the total hidden reply count of a topic (hidden includes trashed,
  * spammed and pending replies)
+ * spammed and pending replies).
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
+ * @param int $topic_id Optional. Topic id to update
+ * @param int $reply_count Optional. Set the reply count manually
+ * @return int Topic hidden reply count
+ * @param int $topic_id Optional. Topic id to update.
+ * @param int $reply_count Optional. Set the reply count manually.
+ *
+ * @return int Topic hidden reply count.
  */
 function bbp_update_topic_reply_count_hidden( $topic_id = 0, $reply_count = false ) {
 …
 /**
  * Update the topic with the last active post ID
+ * Update the topic with the last active post ID.
+ *
  * @since 2.0.0 bbPress (r2888)
+ *
+ * @param int $topic_id Optional. Topic id to update
+ * @param int $active_id Optional. active id
+ * @return int Active id
+ * @param int $topic_id Optional. Topic id to update.
+ * @param int $active_id Optional. Active id.
+ *
+ * @return int Active id.
  */
 function bbp_update_topic_last_active_id( $topic_id = 0, $active_id = 0 ) {
 …
 /**
  * Update the topics last active date/time (aka freshness)
+ * Update the topics last active date/time (aka freshness).
+ *
  * @since 2.0.0 bbPress (r2680)
 …
  * @param int    $topic_id Optional. Topic id.
  * @param string $new_time Optional. New time in mysql format.
+ * @return string MySQL timestamp of last active reply
+ *
+ * @return string MySQL timestamp of last active reply.
  */
 function bbp_update_topic_last_active_time( $topic_id = 0, $new_time = '' ) {
 …
 /**
  * Update the topic with the most recent reply ID
+ * Update the topic with the most recent reply ID.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
+ * @param int $topic_id Optional. Topic id to update
+ * @param int $reply_id Optional. Reply id
+ * @return int Reply id
+ * @param int $topic_id Optional. Topic id to update.
+ * @param int $reply_id Optional. Reply id.
+ *
+ * @return int Reply id.
  */
 function bbp_update_topic_last_reply_id( $topic_id = 0, $reply_id = 0 ) {
 …
 /**
  * Adjust the total voice count of a topic
+ * Adjust the total voice count of a topic.
+ *
  * @since 2.0.0 bbPress (r2567)
+ * @since 2.6.0 bbPress (r6515) This must be called after any engagement changes
+ *
+ * @param int $topic_id Optional. Topic id to update
+ * @return int Voice count
+ * @since 2.6.0 bbPress (r6515) This must be called after any engagement changes.
+ *
+ * @param int $topic_id Optional. Topic id to update.
+ *
+ * @return int Voice count.
  */
 function bbp_update_topic_voice_count( $topic_id = 0 ) {
 …
 /**
  * Adjust the total anonymous reply count of a topic
+ * Adjust the total anonymous reply count of a topic.
+ *
  * @since 2.0.0 bbPress (r2567)
+ *
+ * @param int $topic_id Optional. Topic id to update
+ * @return int Anonymous reply count
+ * @param int $topic_id Optional. Topic id to update.
+ *
+ * @return int Anonymous reply count.
  */
 function bbp_update_topic_anonymous_reply_count( $topic_id = 0 ) {
 …
 /**
  * Update the revision log of the topic
+ * Update the revision log of the topic.
+ *
  * @since 2.0.0 bbPress (r2782)
 …
  *  - reason: Reason for editing
  *  - revision_id: Revision id
+ * @return mixed False on failure, true on success
+ *
+ * @return mixed False on failure, true on success.
  */
 function bbp_update_topic_revision_log( $args = array() ) {
 …
 /**
  * Closes a topic
+ * Closes a topic.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
+ * @param int $topic_id Topic id
+ * @return mixed False or {@link WP_Error} on failure, topic id on success
+ * @param int $topic_id Topic id.
+ *
+ * @return mixed False or {@link WP_Error} on failure, topic id on success.
  */
 function bbp_close_topic( $topic_id = 0 ) {
 …
 /**
  * Opens a topic
+ * Opens a topic.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
+ * @param int $topic_id Topic id
+ * @return mixed False or {@link WP_Error} on failure, topic id on success
+ * @param int $topic_id Topic id.
+ *
+ * @return mixed False or {@link WP_Error} on failure, topic id on success.
  */
 function bbp_open_topic( $topic_id = 0 ) {
 …
 /**
  * Marks a topic as spam
+ * Marks a topic as spam.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param int $topic_id Topic id
  * @return mixed False or {@link WP_Error} on failure, topic id on success
+ * @param int $topic_id Topic id.
+ * @return mixed False or {@link WP_Error} on failure, topic id on success.
  */
 function bbp_spam_topic( $topic_id = 0 ) {
 …
 /**
  * Trash replies to a topic when it's marked as spam
+ * Trash replies to a topic when it's marked as spam.
+ *
  * Usually you'll want to do this before the topic itself is marked as spam.
 …
  * @since 2.6.0 bbPress (r5405)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  */
 function bbp_spam_topic_replies( $topic_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5405)
+ *
+ * @param int $topic_id
+ * @param int $topic_id Topic id.
+ *
+ * @return array
  */
 function bbp_spam_topic_tags( $topic_id = 0 ) {
 …
 /**
  * Unspams a topic
+ * Unspams a topic.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
+ * @param int $topic_id Topic id
+ * @return mixed False or {@link WP_Error} on failure, topic id on success
+ * @param int $topic_id Topic id.
+ *
+ * @return mixed False or {@link WP_Error} on failure, topic id on success.
  */
 function bbp_unspam_topic( $topic_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5405)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  */
 function bbp_unspam_topic_replies( $topic_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5405)
+ *
+ * @param int $topic_id
+ * @param int $topic_id Topic id.
+ *
+ * @return array
  */
 function bbp_unspam_topic_tags( $topic_id = 0 ) {
 …
 /**
  * Sticks a topic to a forum or front
+ * Sticks a topic to a forum or front.
+ *
  * @since 2.0.0 bbPress (r2754)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @param int $super Should we make the topic a super sticky?
+ *
  * @return bool True on success, false on failure
  */
 …
 /**
  * Approves a pending topic
+ * Approves a pending topic.
+ *
  * @since 2.6.0 bbPress (r5503)
+ *
+ * @param int $topic_id Topic id
+ * @return mixed False or {@link WP_Error} on failure, topic id on success
+ * @param int $topic_id Topic id.
+ *
+ * @return mixed False or {@link WP_Error} on failure, topic id on success.
  */
 function bbp_approve_topic( $topic_id = 0 ) {
 …
 /**
  * Unapproves a topic
+ * Unapproves a topic.
+ *
  * @since 2.6.0 bbPress (r5503)
+ *
+ * @param int $topic_id Topic id
+ * @return mixed False or {@link WP_Error} on failure, topic id on success
+ * @param int $topic_id Topic id.
+ *
+ * @return mixed False or {@link WP_Error} on failure, topic id on success.
  */
 function bbp_unapprove_topic( $topic_id = 0 ) {
 …
 /**
  * Unsticks a topic both from front and it's forum
+ * Unsticks a topic both from front and it's forum.
+ *
  * @since 2.0.0 bbPress (r2754)
+ *
+ * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return bool Always true.
  */
 …
  * handled by WordPress core API functions. It is used to clean up after
  * a topic that is being deleted.
+ *
+ * @since 2.0.0 bbPress (r2895)
+ *
+ * @param int $topic_id Topic id.
  */
 function bbp_delete_topic( $topic_id = 0 ) {
 …
 /**
  * Delete replies to a topic when it's deleted
+ * Delete replies to a topic when it's deleted.
+ *
  * Usually you'll want to do this before the topic itself is deleted.
 …
  * @since 2.6.0 bbPress (r5405)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  */
 function bbp_delete_topic_replies( $topic_id = 0 ) {
 …
 /**
  * Called before trashing a topic
+ * Called before trashing a topic.
+ *
  * This function is supplemental to the actual topic being trashed which is
  * handled by WordPress core API functions. It is used to clean up after
  * a topic that is being trashed.
+ *
+ * @since 2.0.0 bbPress (r2895)
+ *
+ * @param int $topic_id Topic id.
  */
 function bbp_trash_topic( $topic_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5405)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  */
 function bbp_trash_topic_replies( $topic_id = 0 ) {
 …
 /**
+ * Called before untrashing a topic
+ * Called before untrashing a topic.
+ *
+ * @since 2.0.0 bbPress (r2895)
+ *
+ * @param int $topic_id Topic id.
  */
 function bbp_untrash_topic( $topic_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5405)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  */
 function bbp_untrash_topic_replies( $topic_id = 0 ) {
 …
 /**
  * Called after deleting a topic
+ * Called after deleting a topic.
+ *
  * @since 2.0.0 bbPress (r2993)
+ *
+ * @param int $topic_id Topic id.
  */
 function bbp_deleted_topic( $topic_id = 0 ) {
 …
 /**
  * Called after trashing a topic
+ * Called after trashing a topic.
+ *
  * @since 2.0.0 bbPress (r2993)
+ *
+ * @param int $topic_id Topic id.
  */
 function bbp_trashed_topic( $topic_id = 0 ) {
 …
 /**
  * Called after untrashing a topic
+ * Called after untrashing a topic.
+ *
  * @since 2.0.0 bbPress (r2993)
+ *
+ * @param int $topic_id Topic id.
  */
 function bbp_untrashed_topic( $topic_id = 0 ) {
 …
 /**
  * Return the topics per page setting
+ * Return the topics per page setting.
+ *
  * @since 2.0.0 bbPress (r3540)
+ * @return int
+ *
+ * @param int $default Optional. Number of topics per page if no value exists.
+ *
+ * @return int Number of topics per page.
  */
 function bbp_get_topics_per_page( $default = 15 ) {
 …
 /**
  * Return the topics per RSS page setting
+ * Return the topics per RSS page setting.
+ *
  * @since 2.0.0 bbPress (r3540)
+ *
  * @param int $default Default replies per page (25)
+ * @return int
+ *
+ * @return int Number of topics per RSS page.
  */
 function bbp_get_topics_per_rss_page( $default = 25 ) {
 …
 /**
  * Get topic tags for a specific topic ID
+ * Get topic tags for a specific topic ID.
+ *
  * @since 2.6.0 bbPress (r5836)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
+ *
  * @return string
 …
 /**
  * Get topic tags for a specific topic ID
+ * Get topic tags for a specific topic ID.
+ *
  * @since 2.2.0 bbPress (r4165)
+ *
  * @param int    $topic_id
  * @param string $sep
+ * @param int    $topic_id Topic id.
+ * @param string $sep      Separator string.
+ *
  * @return string
 …
 /**
  * Check if autoembeds are enabled and hook them in if so
+ * Check if autoembeds are enabled and hook them in if so.
+ *
  * @since 2.1.0 bbPress (r3752)
 …
 /**
  * Redirect if unauthorized user is attempting to edit a topic
+ * Redirect if unauthorized user is attempting to edit a topic.
+ *
  * @since 2.1.0 bbPress (r3605)
 …
 /**
  * Redirect if unauthorized user is attempting to edit a topic tag
+ * Redirect if unauthorized user is attempting to edit a topic tag.
+ *
  * @since 2.1.0 bbPress (r3605)

trunk/src/includes/topics/template.php

-                      r7379
+                      r7380
 /**
  * bbPress Topic Template Tags
+ * bbPress Topic Template Tags.
+ *
  * @package bbPress
 …
 /**
  * Output the unique id of the custom post type for topics
+ * Output the unique id of the custom post type for topics.
+ *
  * @since 2.0.0 bbPress (r2857)
 …
     echo bbp_get_topic_post_type();
+}
+    /**
+     * Return the unique id of the custom post type for topics
+     *
+     * @since 2.0.0 bbPress (r2857)
+     *
+     * @return string The unique topic post type id
+     */
+    function bbp_get_topic_post_type() {
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_post_type', bbpress()->topic_post_type );
+    }
+/**
+ * Return array of labels used by the topic post type
+/**
+ * Return the unique id of the custom post type for topics.
+ *
+ * @since 2.0.0 bbPress (r2857)
+ *
+ * @return string The unique topic post type id.
+ */
+function bbp_get_topic_post_type() {
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_post_type', bbpress()->topic_post_type );
+}
+/**
+ * Return array of labels used by the topic post type.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return array of topic post type rewrite settings
+ * Return array of topic post type rewrite settings.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return array of features the topic post type supports
+ * Return array of features the topic post type supports.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
  * @since 2.0.0 bbPress (r2954)
+ *
  * @param $show_lead Optional. Default false
  * @return bool Yes if the topic appears as a lead, otherwise false
+ * @param $show_lead Optional. Default false.
+ * @return bool Yes if the topic appears as a lead, otherwise false.
  */
 function bbp_show_lead_topic( $show_lead = false ) {
 …
 /**
  * The main topic loop. WordPress makes this easy for us
+ * The main topic loop. WordPress makes this easy for us.
+ *
  * @since 2.0.0 bbPress (r2485)
+ *
  * @param array $args All the arguments supported by {@link WP_Query}
  * @return object Multidimensional array of topic information
+ * @param array $args All the arguments supported by {@link WP_Query}.
+ * @return object Multidimensional array of topic information.
  */
 function bbp_has_topics( $args = array() ) {
 …
 /**
  * Whether there are more topics available in the loop
+ * Whether there are more topics available in the loop.
+ *
  * @since 2.0.0 bbPress (r2485)
+ *
  * @return object Topic information
+ * @return object Topic information.
  */
 function bbp_topics() {
 …
 /**
  * Loads up the current topic in the loop
+ * Loads up the current topic in the loop.
+ *
  * @since 2.0.0 bbPress (r2485)
+ *
  * @return object Topic information
+ * @return object Topic information.
  */
 function bbp_the_topic() {
 …
 /**
  * Add sticky topics to a topics query object
+ * Add sticky topics to a topics query object.
+ *
  * @since 2.6.0 bbPress (r6402)
 …
 /**
  * Output the topic id
+ * Output the topic id.
+ *
  * @since 2.0.0 bbPress (r2485)
 …
     echo bbp_get_topic_id( $topic_id );
+}
+    /**
+     * Return the topic id
+     *
+     * @since 2.0.0 bbPress (r2485)
+     *
+     * @param $topic_id Optional. Used to check emptiness
+     * @return int The topic id
+     */
+    function bbp_get_topic_id( $topic_id = 0 ) {
+        $bbp      = bbpress();
+        $wp_query = bbp_get_wp_query();
+        // Easy empty checking
+        if ( ! empty( $topic_id ) && is_numeric( $topic_id ) ) {
+            $bbp_topic_id = $topic_id;
+        // Currently inside a topic loop
+        } elseif ( ! empty( $bbp->topic_query->in_the_loop ) && isset( $bbp->topic_query->post->ID ) ) {
+            $bbp_topic_id = $bbp->topic_query->post->ID;
+        // Currently inside a search loop
+        } elseif ( ! empty( $bbp->search_query->in_the_loop ) && isset( $bbp->search_query->post->ID ) && bbp_is_topic( $bbp->search_query->post->ID ) ) {
+            $bbp_topic_id = $bbp->search_query->post->ID;
+        // Currently viewing/editing a topic, likely alone
+        } elseif ( ( bbp_is_single_topic() || bbp_is_topic_edit() ) && ! empty( $bbp->current_topic_id ) ) {
+            $bbp_topic_id = $bbp->current_topic_id;
+        // Currently viewing/editing a topic, likely in a loop
+        } elseif ( ( bbp_is_single_topic() || bbp_is_topic_edit() ) && isset( $wp_query->post->ID ) ) {
+            $bbp_topic_id = $wp_query->post->ID;
+        // Currently viewing/editing a reply
+        } elseif ( bbp_is_single_reply() || bbp_is_reply_edit() ) {
+            $bbp_topic_id = bbp_get_reply_topic_id();
+        // Fallback
+        } else {
+            $bbp_topic_id = 0;
+        }
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_topic_id', (int) $bbp_topic_id, $topic_id );
+    }
+/**
+ * Gets a topic
+/**
+ * Return the topic id.
+ *
+ * @since 2.0.0 bbPress (r2485)
+ *
+ * @param $topic_id Optional. Used to check emptiness.
+ * @return int The topic id.
+ */
+function bbp_get_topic_id( $topic_id = 0 ) {
+    $bbp      = bbpress();
+    $wp_query = bbp_get_wp_query();
+    // Easy empty checking
+    if ( ! empty( $topic_id ) && is_numeric( $topic_id ) ) {
+        $bbp_topic_id = $topic_id;
+    // Currently inside a topic loop
+    } elseif ( ! empty( $bbp->topic_query->in_the_loop ) && isset( $bbp->topic_query->post->ID ) ) {
+        $bbp_topic_id = $bbp->topic_query->post->ID;
+    // Currently inside a search loop
+    } elseif ( ! empty( $bbp->search_query->in_the_loop ) && isset( $bbp->search_query->post->ID ) && bbp_is_topic( $bbp->search_query->post->ID ) ) {
+        $bbp_topic_id = $bbp->search_query->post->ID;
+    // Currently viewing/editing a topic, likely alone
+    } elseif ( ( bbp_is_single_topic() || bbp_is_topic_edit() ) && ! empty( $bbp->current_topic_id ) ) {
+        $bbp_topic_id = $bbp->current_topic_id;
+    // Currently viewing/editing a topic, likely in a loop
+    } elseif ( ( bbp_is_single_topic() || bbp_is_topic_edit() ) && isset( $wp_query->post->ID ) ) {
+        $bbp_topic_id = $wp_query->post->ID;
+    // Currently viewing/editing a reply
+    } elseif ( bbp_is_single_reply() || bbp_is_reply_edit() ) {
+        $bbp_topic_id = bbp_get_reply_topic_id();
+    // Fallback
+    } else {
+        $bbp_topic_id = 0;
+    }
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_topic_id', (int) $bbp_topic_id, $topic_id );
+}
+/**
+ * Gets a topic.
+ *
  * @since 2.0.0 bbPress (r2787)
+ *
  * @return mixed Null if error or topic (in specified form) if success
+ * @return mixed Null if error or topic (in specified form) if success.
  */
 function bbp_get_topic( $topic, $output = OBJECT, $filter = 'raw' ) {
 …
 /**
  * Output the link to the topic in the topic loop
+ * Output the link to the topic in the topic loop.
+ *
  * @since 2.0.0 bbPress (r2485)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @param string $redirect_to Optional. Pass a redirect value for use with
  *                              shortcodes and other fun things.
 …
     echo esc_url( bbp_get_topic_permalink( $topic_id, $redirect_to ) );
+}
+    /**
+     * Return the link to the 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
+     *                              shortcodes and other fun things.
+     * @return string Permanent link to topic
+     */
+    function bbp_get_topic_permalink( $topic_id = 0, $redirect_to = '' ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Use the redirect address
+        if ( ! empty( $redirect_to ) ) {
+            $topic_permalink = esc_url_raw( $redirect_to );
+        // Use the topic permalink
+        } else {
+            $topic_permalink = get_permalink( $topic_id );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_permalink', $topic_permalink, $topic_id );
+    }
+/**
+ * Output the title of the topic
+/**
+ * Return the link to the topic.
+ *
  * @since 2.0.0 bbPress (r2485)
+ *
+ * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
+ * @param string $redirect_to Optional. Pass a redirect value for use with
+ *                              shortcodes and other fun things.
+ * @return string Permanent link to topic.
+ */
+function bbp_get_topic_permalink( $topic_id = 0, $redirect_to = '' ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Use the redirect address
+    if ( ! empty( $redirect_to ) ) {
+        $topic_permalink = esc_url_raw( $redirect_to );
+    // Use the topic permalink
+    } else {
+        $topic_permalink = get_permalink( $topic_id );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_permalink', $topic_permalink, $topic_id );
+}
+/**
+ * Output the title of the topic.
+ *
+ * @since 2.0.0 bbPress (r2485)
+ *
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_title( $topic_id = 0 ) {
     echo bbp_get_topic_title( $topic_id );
+}
+    /**
+     * Return the title of the topic
+     *
+     * @since 2.0.0 bbPress (r2485)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Title of topic
+     */
+    function bbp_get_topic_title( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $title    = get_post_field( 'post_title', $topic_id );
+        $title    = apply_filters( 'the_title', $title, $topic_id );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_title', $title, $topic_id );
+    }
+/**
+ * Output the topic archive title
+/**
+ * Return the title of the topic.
+ *
+ * @since 2.0.0 bbPress (r2485)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Title of topic.
+ */
+function bbp_get_topic_title( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $title    = get_post_field( 'post_title', $topic_id );
+    $title    = apply_filters( 'the_title', $title, $topic_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_title', $title, $topic_id );
+}
+/**
+ * Output the topic archive title.
+ *
  * @since 2.0.0 bbPress (r3249)
+ *
  * @param string $title Default text to use as title
+ * @param string $title Default text to use as title.
  */
 function bbp_topic_archive_title( $title = '' ) {
     echo bbp_get_topic_archive_title( $title );
+}
+    /**
+     * Return the topic archive title
+     *
+     * @since 2.0.0 bbPress (r3249)
+     *
+     * @param string $title Default text to use as title
+     *
+     * @return string The topic archive title
+     */
+    function bbp_get_topic_archive_title( $title = '' ) {
+        // If no title was passed
         if ( empty( $title ) ) {
+            // Set root text to page title
             $page = bbp_get_page_by_path( bbp_get_topic_archive_slug() );
             if ( ! empty( $page ) ) {
                 $title = get_the_title( $page->ID );
+            // Default to topic post type name label
             } else {
                 $tto   = get_post_type_object( bbp_get_topic_post_type() );
                 $title = $tto->labels->name;
+            }
+/**
+ * Return the topic archive title.
+ *
+ * @since 2.0.0 bbPress (r3249)
+ *
+ * @param string $title Default text to use as title.
+ *
+ * @return string The topic archive title.
+ */
+function bbp_get_topic_archive_title( $title = '' ) {
+    // If no title was passed
+    if ( empty( $title ) ) {
+        // Set root text to page title
+        $page = bbp_get_page_by_path( bbp_get_topic_archive_slug() );
+        if ( ! empty( $page ) ) {
+            $title = get_the_title( $page->ID );
+        // Default to topic post type name label
+        } else {
+            $tto   = get_post_type_object( bbp_get_topic_post_type() );
+            $title = $tto->labels->name;
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_archive_title', $title );
+    }
+/**
+ * Output the content of the topic
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_archive_title', $title );
+}
+/**
+ * Output the content of the topic.
+ *
  * @since 2.0.0 bbPress (r2780)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_content( $topic_id = 0 ) {
     echo bbp_get_topic_content( $topic_id );
+}
+    /**
+     * Return the content of the topic
+     *
+     * @since 2.0.0 bbPress (r2780)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Content of the topic
+     */
+    function bbp_get_topic_content( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Check if password is required
+        if ( post_password_required( $topic_id ) ) {
+            return get_the_password_form();
+        }
+        $content = get_post_field( 'post_content', $topic_id );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_content', $content, $topic_id );
+    }
+/**
+ * Output the excerpt of the topic
+/**
+ * Return the content 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
+ * @param int $topic_id Optional. Topic id.
+ * @return string Content of the topic.
+ */
+function bbp_get_topic_content( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Check if password is required
+    if ( post_password_required( $topic_id ) ) {
+        return get_the_password_form();
+    }
+    $content = get_post_field( 'post_content', $topic_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_content', $content, $topic_id );
+}
+/**
+ * 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.
  */
 function bbp_topic_excerpt( $topic_id = 0, $length = 100 ) {
     echo bbp_get_topic_excerpt( $topic_id, $length );
+}
+    /**
+     * Return 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
+     * @return string topic Excerpt
+     */
+    function bbp_get_topic_excerpt( $topic_id = 0, $length = 100 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $length   = (int) $length;
+        $excerpt  = get_post_field( 'post_excerpt', $topic_id );
+        if ( empty( $excerpt ) ) {
+            $excerpt = bbp_get_topic_content( $topic_id );
+        }
+        $excerpt = wp_strip_all_tags( $excerpt );
+        // Multibyte support
+        if ( function_exists( 'mb_strlen' ) ) {
+            $excerpt_length = mb_strlen( $excerpt );
+        } else {
+            $excerpt_length = strlen( $excerpt );
+        }
+        if ( ! empty( $length ) && ( $excerpt_length > $length ) ) {
+            $excerpt  = mb_substr( $excerpt, 0, $length - 1 );
+            $excerpt .= '&hellip;';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_excerpt', $excerpt, $topic_id, $length );
+    }
+/**
+ * Output the post date and time of a topic
+/**
+ * Return 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.
+ * @return string topic Excerpt.
+ */
+function bbp_get_topic_excerpt( $topic_id = 0, $length = 100 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $length   = (int) $length;
+    $excerpt  = get_post_field( 'post_excerpt', $topic_id );
+    if ( empty( $excerpt ) ) {
+        $excerpt = bbp_get_topic_content( $topic_id );
+    }
+    $excerpt = wp_strip_all_tags( $excerpt );
+    // Multibyte support
+    if ( function_exists( 'mb_strlen' ) ) {
+        $excerpt_length = mb_strlen( $excerpt );
+    } else {
+        $excerpt_length = strlen( $excerpt );
+    }
+    if ( ! empty( $length ) && ( $excerpt_length > $length ) ) {
+        $excerpt  = mb_substr( $excerpt, 0, $length - 1 );
+        $excerpt .= '&hellip;';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_excerpt', $excerpt, $topic_id, $length );
+}
+/**
+ * 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
+ * @param bool $humanize Optional. Humanize output using time_since.
+ * @param bool $gmt Optional. Use GMT.
  */
 function bbp_topic_post_date( $topic_id = 0, $humanize = false, $gmt = false ) {
     echo bbp_get_topic_post_date( $topic_id, $humanize, $gmt );
+}
+    /**
+     * Return 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
+     * @return string
+     */
+    function bbp_get_topic_post_date( $topic_id = 0, $humanize = false, $gmt = false ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // 4 days, 4 hours ago
+        if ( ! empty( $humanize ) ) {
+            $gmt_s  = ! empty( $gmt ) ? 'G' : 'U';
+            $date   = get_post_time( $gmt_s, $gmt, $topic_id );
+            $time   = false; // For filter below
+            $result = bbp_get_time_since( $date );
+        // August 4, 2012 at 2:37 pm
+        } else {
+            $date   = get_post_time( get_option( 'date_format' ), $gmt, $topic_id, true );
+            $time   = get_post_time( get_option( 'time_format' ), $gmt, $topic_id, true );
+            /* translators: 1: Date, 2: Time */
+            $result = sprintf( _x( '%1$s at %2$s', 'date at time', 'bbpress' ), $date, $time );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_post_date', $result, $topic_id, $humanize, $gmt, $date, $time );
+    }
+/**
+ * Output pagination links of a topic within the topic loop
+/**
+ * Return 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.
+ * @return string
+ */
+function bbp_get_topic_post_date( $topic_id = 0, $humanize = false, $gmt = false ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // 4 days, 4 hours ago
+    if ( ! empty( $humanize ) ) {
+        $gmt_s  = ! empty( $gmt ) ? 'G' : 'U';
+        $date   = get_post_time( $gmt_s, $gmt, $topic_id );
+        $time   = false; // For filter below
+        $result = bbp_get_time_since( $date );
+    // August 4, 2012 at 2:37 pm
+    } else {
+        $date   = get_post_time( get_option( 'date_format' ), $gmt, $topic_id, true );
+        $time   = get_post_time( get_option( 'time_format' ), $gmt, $topic_id, true );
+        /* translators: 1: Date, 2: Time */
+        $result = sprintf( _x( '%1$s at %2$s', 'date at time', 'bbpress' ), $date, $time );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_post_date', $result, $topic_id, $humanize, $gmt, $date, $time );
+}
+/**
+ * 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()}
+ * @param array $args See {@link bbp_get_topic_pagination()}.
  */
 function bbp_topic_pagination( $args = array() ) {
     echo bbp_get_topic_pagination( $args );
+}
+    /**
+     * Returns pagination links of a topic within the topic loop
+     *
+     * @since 2.0.0 bbPress (r2966)
+     *
+     * @param array $args This function supports these arguments:
+     *  - topic_id: Topic id
+     *  - before: Before the links
+     *  - after: After the links
+     * @return string Pagination links
+     */
+    function bbp_get_topic_pagination( $args = array() ) {
+        // Bail if threading replies
+        if ( bbp_thread_replies() ) {
+            return;
+        }
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'topic_id' => bbp_get_topic_id(),
+                'before'   => '<span class="bbp-topic-pagination">',
+                'after'    => '</span>',
+            ),
+            'get_topic_pagination'
+        );
+        // Slug must be checked for topics that have never been approved/published
+        $has_slug = bbp_get_topic( $r['topic_id'] )->post_name;
+        // Get the topic permalink
+        $topic_permalink = bbp_get_topic_permalink( $r['topic_id'] );
+        // If pretty permalinks are enabled, make our pagination pretty
+        $base = ! empty( $has_slug ) && bbp_use_pretty_urls() && bbp_is_topic_public( $r['topic_id'] )
+            ? trailingslashit( $topic_permalink ) . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' )
+            : add_query_arg( 'paged', '%#%', $topic_permalink );
+        // Get total and add 1 if topic is included in the reply loop
+        $total = bbp_get_topic_reply_count( $r['topic_id'], true );
+        // Bump if topic is in loop
+        if ( ! bbp_show_lead_topic() ) {
+            ++$total;
+        }
+        // Total for pagination boundaries
+        $total_pages = ceil( $total / bbp_get_replies_per_page() );
+        // Maybe add view-all args
+        $add_args = bbp_get_view_all( 'edit_others_replies' )
+            ? array( 'view' => 'all' )
+            : false;
+        // Pagination settings with filter
+        $bbp_topic_pagination = apply_filters(
+            'bbp_get_topic_pagination',
+            array(
+                'base'      => $base,
+                'total'     => $total_pages,
+                'current'   => 0,
+                'prev_next' => false,
+                'mid_size'  => 2,
+                'end_size'  => 2,
+                'add_args'  => $add_args
+            )
+        );
+        // Add pagination to query object
+        $pagination_links = bbp_paginate_links( $bbp_topic_pagination );
+        // Maybe add before and after to pagination links
+        if ( ! empty( $pagination_links ) ) {
+            $pagination_links = $r['before'] . $pagination_links . $r['after'];
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_pagination', $pagination_links, $args );
+    }
+/**
+ * Append revisions to the topic content
+/**
+ * Returns pagination links of a topic within the topic loop.
+ *
+ * @since 2.0.0 bbPress (r2966)
+ *
+ * @param array $args This function supports these arguments:
+ *  - topic_id: Topic id
+ *  - before: Before the links
+ *  - after: After the links
+ * @return string Pagination links.
+ */
+function bbp_get_topic_pagination( $args = array() ) {
+    // Bail if threading replies
+    if ( bbp_thread_replies() ) {
+        return;
+    }
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'topic_id' => bbp_get_topic_id(),
+            'before'   => '<span class="bbp-topic-pagination">',
+            'after'    => '</span>',
+        ),
+        'get_topic_pagination'
+    );
+    // Slug must be checked for topics that have never been approved/published
+    $has_slug = bbp_get_topic( $r['topic_id'] )->post_name;
+    // Get the topic permalink
+    $topic_permalink = bbp_get_topic_permalink( $r['topic_id'] );
+    // If pretty permalinks are enabled, make our pagination pretty
+    $base = ! empty( $has_slug ) && bbp_use_pretty_urls() && bbp_is_topic_public( $r['topic_id'] )
+        ? trailingslashit( $topic_permalink ) . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' )
+        : add_query_arg( 'paged', '%#%', $topic_permalink );
+    // Get total and add 1 if topic is included in the reply loop
+    $total = bbp_get_topic_reply_count( $r['topic_id'], true );
+    // Bump if topic is in loop
+    if ( ! bbp_show_lead_topic() ) {
+        ++$total;
+    }
+    // Total for pagination boundaries
+    $total_pages = ceil( $total / bbp_get_replies_per_page() );
+    // Maybe add view-all args
+    $add_args = bbp_get_view_all( 'edit_others_replies' )
+        ? array( 'view' => 'all' )
+        : false;
+    // Pagination settings with filter
+    $bbp_topic_pagination = apply_filters(
+        'bbp_get_topic_pagination',
+        array(
+            'base'      => $base,
+            'total'     => $total_pages,
+            'current'   => 0,
+            'prev_next' => false,
+            'mid_size'  => 2,
+            'end_size'  => 2,
+            'add_args'  => $add_args
+        )
+    );
+    // Add pagination to query object
+    $pagination_links = bbp_paginate_links( $bbp_topic_pagination );
+    // Maybe add before and after to pagination links
+    if ( ! empty( $pagination_links ) ) {
+        $pagination_links = $r['before'] . $pagination_links . $r['after'];
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_pagination', $pagination_links, $args );
+}
+/**
+ * Append revisions to the topic content.
+ *
  * @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
  * @return string Content with the revisions appended
+ * @param string $content Optional. Content to which we need to append the revisions to.
+ * @param int $topic_id Optional. Topic id.
+ * @return string Content with the revisions appended.
  */
 function bbp_topic_content_append_revisions( $content = '', $topic_id = 0 ) {
 …
 /**
  * Output the revision log of the topic
+ * Output the revision log of the topic.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_revision_log( $topic_id = 0 ) {
     echo bbp_get_topic_revision_log( $topic_id );
+}
+    /**
+     * Return the formatted revision log of the topic
+     *
+     * @since 2.0.0 bbPress (r2782)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Revision log of the topic
+     */
+    function bbp_get_topic_revision_log( $topic_id = 0 ) {
+        // Create necessary variables
+        $topic_id     = bbp_get_topic_id( $topic_id );
+        $revision_log = bbp_get_topic_raw_revision_log( $topic_id );
+        if ( empty( $topic_id ) || empty( $revision_log ) || ! is_array( $revision_log ) ) {
+            return false;
+/**
+ * Return the formatted revision log of the topic.
+ *
+ * @since 2.0.0 bbPress (r2782)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Revision log of the topic.
+ */
+function bbp_get_topic_revision_log( $topic_id = 0 ) {
+    // Create necessary variables
+    $topic_id     = bbp_get_topic_id( $topic_id );
+    $revision_log = bbp_get_topic_raw_revision_log( $topic_id );
+    if ( empty( $topic_id ) || empty( $revision_log ) || ! is_array( $revision_log ) ) {
+        return false;
+    }
+    $revisions = bbp_get_topic_revisions( $topic_id );
+    if ( empty( $revisions ) ) {
+        return false;
+    }
+    $retval = "\n\n" . '<ul id="bbp-topic-revision-log-' . esc_attr( $topic_id ) . '" class="bbp-topic-revision-log">' . "\n\n";
+    // Loop through revisions
+    foreach ( (array) $revisions as $revision ) {
+        if ( empty( $revision_log[ $revision->ID ] ) ) {
+            $author_id = $revision->post_author;
+            $reason    = '';
+        } else {
+            $author_id = $revision_log[ $revision->ID ]['author'];
+            $reason    = $revision_log[ $revision->ID ]['reason'];
+        }
+        $revisions = bbp_get_topic_revisions( $topic_id );
+        if ( empty( $revisions ) ) {
+            return false;
+        $since  = bbp_get_time_since( bbp_convert_date( $revision->post_modified ) );
+        $author = bbp_get_author_link(
+            array(
+                'size'      => 14,
+                'link_text' => bbp_get_topic_author_display_name( $revision->ID ),
+                'post_id'   => $revision->ID
+            )
+        );
+        $retval .= "\t" . '<li id="bbp-topic-revision-log-' . esc_attr( $topic_id ) . '-item-' . esc_attr( $revision->ID ) . '" class="bbp-topic-revision-log-item">' . "\n";
+        if ( ! empty( $reason ) ) {
+            /* translators: 1: Time since modification, 2: Author link, 3: Modification reason */
+            $retval .= "\t\t" . sprintf( esc_html__( 'This topic was modified %1$s by %2$s. Reason: %3$s', 'bbpress' ), esc_html( $since ), $author, esc_html( $reason ) ) . "\n";
+        } else {
+            /* translators: 1: Time since modification, 2: Author link */
+            $retval .= "\t\t" . sprintf( esc_html__( 'This topic was modified %1$s by %2$s.',              'bbpress' ), esc_html( $since ), $author ) . "\n";
+        }
+        $retval = "\n\n" . '<ul id="bbp-topic-revision-log-' . esc_attr( $topic_id ) . '" class="bbp-topic-revision-log">' . "\n\n";
+        // Loop through revisions
+        foreach ( (array) $revisions as $revision ) {
+            if ( empty( $revision_log[ $revision->ID ] ) ) {
+                $author_id = $revision->post_author;
+                $reason    = '';
+            } else {
+                $author_id = $revision_log[ $revision->ID ]['author'];
+                $reason    = $revision_log[ $revision->ID ]['reason'];
+            }
+            $since  = bbp_get_time_since( bbp_convert_date( $revision->post_modified ) );
+            $author = bbp_get_author_link(
+                array(
+                    'size'      => 14,
+                    'link_text' => bbp_get_topic_author_display_name( $revision->ID ),
+                    'post_id'   => $revision->ID
+                )
+            );
+            $retval .= "\t" . '<li id="bbp-topic-revision-log-' . esc_attr( $topic_id ) . '-item-' . esc_attr( $revision->ID ) . '" class="bbp-topic-revision-log-item">' . "\n";
+            if ( ! empty( $reason ) ) {
+                /* translators: 1: Time since modification, 2: Author link, 3: Modification reason */
+                $retval .= "\t\t" . sprintf( esc_html__( 'This topic was modified %1$s by %2$s. Reason: %3$s', 'bbpress' ), esc_html( $since ), $author, esc_html( $reason ) ) . "\n";
+            } else {
+                /* translators: 1: Time since modification, 2: Author link */
+                $retval .= "\t\t" . sprintf( esc_html__( 'This topic was modified %1$s by %2$s.',              'bbpress' ), esc_html( $since ), $author ) . "\n";
+            }
+            $retval .= "\t" . '</li>' . "\n";
+        }
+        $retval .= "\n" . '</ul>' . "\n\n";
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_revision_log', $retval, $topic_id );
+    }
+        /**
+         * Return the raw revision log of the topic
+         *
+         * @since 2.0.0 bbPress (r2782)
+         *
+         * @param int $topic_id Optional. Topic id
+         * @return string Raw revision log of the topic
+         */
+        function bbp_get_topic_raw_revision_log( $topic_id = 0 ) {
+            $topic_id = bbp_get_topic_id( $topic_id );
+            $revision_log = get_post_meta( $topic_id, '_bbp_revision_log', true );
+            $revision_log = ! empty( $revision_log )
+                ? $revision_log
+                : array();
+            // Filter & return
+            return apply_filters( 'bbp_get_topic_raw_revision_log', $revision_log, $topic_id );
+        }
+/**
+ * Return the revisions of the topic
+        $retval .= "\t" . '</li>' . "\n";
+    }
+    $retval .= "\n" . '</ul>' . "\n\n";
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_revision_log', $retval, $topic_id );
+}
+/**
+ * Return the raw revision log of the topic.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
+ * @param int $topic_id Optional. Topic id
+ * @return WP_Post[]|int[] Topic revisions
+ * @param int $topic_id Optional. Topic id.
+ * @return string Raw revision log of the topic.
+ */
+function bbp_get_topic_raw_revision_log( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $revision_log = get_post_meta( $topic_id, '_bbp_revision_log', true );
+    $revision_log = ! empty( $revision_log )
+        ? $revision_log
+        : array();
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_raw_revision_log', $revision_log, $topic_id );
+}
+/**
+ * Return the revisions of the topic.
+ *
+ * @since 2.0.0 bbPress (r2782)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return WP_Post[]|int[] Topic revisions.
  */
 function bbp_get_topic_revisions( $topic_id = 0 ) {
 …
 /**
  * Return the revision count of the topic
+ * Return the revision count of the topic.
+ *
  * @since 2.0.0 bbPress (r2782)
+ *
  * @param int $topic_id Optional. Topic id
  * @return string Topic revision count
+ * @param int $topic_id Optional. Topic id.
+ * @return string Topic revision count.
  */
 function bbp_get_topic_revision_count( $topic_id = 0, $integer = false ) {
 …
  * @since 2.0.0 bbPress (r2754)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @param int $check_super Optional. If set to true and if the topic is not a
  *                           normal sticky, it is checked if it is a super
 …
  * @since 2.0.0 bbPress (r2754)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if super sticky, false if not.
  */
 …
 /**
  * Output the status of the topic
+ * Output the status of the topic.
+ *
  * @since 2.0.0 bbPress (r2667)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_status( $topic_id = 0 ) {
     echo bbp_get_topic_status( $topic_id );
+}
+    /**
+     * Return the status of the topic
+     *
+     * @since 2.0.0 bbPress (r2667)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Status of topic
+     */
+    function bbp_get_topic_status( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_status', get_post_status( $topic_id ), $topic_id );
+    }
+/**
+ * Return the status of the topic.
+ *
+ * @since 2.0.0 bbPress (r2667)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Status of topic.
+ */
+function bbp_get_topic_status( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_status', get_post_status( $topic_id ), $topic_id );
+}
 /**
 …
  * @since 2.0.0 bbPress (r2746)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return bool True if closed, false if not.
 …
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return bool True if open, false if closed.
 …
  * @since 2.6.0 bbPress (r6383)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if public, false if not.
  */
 …
  * @since 2.0.0 bbPress (r3496)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if published, false if not.
  */
 …
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if spam, false if not.
  */
 …
  * @since 2.0.0 bbPress (r2888)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if trashed, false if not.
  */
 …
  * @since 2.6.0 bbPress (r5504)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if pending, false if not.
  */
 …
  * @since 2.6.0 bbPress (r5504)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if private, false if not.
  */
 …
  * @since 2.0.0 bbPress (r2753)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if the post is by an anonymous user, false if not.
  */
 …
  * @deprecated 2.5.0 bbPress (r5119)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_author( $topic_id = 0 ) {
     echo bbp_get_topic_author_display_name( $topic_id );
+}
+    /**
+     * Deprecated. Use bbp_get_topic_author_display_name() instead.
+     *
+     * Return the author of the topic
+     *
+     * @since 2.0.0 bbPress (r2590)
+     *
+     * @deprecated 2.5.0 bbPress (r5119)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Author of topic
+     */
+    function bbp_get_topic_author( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+            $author = get_the_author_meta( 'display_name', bbp_get_topic_author_id( $topic_id ) );
+        } else {
+            $author = get_post_meta( $topic_id, '_bbp_anonymous_name', true );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_author', $author, $topic_id );
+    }
+/**
+ * Output the author ID of the topic
+/**
+ * Deprecated. Use bbp_get_topic_author_display_name() instead.
+ *
+ * Return the author of the topic.
+ *
  * @since 2.0.0 bbPress (r2590)
+ *
+ * @param int $topic_id Optional. Topic id
+ * @deprecated 2.5.0 bbPress (r5119)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Author of topic.
+ */
+function bbp_get_topic_author( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+        $author = get_the_author_meta( 'display_name', bbp_get_topic_author_id( $topic_id ) );
+    } else {
+        $author = get_post_meta( $topic_id, '_bbp_anonymous_name', true );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author', $author, $topic_id );
+}
+/**
+ * Output the author ID of the topic.
+ *
+ * @since 2.0.0 bbPress (r2590)
+ *
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_author_id( $topic_id = 0 ) {
     echo bbp_get_topic_author_id( $topic_id );
+}
+    /**
+     * Return the author ID of the topic
+     *
+     * @since 2.0.0 bbPress (r2590)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Author of topic
+     */
+    function bbp_get_topic_author_id( $topic_id = 0 ) {
+        $topic_id  = bbp_get_topic_id( $topic_id );
+        $author_id = get_post_field( 'post_author', $topic_id );
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_topic_author_id', (int) $author_id, $topic_id );
+    }
+/**
+ * Output the author display_name of the topic
+/**
+ * Return the author ID of the topic.
+ *
  * @since 2.0.0 bbPress (r2590)
+ *
+ * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
+ * @return string Author of topic.
+ */
+function bbp_get_topic_author_id( $topic_id = 0 ) {
+    $topic_id  = bbp_get_topic_id( $topic_id );
+    $author_id = get_post_field( 'post_author', $topic_id );
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_topic_author_id', (int) $author_id, $topic_id );
+}
+/**
+ * Output the author display_name of the topic.
+ *
+ * @since 2.0.0 bbPress (r2590)
+ *
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_author_display_name( $topic_id = 0 ) {
     echo bbp_get_topic_author_display_name( $topic_id );
+}
+    /**
+     * Return the author display_name of the topic
+     *
+     * @since 2.0.0 bbPress (r2485)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Topic's author's display name
+     */
+    function bbp_get_topic_author_display_name( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Check for anonymous user
+        if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+            // Get the author ID
+            $author_id = bbp_get_topic_author_id( $topic_id );
+            // Try to get a display name
+            $author_name = get_the_author_meta( 'display_name', $author_id );
+            // Fall back to user login
+            if ( empty( $author_name ) ) {
+                $author_name = get_the_author_meta( 'user_login', $author_id );
+            }
+        // User does not have an account
+        } else {
+            $author_name = get_post_meta( $topic_id, '_bbp_anonymous_name', true );
+/**
+ * Return the author display_name of the topic.
+ *
+ * @since 2.0.0 bbPress (r2485)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Topic's author's display name.
+ */
+function bbp_get_topic_author_display_name( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Check for anonymous user
+    if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+        // Get the author ID
+        $author_id = bbp_get_topic_author_id( $topic_id );
+        // Try to get a display name
+        $author_name = get_the_author_meta( 'display_name', $author_id );
+        // Fall back to user login
+        if ( empty( $author_name ) ) {
+            $author_name = get_the_author_meta( 'user_login', $author_id );
+        }
+        // Fallback if nothing could be found
+        if ( empty( $author_name ) ) {
+            $author_name = bbp_get_fallback_display_name( $topic_id );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_author_display_name', $author_name, $topic_id );
+    }
+/**
+ * Output the author avatar of the topic
+    // User does not have an account
+    } else {
+        $author_name = get_post_meta( $topic_id, '_bbp_anonymous_name', true );
+    }
+    // Fallback if nothing could be found
+    if ( empty( $author_name ) ) {
+        $author_name = bbp_get_fallback_display_name( $topic_id );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author_display_name', $author_name, $topic_id );
+}
+/**
+ * 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
+ * @param int $topic_id Optional. Topic id.
+ * @param int $size Optional. Avatar size. Defaults to 40.
  */
 function bbp_topic_author_avatar( $topic_id = 0, $size = 40 ) {
     echo bbp_get_topic_author_avatar( $topic_id, $size );
+}
+    /**
+     * Return 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
+     * @return string Avatar of the author of the topic
+     */
+    function bbp_get_topic_author_avatar( $topic_id = 0, $size = 40 ) {
+        $author_avatar = '';
+        $topic_id = bbp_get_topic_id( $topic_id );
         if ( ! empty( $topic_id ) ) {
             if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
                 $author_avatar = get_avatar( bbp_get_topic_author_id( $topic_id ), $size );
             } else {
                 $author_avatar = get_avatar( get_post_meta( $topic_id, '_bbp_anonymous_email', true ), $size );
+            }
+/**
+ * Return 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.
+ * @return string Avatar of the author of the topic.
+ */
+function bbp_get_topic_author_avatar( $topic_id = 0, $size = 40 ) {
+    $author_avatar = '';
+    $topic_id = bbp_get_topic_id( $topic_id );
+    if ( ! empty( $topic_id ) ) {
+        if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+            $author_avatar = get_avatar( bbp_get_topic_author_id( $topic_id ), $size );
+        } else {
+            $author_avatar = get_avatar( get_post_meta( $topic_id, '_bbp_anonymous_email', true ), $size );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_author_avatar', $author_avatar, $topic_id, $size );
+    }
+/**
+ * Output the author link of the topic
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author_avatar', $author_avatar, $topic_id, $size );
+}
+/**
+ * Output the author link of the topic.
+ *
  * @since 2.0.0 bbPress (r2717)
 …
     echo bbp_get_topic_author_link( $args );
+}
+    /**
+     * Return 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.
+     * @return string Author link of topic
+     */
+    function bbp_get_topic_author_link( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'post_id'    => 0,
+                'link_title' => '',
+                'type'       => 'both',
+                'size'       => 80,
+                'sep'        => '',
+                'show_role'  => false
+            ),
+            'get_topic_author_link'
+        );
+        // Default return value
+        $author_link = '';
+        // Used as topic_id
+        $topic_id = is_numeric( $args )
+            ? bbp_get_topic_id( $args )
+            : bbp_get_topic_id( $r['post_id'] );
+        // Topic ID is good
+        if ( ! empty( $topic_id ) ) {
+            // Get some useful topic information
+            $author_url = bbp_get_topic_author_url( $topic_id );
+            $anonymous  = bbp_is_topic_anonymous( $topic_id );
+            // Tweak link title if empty
+            if ( empty( $r['link_title'] ) ) {
+                $author = bbp_get_topic_author_display_name( $topic_id );
+                $title  = empty( $anonymous )
+                    /* translators: %s: Author's name */
+                    ? esc_attr__( "View %s's profile",  'bbpress' )
+                    /* translators: %s: Author's name */
+                    : esc_attr__( "Visit %s's website", 'bbpress' );
+                $link_title = sprintf( $title, $author );
+            // Use what was passed if not
+            } else {
+                $link_title = $r['link_title'];
+            }
+            // Setup title and author_links array
+            $author_links = array();
+            $link_title   = ! empty( $link_title )
+                ? ' title="' . esc_attr( $link_title ) . '"'
+                : '';
+            // Get avatar (unescaped, because HTML)
+            if ( ( 'avatar' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+                $author_links['avatar'] = bbp_get_topic_author_avatar( $topic_id, $r['size'] );
+            }
+            // Get display name (escaped, because never HTML)
+            if ( ( 'name' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+                $author_links['name'] = esc_html( bbp_get_topic_author_display_name( $topic_id ) );
+            }
+            // Empty array
+            $links  = array();
+            $sprint = '<span%1$s>%2$s</span>';
+            // Wrap each link
+            foreach ( $author_links as $link => $link_text ) {
+                $link_class = ' class="bbp-author-' . esc_attr( $link ) . '"';
+                $links[]    = sprintf( $sprint, $link_class, $link_text );
+            }
+            // Juggle
+            $author_links = $links;
+            unset( $links );
+            // Filter sections
+            $sections = apply_filters( 'bbp_get_topic_author_links', $author_links, $r, $args );
+            // Assemble sections into author link
+            $author_link = implode( $r['sep'], $sections );
+            // Only wrap in link if profile exists
+            if ( empty( $anonymous ) && bbp_user_has_profile( bbp_get_topic_author_id( $topic_id ) ) ) {
+                $author_link = sprintf( '<a href="%1$s"%2$s%3$s>%4$s</a>', esc_url( $author_url ), $link_title, ' class="bbp-author-link"', $author_link );
+            }
+            // Role is not linked
+            if ( true === $r['show_role'] ) {
+                $author_link .= bbp_get_topic_author_role( array( 'topic_id' => $topic_id ) );
+            }
+/**
+ * Return 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.
+ * @return string Author link of topic.
+ */
+function bbp_get_topic_author_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'post_id'    => 0,
+            'link_title' => '',
+            'type'       => 'both',
+            'size'       => 80,
+            'sep'        => '',
+            'show_role'  => false
+        ),
+        'get_topic_author_link'
+    );
+    // Default return value
+    $author_link = '';
+    // Used as topic_id
+    $topic_id = is_numeric( $args )
+        ? bbp_get_topic_id( $args )
+        : bbp_get_topic_id( $r['post_id'] );
+    // Topic ID is good
+    if ( ! empty( $topic_id ) ) {
+        // Get some useful topic information
+        $author_url = bbp_get_topic_author_url( $topic_id );
+        $anonymous  = bbp_is_topic_anonymous( $topic_id );
+        // Tweak link title if empty
+        if ( empty( $r['link_title'] ) ) {
+            $author = bbp_get_topic_author_display_name( $topic_id );
+            $title  = empty( $anonymous )
+                /* translators: %s: Author's name */
+                ? esc_attr__( "View %s's profile",  'bbpress' )
+                /* translators: %s: Author's name */
+                : esc_attr__( "Visit %s's website", 'bbpress' );
+            $link_title = sprintf( $title, $author );
+        // Use what was passed if not
+        } else {
+            $link_title = $r['link_title'];
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_author_link', $author_link, $r, $args );
+    }
+/**
+ * Output the author url of the topic
+        // Setup title and author_links array
+        $author_links = array();
+        $link_title   = ! empty( $link_title )
+            ? ' title="' . esc_attr( $link_title ) . '"'
+            : '';
+        // Get avatar (unescaped, because HTML)
+        if ( ( 'avatar' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+            $author_links['avatar'] = bbp_get_topic_author_avatar( $topic_id, $r['size'] );
+        }
+        // Get display name (escaped, because never HTML)
+        if ( ( 'name' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+            $author_links['name'] = esc_html( bbp_get_topic_author_display_name( $topic_id ) );
+        }
+        // Empty array
+        $links  = array();
+        $sprint = '<span%1$s>%2$s</span>';
+        // Wrap each link
+        foreach ( $author_links as $link => $link_text ) {
+            $link_class = ' class="bbp-author-' . esc_attr( $link ) . '"';
+            $links[]    = sprintf( $sprint, $link_class, $link_text );
+        }
+        // Juggle
+        $author_links = $links;
+        unset( $links );
+        // Filter sections
+        $sections = apply_filters( 'bbp_get_topic_author_links', $author_links, $r, $args );
+        // Assemble sections into author link
+        $author_link = implode( $r['sep'], $sections );
+        // Only wrap in link if profile exists
+        if ( empty( $anonymous ) && bbp_user_has_profile( bbp_get_topic_author_id( $topic_id ) ) ) {
+            $author_link = sprintf( '<a href="%1$s"%2$s%3$s>%4$s</a>', esc_url( $author_url ), $link_title, ' class="bbp-author-link"', $author_link );
+        }
+        // Role is not linked
+        if ( true === $r['show_role'] ) {
+            $author_link .= bbp_get_topic_author_role( array( 'topic_id' => $topic_id ) );
+        }
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author_link', $author_link, $r, $args );
+}
+/**
+ * Output the author url of the topic.
+ *
  * @since 2.0.0 bbPress (r2590)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_author_url( $topic_id = 0 ) {
 …
+}
+    /**
+     * Return the author url of the topic
+     *
+     * @since 2.0.0 bbPress (r2590)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Author URL of topic
+     */
+    function bbp_get_topic_author_url( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Check for anonymous user or non-existant user
+        if ( ! bbp_is_topic_anonymous( $topic_id ) && bbp_user_has_profile( bbp_get_topic_author_id( $topic_id ) ) ) {
+            $author_url = bbp_get_user_profile_url( bbp_get_topic_author_id( $topic_id ) );
+        } else {
+            $author_url = get_post_meta( $topic_id, '_bbp_anonymous_website', true );
+            // Set empty author_url as empty string
+            if ( empty( $author_url ) ) {
+                $author_url = '';
+            }
+/**
+ * Return the author url of the topic.
+ *
+ * @since 2.0.0 bbPress (r2590)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Author URL of topic.
+ */
+function bbp_get_topic_author_url( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Check for anonymous user or non-existant user
+    if ( ! bbp_is_topic_anonymous( $topic_id ) && bbp_user_has_profile( bbp_get_topic_author_id( $topic_id ) ) ) {
+        $author_url = bbp_get_user_profile_url( bbp_get_topic_author_id( $topic_id ) );
+    } else {
+        $author_url = get_post_meta( $topic_id, '_bbp_anonymous_website', true );
+        // Set empty author_url as empty string
+        if ( empty( $author_url ) ) {
+            $author_url = '';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_author_url', $author_url, $topic_id );
+    }
+/**
+ * Output the topic author email address
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author_url', $author_url, $topic_id );
+}
+/**
+ * Output the topic author email address.
+ *
  * @since 2.0.0 bbPress (r3445)
+ *
  * @param int $topic_id Optional. Reply id
+ * @param int $topic_id Optional. Reply id.
  */
 function bbp_topic_author_email( $topic_id = 0 ) {
     echo bbp_get_topic_author_email( $topic_id );
+}
+    /**
+     * Return the topic author email address
+     *
+     * @since 2.0.0 bbPress (r3445)
+     *
+     * @param int $topic_id Optional. Reply id
+     * @return string Topic author email address
+     */
+    function bbp_get_topic_author_email( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Not anonymous user
         if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+            // Use topic author email address
             $user_id      = bbp_get_topic_author_id( $topic_id );
             $user         = get_userdata( $user_id );
             $author_email = ! empty( $user->user_email ) ? $user->user_email : '';
+        // Anonymous
         } else {
+            // Get email from post meta
             $author_email = get_post_meta( $topic_id, '_bbp_anonymous_email', true );
+            // Sanity check for missing email address
             if ( empty( $author_email ) ) {
                 $author_email = '';
+            }
+/**
+ * Return the topic author email address.
+ *
+ * @since 2.0.0 bbPress (r3445)
+ *
+ * @param int $topic_id Optional. Reply id.
+ * @return string Topic author email address.
+ */
+function bbp_get_topic_author_email( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Not anonymous user
+    if ( ! bbp_is_topic_anonymous( $topic_id ) ) {
+        // Use topic author email address
+        $user_id      = bbp_get_topic_author_id( $topic_id );
+        $user         = get_userdata( $user_id );
+        $author_email = ! empty( $user->user_email ) ? $user->user_email : '';
+    // Anonymous
+    } else {
+        // Get email from post meta
+        $author_email = get_post_meta( $topic_id, '_bbp_anonymous_email', true );
+        // Sanity check for missing email address
+        if ( empty( $author_email ) ) {
+            $author_email = '';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_author_email', $author_email, $topic_id );
+    }
+/**
+ * Output the topic author role
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author_email', $author_email, $topic_id );
+}
+/**
+ * Output the topic author role.
+ *
  * @since 2.1.0 bbPress (r3860)
 …
     echo bbp_get_topic_author_role( $args );
+}
+    /**
+     * Return the topic author role
+     *
+     * @since 2.1.0 bbPress (r3860)
+     *
+     * @param array $args Optional.
+     * @return string topic author role
+     */
+    function bbp_get_topic_author_role( $args = array() ) {
+        // Parse arguments against default values
         $r = bbp_parse_args(
             $args,
             array(
                 'topic_id' => 0,
                 'class'    => false,
                 'before'   => '<div class="bbp-author-role">',
                 'after'    => '</div>'
             ),
             'get_topic_author_role'
         );
+        $topic_id = bbp_get_topic_id( $r['topic_id'] );
         $role     = bbp_get_user_display_role( bbp_get_topic_author_id( $topic_id ) );
         $css_role = sanitize_key( $role );
+        // Add role as CSS class to default 'before' value.
         if ( empty( $args['before'] ) ) {
             $r['before'] = '<div class="bbp-author-role bbp-role-' . esc_attr( $css_role ) . '">';
+        }
+        // Backwards compatibilty with old 'class' argument
         if ( ! empty( $r['class'] ) ) {
             $author_role = sprintf( '%1$s<div class="%2$s">%3$s</div>%4$s', $r['before'], $r['class'], $role, $r['after'] );
+        // Simpler before & after arguments
         // https://bbpress.trac.wordpress.org/ticket/2557
         } else {
             $author_role = $r['before'] . $role . $r['after'];
+        }
+        // Filter & return
         return apply_filters( 'bbp_get_topic_author_role', $author_role, $r );
+    }
 /**
  * Output the title of the forum a topic belongs to
+/**
+ * Return the topic author role.
+ *
+ * @since 2.1.0 bbPress (r3860)
+ *
+ * @param array $args Optional.
+ * @return string topic author role.
+ */
+function bbp_get_topic_author_role( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'topic_id' => 0,
+            'class'    => false,
+            'before'   => '<div class="bbp-author-role">',
+            'after'    => '</div>'
+        ),
+        'get_topic_author_role'
+    );
+    $topic_id = bbp_get_topic_id( $r['topic_id'] );
+    $role     = bbp_get_user_display_role( bbp_get_topic_author_id( $topic_id ) );
+    $css_role = sanitize_key( $role );
+    // Add role as CSS class to default 'before' value.
+    if ( empty( $args['before'] ) ) {
+        $r['before'] = '<div class="bbp-author-role bbp-role-' . esc_attr( $css_role ) . '">';
+    }
+    // Backwards compatibilty with old 'class' argument
+    if ( ! empty( $r['class'] ) ) {
+        $author_role = sprintf( '%1$s<div class="%2$s">%3$s</div>%4$s', $r['before'], $r['class'], $role, $r['after'] );
+    // Simpler before & after arguments
+    // https://bbpress.trac.wordpress.org/ticket/2557
+    } else {
+        $author_role = $r['before'] . $role . $r['after'];
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_author_role', $author_role, $r );
+}
+/**
+ * Output the title of the forum a topic belongs to.
+ *
  * @since 2.0.0 bbPress (r2485)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_forum_title( $topic_id = 0 ) {
     echo bbp_get_topic_forum_title( $topic_id );
+}
+    /**
+     * Return the title of the forum a topic belongs to
+     *
+     * @since 2.0.0 bbPress (r2485)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Topic forum title
+     */
+    function bbp_get_topic_forum_title( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $forum_id = bbp_get_topic_forum_id( $topic_id );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_forum', bbp_get_forum_title( $forum_id ), $topic_id, $forum_id );
+    }
+/**
+ * Output the forum id a topic belongs to
+/**
+ * Return the title of the forum a topic belongs to.
+ *
+ * @since 2.0.0 bbPress (r2485)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Topic forum title.
+ */
+function bbp_get_topic_forum_title( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $forum_id = bbp_get_topic_forum_id( $topic_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_forum', bbp_get_forum_title( $forum_id ), $topic_id, $forum_id );
+}
+/**
+ * Output the forum id a topic belongs to.
+ *
  * @since 2.0.0 bbPress (r2491)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_forum_id( $topic_id = 0 ) {
     echo bbp_get_topic_forum_id( $topic_id );
+}
+    /**
+     * Return the forum id a topic belongs to
+     *
+     * @since 2.0.0 bbPress (r2491)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return int Topic forum id
+     */
+    function bbp_get_topic_forum_id( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $forum_id = (int) get_post_field( 'post_parent', $topic_id );
+        // Meta-data fallback
+        if ( empty( $forum_id ) ) {
+            $forum_id = (int) get_post_meta( $topic_id, '_bbp_forum_id', true );
+        }
+        // Filter
+        if ( ! empty( $forum_id ) ) {
+            $forum_id = (int) bbp_get_forum_id( $forum_id );
+        }
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_topic_forum_id', $forum_id, $topic_id );
+    }
+/**
+ * Output the topics last active ID
+/**
+ * Return the forum id a topic belongs to.
+ *
+ * @since 2.0.0 bbPress (r2491)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return int Topic forum id.
+ */
+function bbp_get_topic_forum_id( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $forum_id = (int) get_post_field( 'post_parent', $topic_id );
+    // Meta-data fallback
+    if ( empty( $forum_id ) ) {
+        $forum_id = (int) get_post_meta( $topic_id, '_bbp_forum_id', true );
+    }
+    // Filter
+    if ( ! empty( $forum_id ) ) {
+        $forum_id = (int) bbp_get_forum_id( $forum_id );
+    }
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_topic_forum_id', $forum_id, $topic_id );
+}
+/**
+ * Output the topics last active ID.
+ *
  * @since 2.0.0 bbPress (r2860)
+ *
  * @param int $topic_id Optional. Forum id
+ * @param int $topic_id Optional. Forum id.
  */
 function bbp_topic_last_active_id( $topic_id = 0 ) {
     echo bbp_get_topic_last_active_id( $topic_id );
+}
+    /**
+     * Return the topics last active ID
+     *
+     * @since 2.0.0 bbPress (r2860)
+     *
+     * @param int $topic_id Optional. Forum id
+     * @return int Forum's last active id
+     */
+    function bbp_get_topic_last_active_id( $topic_id = 0 ) {
+        $topic_id  = bbp_get_topic_id( $topic_id );
+        $active_id = (int) get_post_meta( $topic_id, '_bbp_last_active_id', true );
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_topic_last_active_id', $active_id, $topic_id );
+    }
+/**
+ * Output the topics last update date/time (aka freshness)
+/**
+ * Return the topics last active ID.
+ *
+ * @since 2.0.0 bbPress (r2860)
+ *
+ * @param int $topic_id Optional. Forum id.
+ * @return int Forum's last active id.
+ */
+function bbp_get_topic_last_active_id( $topic_id = 0 ) {
+    $topic_id  = bbp_get_topic_id( $topic_id );
+    $active_id = (int) get_post_meta( $topic_id, '_bbp_last_active_id', true );
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_topic_last_active_id', $active_id, $topic_id );
+}
+/**
+ * Output the topics last update date/time (aka freshness).
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_last_active_time( $topic_id = 0 ) {
     echo bbp_get_topic_last_active_time( $topic_id );
+}
+    /**
+     * Return the topics last update date/time (aka freshness)
+     *
+     * @since 2.0.0 bbPress (r2625)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Topic freshness
+     */
+    function bbp_get_topic_last_active_time( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Try to get the most accurate freshness time possible
         $last_active = get_post_meta( $topic_id, '_bbp_last_active_time', true );
         if ( empty( $last_active ) ) {
             $reply_id = bbp_get_topic_last_reply_id( $topic_id );
             if ( ! empty( $reply_id ) ) {
                 $last_active = get_post_field( 'post_date', $reply_id );
             } else {
                 $last_active = get_post_field( 'post_date', $topic_id );
+            }
+/**
+ * Return the topics last update date/time (aka freshness).
+ *
+ * @since 2.0.0 bbPress (r2625)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Topic freshness.
+ */
+function bbp_get_topic_last_active_time( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Try to get the most accurate freshness time possible
+    $last_active = get_post_meta( $topic_id, '_bbp_last_active_time', true );
+    if ( empty( $last_active ) ) {
+        $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+        if ( ! empty( $reply_id ) ) {
+            $last_active = get_post_field( 'post_date', $reply_id );
+        } else {
+            $last_active = get_post_field( 'post_date', $topic_id );
+        }
+        $last_active = ! empty( $last_active ) ? bbp_get_time_since( bbp_convert_date( $last_active ) ) : '';
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_last_active', $last_active, $topic_id );
+    }
+    }
+    $last_active = ! empty( $last_active ) ? bbp_get_time_since( bbp_convert_date( $last_active ) ) : '';
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_last_active', $last_active, $topic_id );
+}
 /** Topic Subscriptions *******************************************************/
 /**
  * Output the topic subscription link
+ * Output the topic subscription link.
+ *
  * @since 2.5.0 bbPress (r5156)
 …
+}
+    /**
+     * 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
+     */
+    function bbp_get_topic_subscription_link( $args = array() ) {
+        // Defaults
+        $retval      = false;
+        $user_id     = bbp_get_current_user_id();
+        $redirect_to = bbp_is_subscriptions()
+            ? bbp_get_subscriptions_permalink( $user_id )
+            : '';
+        // Parse the arguments
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'user_id'     => $user_id,
+                'object_id'   => bbp_get_topic_id(),
+                'object_type' => 'post',
+                'before'      => '&nbsp;|&nbsp;',
+                'after'       => '',
+                'subscribe'   => esc_html__( 'Subscribe',   'bbpress' ),
+                'unsubscribe' => esc_html__( 'Unsubscribe', 'bbpress' ),
+                'redirect_to' => $redirect_to
+            ),
+            'get_topic_subscribe_link'
+        );
+        // Get the link
+        $retval = bbp_get_user_subscribe_link( $r );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_subscribe_link', $retval, $r, $args );
+    }
+/** Topic Favorites ***********************************************************/
+/**
+ * Output the topic favorite link
+/**
+ * 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
  */
+function bbp_get_topic_subscription_link( $args = array() ) {
+    // Defaults
+    $retval      = false;
+    $user_id     = bbp_get_current_user_id();
+    $redirect_to = bbp_is_subscriptions()
+        ? bbp_get_subscriptions_permalink( $user_id )
+        : '';
+    // Parse the arguments
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'user_id'     => $user_id,
+            'object_id'   => bbp_get_topic_id(),
+            'object_type' => 'post',
+            'before'      => '&nbsp;|&nbsp;',
+            'after'       => '',
+            'subscribe'   => esc_html__( 'Subscribe',   'bbpress' ),
+            'unsubscribe' => esc_html__( 'Unsubscribe', 'bbpress' ),
+            'redirect_to' => $redirect_to
+        ),
+        'get_topic_subscribe_link'
+    );
+    // Get the link
+    $retval = bbp_get_user_subscribe_link( $r );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_subscribe_link', $retval, $r, $args );
+}
+/** Topic Favorites ***********************************************************/
+/**
+ * Output the topic favorite link.
+ *
+ * @since 2.5.0 bbPress (r5156)
+ * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+ */
 function bbp_topic_favorite_link( $args = array() ) {
     echo bbp_get_topic_favorite_link( $args );
+}
     /**
+     * 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
      */
     function bbp_get_topic_favorite_link( $args = array() ) {
         // No link
         $retval      = false;
         $user_id     = bbp_get_current_user_id();
         $redirect_to = bbp_is_favorites()
             ? bbp_get_favorites_permalink( $user_id )
             : '';
         // Parse the arguments
         $r = bbp_parse_args(
             $args,
             array(
                 'user_id'     => $user_id,
                 'object_id'   => bbp_get_topic_id(),
                 'object_type' => 'post',
                 'before'      => '',
                 'after'       => '',
                 'favorite'    => esc_html__( 'Favorite',   'bbpress' ),
                 'favorited'   => esc_html__( 'Unfavorite', 'bbpress' ),
                 'redirect_to' => $redirect_to
             ),
             'get_topic_favorite_link'
         );
         // Get the link
         $retval = bbp_get_user_favorites_link( $r );
         // Filter & return
         return apply_filters( 'bbp_get_topic_favorite_link', $retval, $r, $args );
+    }
+/**
+ * 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
+ */
+function bbp_get_topic_favorite_link( $args = array() ) {
+    // No link
+    $retval      = false;
+    $user_id     = bbp_get_current_user_id();
+    $redirect_to = bbp_is_favorites()
+        ? bbp_get_favorites_permalink( $user_id )
+        : '';
+    // Parse the arguments
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'user_id'     => $user_id,
+            'object_id'   => bbp_get_topic_id(),
+            'object_type' => 'post',
+            'before'      => '',
+            'after'       => '',
+            'favorite'    => esc_html__( 'Favorite',   'bbpress' ),
+            'favorited'   => esc_html__( 'Unfavorite', 'bbpress' ),
+            'redirect_to' => $redirect_to
+        ),
+        'get_topic_favorite_link'
+    );
+    // Get the link
+    $retval = bbp_get_user_favorites_link( $r );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_favorite_link', $retval, $r, $args );
+}
 /** Topic Last Reply **********************************************************/
 /**
  * Output the id of the topics last reply
+ * Output the id of the topics last reply.
+ *
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_last_reply_id( $topic_id = 0 ) {
     echo bbp_get_topic_last_reply_id( $topic_id );
+}
+    /**
+     * Return the id of the topics last reply
+     *
+     * @since 2.0.0 bbPress (r2625)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return int Topic last reply id
+     */
+    function bbp_get_topic_last_reply_id( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $reply_id = (int) get_post_meta( $topic_id, '_bbp_last_reply_id', true );
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_topic_last_reply_id', $reply_id, $topic_id );
+    }
+/**
+ * Output the title of the last reply inside a topic
+/**
+ * Return the id of the topics last reply.
+ *
+ * @since 2.0.0 bbPress (r2625)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return int Topic last reply id.
+ */
+function bbp_get_topic_last_reply_id( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $reply_id = (int) get_post_meta( $topic_id, '_bbp_last_reply_id', true );
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_topic_last_reply_id', $reply_id, $topic_id );
+}
+/**
+ * Output the title of the last reply inside a topic.
+ *
  * @since 2.0.0 bbPress (r2753)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_last_reply_title( $topic_id = 0 ) {
     echo bbp_get_topic_last_reply_title( $topic_id );
+}
+    /**
+     * Return the title of the last reply inside a topic
+     *
+     * @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
+     * @return string Topic last reply title
+     */
+    function bbp_get_topic_last_reply_title( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+        $retval   = bbp_get_reply_title( $reply_id );
+        // Misspelled. Use 'bbp_get_topic_last_reply_title' hook instead.
+        $retval = apply_filters( 'bbp_get_topic_last_topic_title', $retval, $topic_id, $reply_id );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_last_reply_title', $retval, $topic_id, $reply_id );
+    }
+/**
+ * Output the link to the last reply in a topic
+/**
+ * Return the title of the last reply inside a topic.
+ *
+ * @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.
+ * @return string Topic last reply title.
+ */
+function bbp_get_topic_last_reply_title( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+    $retval   = bbp_get_reply_title( $reply_id );
+    // Misspelled. Use 'bbp_get_topic_last_reply_title' hook instead.
+    $retval = apply_filters( 'bbp_get_topic_last_topic_title', $retval, $topic_id, $reply_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_last_reply_title', $retval, $topic_id, $reply_id );
+}
+/**
+ * Output the link to the last reply in a topic.
+ *
  * @since 2.0.0 bbPress (r2464)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_last_reply_permalink( $topic_id = 0 ) {
     echo esc_url( bbp_get_topic_last_reply_permalink( $topic_id ) );
+}
+    /**
+     * Return the link to the last reply in a topic
+     *
+     * @since 2.0.0 bbPress (r2464)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Permanent link to the reply
+     */
+    function bbp_get_topic_last_reply_permalink( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+        $retval   = bbp_get_reply_permalink( $reply_id );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_last_reply_permalink', $retval, $topic_id, $reply_id );
+    }
+/**
+ * Output the link to the last reply in a topic
+/**
+ * Return the link to the last reply in a topic.
+ *
+ * @since 2.0.0 bbPress (r2464)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Permanent link to the reply.
+ */
+function bbp_get_topic_last_reply_permalink( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+    $retval   = bbp_get_reply_permalink( $reply_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_last_reply_permalink', $retval, $topic_id, $reply_id );
+}
+/**
+ * Output the link to the last reply in a topic.
+ *
  * @since 2.0.0 bbPress (r2683)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_last_reply_url( $topic_id = 0 ) {
     echo esc_url( bbp_get_topic_last_reply_url( $topic_id ) );
+}
+    /**
+     * Return the link to the last reply in a topic
+     *
+     * @since 2.0.0 bbPress (r2683)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Topic last reply url
+     */
+    function bbp_get_topic_last_reply_url( $topic_id = 0 ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+        if ( ! empty( $reply_id ) && ( $reply_id !== $topic_id ) ) {
+            $reply_url = bbp_get_reply_url( $reply_id );
+        } else {
+            $reply_url = bbp_get_topic_permalink( $topic_id );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_last_reply_url', $reply_url, $topic_id, $reply_id );
+    }
+/**
+ * Return the link to the last reply in a topic.
+ *
+ * @since 2.0.0 bbPress (r2683)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Topic last reply url.
+ */
+function bbp_get_topic_last_reply_url( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $reply_id = bbp_get_topic_last_reply_id( $topic_id );
+    if ( ! empty( $reply_id ) && ( $reply_id !== $topic_id ) ) {
+        $reply_url = bbp_get_reply_url( $reply_id );
+    } else {
+        $reply_url = bbp_get_topic_permalink( $topic_id );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_last_reply_url', $reply_url, $topic_id, $reply_id );
+}
 /**
 …
  * @since 2.0.0 bbPress (r2625)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_freshness_link( $topic_id = 0 ) {
     echo bbp_get_topic_freshness_link( $topic_id );
+}
+    /**
+     * Returns 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
+     * @return string Topic freshness link
+     */
+    function bbp_get_topic_freshness_link( $topic_id = 0 ) {
+        $topic_id   = bbp_get_topic_id( $topic_id );
+        $link_url   = bbp_get_topic_last_reply_url( $topic_id );
+        $title      = bbp_get_topic_last_reply_title( $topic_id );
+        $time_since = bbp_get_topic_last_active_time( $topic_id );
+        if ( ! empty( $time_since ) ) {
+            $anchor = '<a href="' . esc_url( $link_url ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $time_since ) . '</a>';
+        } else {
+            $anchor = esc_html__( 'No Replies', 'bbpress' );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_freshness_link', $anchor, $topic_id, $time_since, $link_url, $title );
+    }
+/**
+ * Output the replies link of the topic
+/**
+ * Returns 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.
+ * @return string Topic freshness link.
+ */
+function bbp_get_topic_freshness_link( $topic_id = 0 ) {
+    $topic_id   = bbp_get_topic_id( $topic_id );
+    $link_url   = bbp_get_topic_last_reply_url( $topic_id );
+    $title      = bbp_get_topic_last_reply_title( $topic_id );
+    $time_since = bbp_get_topic_last_active_time( $topic_id );
+    if ( ! empty( $time_since ) ) {
+        $anchor = '<a href="' . esc_url( $link_url ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $time_since ) . '</a>';
+    } else {
+        $anchor = esc_html__( 'No Replies', 'bbpress' );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_freshness_link', $anchor, $topic_id, $time_since, $link_url, $title );
+}
+/**
+ * Output the replies link of the topic.
+ *
  * @since 2.0.0 bbPress (r2740)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_replies_link( $topic_id = 0 ) {
 …
+}
     /**
+     * Return the replies link of the topic
+     *
      * @since 2.0.0 bbPress (r2740)
+     *
+     * @param int $topic_id Optional. Topic id
      */
     function bbp_get_topic_replies_link( $topic_id = 0 ) {
         $topic_id = bbp_get_topic_id( $topic_id );
         $link     = bbp_get_topic_permalink( $topic_id );
         /* translators: %s: Number of replies */
         $replies  = sprintf( _n( '%s reply', '%s replies', bbp_get_topic_reply_count( $topic_id, true ), 'bbpress' ), bbp_get_topic_reply_count( $topic_id, false ) );
         // First link never has view=all
         $retval = bbp_get_view_all( 'edit_others_replies' )
             ? "<a href='" . esc_url( bbp_remove_view_all( $link ) ) . "'>" . esc_html( $replies ) . '</a>'
             : $replies;
         // Any deleted replies?
         $deleted_int = bbp_get_topic_reply_count_hidden( $topic_id, true  );
         // This topic has hidden replies
         if ( ! empty( $deleted_int ) && current_user_can( 'edit_others_replies' ) ) {
             // Hidden replies
             $deleted_num = bbp_get_topic_reply_count_hidden( $topic_id, false );
             /* translators: %s: Number of hidden replies */
             $extra       = ' ' . sprintf( _n( '(+%s hidden)', '(+%s hidden)', $deleted_int, 'bbpress' ), $deleted_num );
             // Hidden link
             $retval .= ! bbp_get_view_all( 'edit_others_replies' )
                 ? " <a href='" . esc_url( bbp_add_view_all( $link, true ) ) . "'>" . esc_html( $extra ) . '</a>'
                 : " {$extra}";
+        }
         // Filter & return
         return apply_filters( 'bbp_get_topic_replies_link', $retval, $topic_id );
+    }
 /**
  * Output total reply count of a topic
+/**
+ * Return the replies link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2740)
+ *
+ * @param int $topic_id Optional. Topic id.
+ */
+function bbp_get_topic_replies_link( $topic_id = 0 ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $link     = bbp_get_topic_permalink( $topic_id );
+    /* translators: %s: Number of replies */
+    $replies  = sprintf( _n( '%s reply', '%s replies', bbp_get_topic_reply_count( $topic_id, true ), 'bbpress' ), bbp_get_topic_reply_count( $topic_id, false ) );
+    // First link never has view=all
+    $retval = bbp_get_view_all( 'edit_others_replies' )
+        ? "<a href='" . esc_url( bbp_remove_view_all( $link ) ) . "'>" . esc_html( $replies ) . '</a>'
+        : $replies;
+    // Any deleted replies?
+    $deleted_int = bbp_get_topic_reply_count_hidden( $topic_id, true  );
+    // This topic has hidden replies
+    if ( ! empty( $deleted_int ) && current_user_can( 'edit_others_replies' ) ) {
+        // Hidden replies
+        $deleted_num = bbp_get_topic_reply_count_hidden( $topic_id, false );
+        /* translators: %s: Number of hidden replies */
+        $extra       = ' ' . sprintf( _n( '(+%s hidden)', '(+%s hidden)', $deleted_int, 'bbpress' ), $deleted_num );
+        // Hidden link
+        $retval .= ! bbp_get_view_all( 'edit_others_replies' )
+            ? " <a href='" . esc_url( bbp_add_view_all( $link, true ) ) . "'>" . esc_html( $extra ) . '</a>'
+            : " {$extra}";
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_replies_link', $retval, $topic_id );
+}
+/**
+ * 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
+ * @param int $topic_id Optional. Topic id.
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_topic_reply_count( $topic_id = 0, $integer = false ) {
     echo bbp_get_topic_reply_count( $topic_id, $integer );
+}
+    /**
+     * Return 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
+     * @return int Reply count
+     */
+    function bbp_get_topic_reply_count( $topic_id = 0, $integer = false ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $replies  = (int) get_post_meta( $topic_id, '_bbp_reply_count', true );
+        $filter   = ( true === $integer )
+            ? 'bbp_get_topic_reply_count_int'
+            : 'bbp_get_topic_reply_count';
+        return apply_filters( $filter, $replies, $topic_id );
+    }
+/**
+ * Output total post count of a topic
+/**
+ * Return 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.
+ * @return int Reply count.
+ */
+function bbp_get_topic_reply_count( $topic_id = 0, $integer = false ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $replies  = (int) get_post_meta( $topic_id, '_bbp_reply_count', true );
+    $filter   = ( true === $integer )
+        ? 'bbp_get_topic_reply_count_int'
+        : 'bbp_get_topic_reply_count';
+    return apply_filters( $filter, $replies, $topic_id );
+}
+/**
+ * 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
+ * @param int $topic_id Optional. Topic id.
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_topic_post_count( $topic_id = 0, $integer = false ) {
     echo bbp_get_topic_post_count( $topic_id, $integer );
+}
+    /**
+     * Return 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
+     * @return int Post count
+     */
+    function bbp_get_topic_post_count( $topic_id = 0, $integer = false ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $replies  = ( (int) get_post_meta( $topic_id, '_bbp_reply_count', true ) ) + 1;
+        $filter   = ( true === $integer )
+            ? 'bbp_get_topic_post_count_int'
+            : 'bbp_get_topic_post_count';
+        return apply_filters( $filter, $replies, $topic_id );
+    }
+/**
+ * Return 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.
+ * @return int Post count.
+ */
+function bbp_get_topic_post_count( $topic_id = 0, $integer = false ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $replies  = ( (int) get_post_meta( $topic_id, '_bbp_reply_count', true ) ) + 1;
+    $filter   = ( true === $integer )
+        ? 'bbp_get_topic_post_count_int'
+        : 'bbp_get_topic_post_count';
+    return apply_filters( $filter, $replies, $topic_id );
+}
 /**
  * Output total hidden reply count of a topic (hidden includes trashed and
  * spammed replies)
+ * 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
+ * @param int $topic_id Optional. Topic id.
+ * @param boolean $integer Optional. Whether or not to format the result.
  */
 function bbp_topic_reply_count_hidden( $topic_id = 0, $integer = false ) {
     echo bbp_get_topic_reply_count_hidden( $topic_id, $integer );
+}
+    /**
+     * Return 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
+     * @return int Topic hidden reply count
+     */
+    function bbp_get_topic_reply_count_hidden( $topic_id = 0, $integer = false ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $replies  = (int) get_post_meta( $topic_id, '_bbp_reply_count_hidden', true );
+        $filter   = ( true === $integer )
+            ? 'bbp_get_topic_reply_count_hidden_int'
+            : 'bbp_get_topic_reply_count_hidden';
+        return apply_filters( $filter, $replies, $topic_id );
+    }
+/**
+ * Output total voice count of a topic
+/**
+ * Return 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.
+ * @return int Topic hidden reply count.
+ */
+function bbp_get_topic_reply_count_hidden( $topic_id = 0, $integer = false ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $replies  = (int) get_post_meta( $topic_id, '_bbp_reply_count_hidden', true );
+    $filter   = ( true === $integer )
+        ? 'bbp_get_topic_reply_count_hidden_int'
+        : 'bbp_get_topic_reply_count_hidden';
+    return apply_filters( $filter, $replies, $topic_id );
+}
+/**
+ * Output total voice count of a topic.
+ *
  * @since 2.0.0 bbPress (r2567)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_voice_count( $topic_id = 0, $integer = false ) {
     echo bbp_get_topic_voice_count( $topic_id, $integer );
+}
+    /**
+     * Return total voice count of a topic
+     *
+     * @since 2.0.0 bbPress (r2567)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return int Voice count of the topic
+     */
+    function bbp_get_topic_voice_count( $topic_id = 0, $integer = false ) {
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $voices   = (int) get_post_meta( $topic_id, '_bbp_voice_count', true );
+        $filter   = ( true === $integer )
+            ? 'bbp_get_topic_voice_count_int'
+            : 'bbp_get_topic_voice_count';
+        return apply_filters( $filter, $voices, $topic_id );
+    }
+/**
+ * Output a the tags of a topic
+/**
+ * Return total voice count of a topic.
+ *
+ * @since 2.0.0 bbPress (r2567)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return int Voice count of the topic.
+ */
+function bbp_get_topic_voice_count( $topic_id = 0, $integer = false ) {
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $voices   = (int) get_post_meta( $topic_id, '_bbp_voice_count', true );
+    $filter   = ( true === $integer )
+        ? 'bbp_get_topic_voice_count_int'
+        : 'bbp_get_topic_voice_count';
+    return apply_filters( $filter, $voices, $topic_id );
+}
+/**
+ * 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()}
+ * @param int $topic_id Optional. Topic id.
+ * @param array $args See {@link bbp_get_topic_tag_list()}.
  */
 function bbp_topic_tag_list( $topic_id = 0, $args = array() ) {
     echo bbp_get_topic_tag_list( $topic_id, $args );
+}
+    /**
+     * Return the tags of a topic
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @param array $args This function supports these arguments:
+     *  - before: Before the tag list
+     *  - sep: Tag separator
+     *  - after: After the tag list
+     * @return string Tag list of the topic
+     */
+    function bbp_get_topic_tag_list( $topic_id = 0, $args = array() ) {
+        // Bail if topic-tags are off
+        if ( ! bbp_allow_topic_tags() ) {
+            return '';
+/**
+ * Return the tags of a topic.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @param array $args This function supports these arguments:
+ *  - before: Before the tag list
+ *  - sep: Tag separator
+ *  - after: After the tag list
+ * @return string Tag list of the topic.
+ */
+function bbp_get_topic_tag_list( $topic_id = 0, $args = array() ) {
+    // Bail if topic-tags are off
+    if ( ! bbp_allow_topic_tags() ) {
+        return '';
+    }
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'before' => '<div class="bbp-topic-tags"><p>' . esc_html__( 'Tagged:', 'bbpress' ) . '&nbsp;',
+            'sep'    => ', ',
+            'after'  => '</p></div>',
+            'none'   => ''
+        ),
+        'get_topic_tag_list'
+    );
+    $topic_id = bbp_get_topic_id( $topic_id );
+    // Topic is spammed, so display pre-spam terms
+    if ( bbp_is_topic_spam( $topic_id ) ) {
+        // Get pre-spam terms
+        $terms = get_post_meta( $topic_id, '_bbp_spam_topic_tags', true );
+        // If terms exist, implode them and compile the return value
+        if ( ! empty( $terms ) ) {
+            $terms = $r['before'] . implode( $r['sep'], $terms ) . $r['after'];
+        }
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'before' => '<div class="bbp-topic-tags"><p>' . esc_html__( 'Tagged:', 'bbpress' ) . '&nbsp;',
+                'sep'    => ', ',
+                'after'  => '</p></div>',
+                'none'   => ''
+            ),
+            'get_topic_tag_list'
+        );
+        $topic_id = bbp_get_topic_id( $topic_id );
+        // Topic is spammed, so display pre-spam terms
+        if ( bbp_is_topic_spam( $topic_id ) ) {
+            // Get pre-spam terms
+            $terms = get_post_meta( $topic_id, '_bbp_spam_topic_tags', true );
+            // If terms exist, implode them and compile the return value
+            if ( ! empty( $terms ) ) {
+                $terms = $r['before'] . implode( $r['sep'], $terms ) . $r['after'];
+            }
+        // Topic is not spam so display a clickable term list
+        } else {
+            $terms = get_the_term_list( $topic_id, bbp_get_topic_tag_tax_id(), $r['before'], $r['sep'], $r['after'] );
+        }
+        // No terms so return none string
+        if ( ! empty( $terms ) ) {
+            $retval = $terms;
+        } else {
+            $retval = $r['none'];
+        }
+        return $retval;
+    }
+/**
+ * Output the row class of a topic
+    // Topic is not spam so display a clickable term list
+    } else {
+        $terms = get_the_term_list( $topic_id, bbp_get_topic_tag_tax_id(), $r['before'], $r['sep'], $r['after'] );
+    }
+    // No terms so return none string
+    if ( ! empty( $terms ) ) {
+        $retval = $terms;
+    } else {
+        $retval = $r['none'];
+    }
+    return $retval;
+}
+/**
+ * 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
+ * @param int $topic_id Optional. Topic id.
+ * @param array Extra classes you can pass when calling this function.
  */
 function bbp_topic_class( $topic_id = 0, $classes = array() ) {
     echo bbp_get_topic_class( $topic_id, $classes );
+}
+    /**
+     * Return 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
+     * @return string Row class of a topic
+     */
+    function bbp_get_topic_class( $topic_id = 0, $classes = array() ) {
+        $bbp       = bbpress();
+        $topic_id  = bbp_get_topic_id( $topic_id );
+        $forum_id  = bbp_get_topic_forum_id( $topic_id );
+        $author_id = bbp_get_topic_author_id( $topic_id );
+        $classes   = array_filter( (array) $classes );
+        $count     = isset( $bbp->topic_query->current_post )
+            ? (int) $bbp->topic_query->current_post
+            : 1;
+        //  Stripes
+        $even_odd = ( $count % 2 )
+            ? 'even'
+            : 'odd';
+        // Forum moderator replied to topic
+        $forum_moderator = ( bbp_is_user_forum_moderator( $author_id, $forum_id ) === $author_id )
+            ? 'forum-mod'
+            : '';
+        // Is this topic a sticky?
+        $sticky = bbp_is_topic_sticky( $topic_id, false )
+            ? 'sticky'
+            : '';
+        // Is this topic a super-sticky?
+        $super_sticky = bbp_is_topic_super_sticky( $topic_id  )
+            ? 'super-sticky'
+            : '';
+        // Get topic classes
+        $topic_classes = array(
+            'loop-item-'        . $count,
+            'user-id-'          . $author_id,
+            'bbp-parent-forum-' . $forum_id,
+            $even_odd,
+            $forum_moderator,
+            $sticky,
+            $super_sticky
+        );
+        // Run the topic classes through the post-class filters, which also
+        // handles the escaping of each individual class.
+        $post_classes = get_post_class( array_merge( $classes, $topic_classes ), $topic_id );
+        // Filter
+        $new_classes  = apply_filters( 'bbp_get_topic_class', $post_classes, $topic_id, $classes );
+        // Return
+        return 'class="' . implode( ' ', $new_classes ) . '"';
+    }
+/**
+ * Return 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.
+ * @return string Row class of a topic.
+ */
+function bbp_get_topic_class( $topic_id = 0, $classes = array() ) {
+    $bbp       = bbpress();
+    $topic_id  = bbp_get_topic_id( $topic_id );
+    $forum_id  = bbp_get_topic_forum_id( $topic_id );
+    $author_id = bbp_get_topic_author_id( $topic_id );
+    $classes   = array_filter( (array) $classes );
+    $count     = isset( $bbp->topic_query->current_post )
+        ? (int) $bbp->topic_query->current_post
+        : 1;
+    //  Stripes
+    $even_odd = ( $count % 2 )
+        ? 'even'
+        : 'odd';
+    // Forum moderator replied to topic
+    $forum_moderator = ( bbp_is_user_forum_moderator( $author_id, $forum_id ) === $author_id )
+        ? 'forum-mod'
+        : '';
+    // Is this topic a sticky?
+    $sticky = bbp_is_topic_sticky( $topic_id, false )
+        ? 'sticky'
+        : '';
+    // Is this topic a super-sticky?
+    $super_sticky = bbp_is_topic_super_sticky( $topic_id  )
+        ? 'super-sticky'
+        : '';
+    // Get topic classes
+    $topic_classes = array(
+        'loop-item-'        . $count,
+        'user-id-'          . $author_id,
+        'bbp-parent-forum-' . $forum_id,
+        $even_odd,
+        $forum_moderator,
+        $sticky,
+        $super_sticky
+    );
+    // Run the topic classes through the post-class filters, which also
+    // handles the escaping of each individual class.
+    $post_classes = get_post_class( array_merge( $classes, $topic_classes ), $topic_id );
+    // Filter
+    $new_classes  = apply_filters( 'bbp_get_topic_class', $post_classes, $topic_id, $classes );
+    // Return
+    return 'class="' . implode( ' ', $new_classes ) . '"';
+}
 /** Topic Admin Links *********************************************************/
 /**
  * Output admin links for topic
+ *
  * @param array $args See {@link bbp_get_topic_admin_links()}
+ * Output admin links for topic.
+ *
+ * @param array $args See {@link bbp_get_topic_admin_links()}.
  */
 function bbp_topic_admin_links( $args = array() ) {
     echo bbp_get_topic_admin_links( $args );
+}
+    /**
+     * Return admin links for topic.
+     *
+     * Move topic functionality is handled by the edit topic page.
+     *
+     * @param array $args This function supports these arguments:
+     *  - id: Optional. Topic id
+     *  - before: Before the links
+     *  - after: After the links
+     *  - sep: Links separator
+     *  - links: Topic admin links array
+     * @return string Topic admin links
+     */
+    function bbp_get_topic_admin_links( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+/**
+ * Return admin links for topic.
+ *
+ * Move topic functionality is handled by the edit topic page.
+ *
+ * @param array $args This function supports these arguments:
+ *  - id: Optional. Topic id
+ *  - before: Before the links
+ *  - after: After the links
+ *  - sep: Links separator
+ *  - links: Topic admin links array
+ * @return string Topic admin links.
+ */
+function bbp_get_topic_admin_links( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'     => bbp_get_topic_id(),
+            'before' => '<span class="bbp-admin-links">',
+            'after'  => '</span>',
+            'sep'    => ' | ',
+            'links'  => array()
+        ),
+        'get_topic_admin_links'
+    );
+    if ( empty( $r['links'] ) ) {
+        $r['links'] = apply_filters(
+            'bbp_topic_admin_links',
             array(
+                'id'     => bbp_get_topic_id(),
+                'before' => '<span class="bbp-admin-links">',
+                'after'  => '</span>',
+                'sep'    => ' | ',
+                'links'  => array()
+                'edit'    => bbp_get_topic_edit_link   ( $r ),
+                'merge'   => bbp_get_topic_merge_link  ( $r ),
+                'close'   => bbp_get_topic_close_link  ( $r ),
+                'stick'   => bbp_get_topic_stick_link  ( $r ),
+                'trash'   => bbp_get_topic_trash_link  ( $r ),
+                'spam'    => bbp_get_topic_spam_link   ( $r ),
+                'approve' => bbp_get_topic_approve_link( $r ),
+                'reply'   => bbp_get_topic_reply_link  ( $r )
             ),
             'get_topic_admin_links'
+            $r['id']
         );
+        if ( empty( $r['links'] ) ) {
             $r['links'] = apply_filters(
                 'bbp_topic_admin_links',
                 array(
+                    'edit'    => bbp_get_topic_edit_link   ( $r ),
                     'merge'   => bbp_get_topic_merge_link  ( $r ),
                     'close'   => bbp_get_topic_close_link  ( $r ),
+                    'stick'   => bbp_get_topic_stick_link  ( $r ),
                     'trash'   => bbp_get_topic_trash_link  ( $r ),
                     'spam'    => bbp_get_topic_spam_link   ( $r ),
                     'approve' => bbp_get_topic_approve_link( $r ),
+                    'reply'   => bbp_get_topic_reply_link  ( $r )
                 ),
                 $r['id']
             );
+    }
+    // See if links need to be unset
+    $topic_status = bbp_get_topic_status( $r['id'] );
+    if ( in_array( $topic_status, bbp_get_non_public_topic_statuses(), true ) ) {
+        // Close link shouldn't be visible on trashed/spammed/pending topics
+        unset( $r['links']['close'] );
+        // Spam link shouldn't be visible on trashed topics
+        if ( bbp_get_trash_status_id() === $topic_status ) {
+            unset( $r['links']['spam'] );
+        // Trash link shouldn't be visible on spam topics
+        } elseif ( bbp_get_spam_status_id() === $topic_status ) {
+            unset( $r['links']['trash'] );
+        }
+        // See if links need to be unset
+        $topic_status = bbp_get_topic_status( $r['id'] );
+        if ( in_array( $topic_status, bbp_get_non_public_topic_statuses(), true ) ) {
+            // Close link shouldn't be visible on trashed/spammed/pending topics
+            unset( $r['links']['close'] );
+            // Spam link shouldn't be visible on trashed topics
+            if ( bbp_get_trash_status_id() === $topic_status ) {
+                unset( $r['links']['spam'] );
+            // Trash link shouldn't be visible on spam topics
+            } elseif ( bbp_get_spam_status_id() === $topic_status ) {
+                unset( $r['links']['trash'] );
+            }
+        }
+        // Process the admin links
+        $links  = implode( $r['sep'], array_filter( $r['links'] ) );
+        $retval = $r['before'] . $links . $r['after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_admin_links', $retval, $r, $args );
+    }
+/**
+ * Output the edit link of the topic
+    }
+    // Process the admin links
+    $links  = implode( $r['sep'], array_filter( $r['links'] ) );
+    $retval = $r['before'] . $links . $r['after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_admin_links', $retval, $r, $args );
+}
+/**
+ * Output the edit link of the topic.
+ *
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param array $args See {@link bbp_get_topic_edit_link()}
+ * @param array $args See {@link bbp_get_topic_edit_link()}.
  */
 function bbp_topic_edit_link( $args = array() ) {
 …
+}
+    /**
+     * Return the edit link of the topic
+     *
+     * @since 2.0.0 bbPress (r2727)
+     *
+     * @param array $args This function supports these args:
+     *  - id: Optional. Topic id
+     *  - link_before: Before the link
+     *  - link_after: After the link
+     *  - edit_text: Edit text
+     * @return string Topic edit link
+     */
+    function bbp_get_topic_edit_link( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'id'           => 0,
+                'link_before'  => '',
+                'link_after'   => '',
+                'edit_text'    => esc_html__( 'Edit', 'bbpress' )
+            ),
+            'get_topic_edit_link'
+        );
+        // Get the topic
+        $topic = bbp_get_topic( $r['id'] );
+        // Bypass check if user has caps
+        if ( ! current_user_can( 'edit_others_topics' ) ) {
+            // User cannot edit or it is past the lock time
+            if ( empty( $topic ) || ! current_user_can( 'edit_topic', $topic->ID ) || bbp_past_edit_lock( $topic->post_date_gmt ) ) {
+                return;
+            }
+        }
+        // Get uri
+        $uri = bbp_get_topic_edit_url( $topic->ID );
+        // Bail if no uri
+        if ( empty( $uri ) ) {
+/**
+ * Return the edit link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2727)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - edit_text: Edit text
+ * @return string Topic edit link.
+ */
+function bbp_get_topic_edit_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'           => 0,
+            'link_before'  => '',
+            'link_after'   => '',
+            'edit_text'    => esc_html__( 'Edit', 'bbpress' )
+        ),
+        'get_topic_edit_link'
+    );
+    // Get the topic
+    $topic = bbp_get_topic( $r['id'] );
+    // Bypass check if user has caps
+    if ( ! current_user_can( 'edit_others_topics' ) ) {
+        // User cannot edit or it is past the lock time
+        if ( empty( $topic ) || ! current_user_can( 'edit_topic', $topic->ID ) || bbp_past_edit_lock( $topic->post_date_gmt ) ) {
             return;
+        }
+        $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-edit-link">' . $r['edit_text'] . '</a>' . $r['link_after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_edit_link', $retval, $r, $args );
+    }
+/**
+ * Output URL to the topic edit page
+    }
+    // Get uri
+    $uri = bbp_get_topic_edit_url( $topic->ID );
+    // Bail if no uri
+    if ( empty( $uri ) ) {
+        return;
+    }
+    $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-edit-link">' . $r['edit_text'] . '</a>' . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_edit_link', $retval, $r, $args );
+}
+/**
+ * Output URL to the topic edit page.
+ *
  * @since 2.0.0 bbPress (r2753)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_edit_url( $topic_id = 0 ) {
     echo esc_url( bbp_get_topic_edit_url( $topic_id ) );
+}
+    /**
+     * Return URL to the topic edit page
+     *
+     * @since 2.0.0 bbPress (r2753)
+     *
+     * @param int $topic_id Optional. Topic id
+     * @return string Topic edit url
+     */
+    function bbp_get_topic_edit_url( $topic_id = 0 ) {
+        $topic = bbp_get_topic( $topic_id );
+        if ( empty( $topic ) ) {
+            return;
+        }
+        // Remove view=all link from edit
+        $topic_link = bbp_remove_view_all( bbp_get_topic_permalink( $topic_id ) );
+        // Pretty permalinks, previously used `bbp_use_pretty_urls()`
+        // https://bbpress.trac.wordpress.org/ticket/3054
+        if ( false === strpos( $topic_link, '?' ) ) {
+            $url = trailingslashit( $topic_link ) . bbp_get_edit_slug();
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_topic_post_type() => $topic->post_name,
+                    bbp_get_edit_rewrite_id() => '1'
+                ),
+                $topic_link
+            );
+        }
+        // Maybe add view=all
+        $url = bbp_add_view_all( $url );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_edit_url', $url, $topic_id );
+    }
+/**
+ * Output the trash link of the topic
+/**
+ * Return URL to the topic edit page.
+ *
+ * @since 2.0.0 bbPress (r2753)
+ *
+ * @param int $topic_id Optional. Topic id.
+ * @return string Topic edit url.
+ */
+function bbp_get_topic_edit_url( $topic_id = 0 ) {
+    $topic = bbp_get_topic( $topic_id );
+    if ( empty( $topic ) ) {
+        return;
+    }
+    // Remove view=all link from edit
+    $topic_link = bbp_remove_view_all( bbp_get_topic_permalink( $topic_id ) );
+    // Pretty permalinks, previously used `bbp_use_pretty_urls()`
+    // https://bbpress.trac.wordpress.org/ticket/3054
+    if ( false === strpos( $topic_link, '?' ) ) {
+        $url = trailingslashit( $topic_link ) . bbp_get_edit_slug();
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_topic_post_type() => $topic->post_name,
+                bbp_get_edit_rewrite_id() => '1'
+            ),
+            $topic_link
+        );
+    }
+    // Maybe add view=all
+    $url = bbp_add_view_all( $url );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_edit_url', $url, $topic_id );
+}
+/**
+ * Output the trash link of the topic.
+ *
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param array $args See {@link bbp_get_topic_trash_link()}
+ * @param array $args See {@link bbp_get_topic_trash_link()}.
  */
 function bbp_topic_trash_link( $args = array() ) {
 …
+}
+    /**
+     * Return the trash link of the topic
+     *
+     * @since 2.0.0 bbPress (r2727)
+     *
+     * @param array $args This function supports these args:
+     *  - id: Optional. Topic id
+     *  - link_before: Before the link
+     *  - link_after: After the link
+     *  - sep: Links separator
+     *  - trash_text: Trash text
+     *  - restore_text: Restore text
+     *  - delete_text: Delete text
+     * @return string Topic trash link
+     */
+    function bbp_get_topic_trash_link( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+/**
+ * Return the trash link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2727)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - sep: Links separator
+ *  - trash_text: Trash text
+ *  - restore_text: Restore text
+ *  - delete_text: Delete text
+ * @return string Topic trash link.
+ */
+function bbp_get_topic_trash_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'           => 0,
+            'link_before'  => '',
+            'link_after'   => '',
+            'sep'          => ' | ',
+            'trash_text'   => esc_html__( 'Trash',   'bbpress' ),
+            'restore_text' => esc_html__( 'Restore', 'bbpress' ),
+            'delete_text'  => esc_html__( 'Delete',  'bbpress' )
+        ),
+        'get_topic_trash_link'
+    );
+    // Get topic
+    $topic = bbp_get_topic( $r['id'] );
+    // Bail if no topic or current user cannot delete
+    if ( empty( $topic ) || ! current_user_can( 'delete_topic', $topic->ID ) ) {
+        return;
+    }
+    $actions    = array();
+    $trash_days = bbp_get_trash_days( bbp_get_topic_post_type() );
+    if ( bbp_is_topic_trash( $topic->ID ) ) {
+        $action_url = add_query_arg(
             array(
+                'id'           => 0,
+                'link_before'  => '',
+                'link_after'   => '',
+                'sep'          => ' | ',
+                'trash_text'   => esc_html__( 'Trash',   'bbpress' ),
+                'restore_text' => esc_html__( 'Restore', 'bbpress' ),
+                'delete_text'  => esc_html__( 'Delete',  'bbpress' )
+            ),
+            'get_topic_trash_link'
+                'action'     => 'bbp_toggle_topic_trash',
+                'sub_action' => 'untrash',
+                'topic_id'   => $topic->ID
+            )
         );
+        // Get topic
+        $topic = bbp_get_topic( $r['id'] );
+        // Bail if no topic or current user cannot delete
+        if ( empty( $topic ) || ! current_user_can( 'delete_topic', $topic->ID ) ) {
+            return;
+        }
+        $actions    = array();
+        $trash_days = bbp_get_trash_days( bbp_get_topic_post_type() );
+        if ( bbp_is_topic_trash( $topic->ID ) ) {
+            $action_url = add_query_arg(
+                array(
+                    'action'     => 'bbp_toggle_topic_trash',
+                    'sub_action' => 'untrash',
+                    'topic_id'   => $topic->ID
+                )
+            );
+            $action    = 'untrash-' . $topic->post_type . '_' . $topic->ID;
+            $nonce_url = wp_nonce_url( $action_url, $action );
+            $actions['untrash'] = '<a title="' . esc_attr__( 'Restore this item from the Trash', 'bbpress' ) . '" href="' . esc_url( $nonce_url ) . '" class="bbp-topic-restore-link">' . $r['restore_text'] . '</a>';
+        } elseif ( ! empty( $trash_days ) ) {
+            $action_url = add_query_arg(
+                array(
+                    'action'     => 'bbp_toggle_topic_trash',
+                    'sub_action' => 'trash',
+                    'topic_id'   => $topic->ID
+                )
+            );
+            $action    = 'trash-' . $topic->post_type . '_' . $topic->ID;
+            $nonce_url = wp_nonce_url( $action_url, $action );
+            $actions['trash']   = '<a title="' . esc_attr__( 'Move this item to the Trash',      'bbpress' ) . '" href="' . esc_url( $nonce_url ) . '" class="bbp-topic-trash-link">'   . $r['trash_text']   . '</a>';
+        }
+        if ( bbp_is_topic_trash( $topic->ID ) || empty( $trash_days ) ) {
+            $action_url = add_query_arg(
+                array(
+                    'action'     => 'bbp_toggle_topic_trash',
+                    'sub_action' => 'delete',
+                    'topic_id'   => $topic->ID
+                )
+            );
+            $action    = 'delete-' . $topic->post_type . '_' . $topic->ID;
+            $nonce_url = wp_nonce_url( $action_url, $action );
+            $actions['delete']  = '<a title="' . esc_attr__( 'Delete this item permanently',     'bbpress' ) . '" href="' . esc_url( $nonce_url ) . '" onclick="return confirm(\'' . esc_js( esc_html__( 'Are you sure you want to delete that permanently?', 'bbpress' ) ) . '\' );" class="bbp-topic-delete-link">' . $r['delete_text'] . '</a>';
+        }
+        // Process the admin links
+        $retval = $r['link_before'] . implode( $r['sep'], $actions ) . $r['link_after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_trash_link', $retval, $r, $args );
+    }
+/**
+ * Output the close link of the topic
+        $action    = 'untrash-' . $topic->post_type . '_' . $topic->ID;
+        $nonce_url = wp_nonce_url( $action_url, $action );
+        $actions['untrash'] = '<a title="' . esc_attr__( 'Restore this item from the Trash', 'bbpress' ) . '" href="' . esc_url( $nonce_url ) . '" class="bbp-topic-restore-link">' . $r['restore_text'] . '</a>';
+    } elseif ( ! empty( $trash_days ) ) {
+        $action_url = add_query_arg(
+            array(
+                'action'     => 'bbp_toggle_topic_trash',
+                'sub_action' => 'trash',
+                'topic_id'   => $topic->ID
+            )
+        );
+        $action    = 'trash-' . $topic->post_type . '_' . $topic->ID;
+        $nonce_url = wp_nonce_url( $action_url, $action );
+        $actions['trash']   = '<a title="' . esc_attr__( 'Move this item to the Trash',      'bbpress' ) . '" href="' . esc_url( $nonce_url ) . '" class="bbp-topic-trash-link">'   . $r['trash_text']   . '</a>';
+    }
+    if ( bbp_is_topic_trash( $topic->ID ) || empty( $trash_days ) ) {
+        $action_url = add_query_arg(
+            array(
+                'action'     => 'bbp_toggle_topic_trash',
+                'sub_action' => 'delete',
+                'topic_id'   => $topic->ID
+            )
+        );
+        $action    = 'delete-' . $topic->post_type . '_' . $topic->ID;
+        $nonce_url = wp_nonce_url( $action_url, $action );
+        $actions['delete']  = '<a title="' . esc_attr__( 'Delete this item permanently',     'bbpress' ) . '" href="' . esc_url( $nonce_url ) . '" onclick="return confirm(\'' . esc_js( esc_html__( 'Are you sure you want to delete that permanently?', 'bbpress' ) ) . '\' );" class="bbp-topic-delete-link">' . $r['delete_text'] . '</a>';
+    }
+    // Process the admin links
+    $retval = $r['link_before'] . implode( $r['sep'], $actions ) . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_trash_link', $retval, $r, $args );
+}
+/**
+ * Output the close link of the topic.
+ *
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param array $args See {@link bbp_get_topic_close_link()}
+ * @param array $args See {@link bbp_get_topic_close_link()}.
  */
 function bbp_topic_close_link( $args = array() ) {
 …
+}
+    /**
+     * Return the close link of the topic
+     *
+     * @since 2.0.0 bbPress (r2727)
+     *
+     * @param array $args This function supports these args:
+     *  - id: Optional. Topic id
+     *  - link_before: Before the link
+     *  - link_after: After the link
+     *  - close_text: Close text
+     *  - open_text: Open text
+     * @return string Topic close link
+     */
+    function bbp_get_topic_close_link( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+/**
+ * Return the close link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2727)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - close_text: Close text
+ *  - open_text: Open text
+ * @return string Topic close link.
+ */
+function bbp_get_topic_close_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'          => 0,
+            'link_before' => '',
+            'link_after'  => '',
+            'sep'         => ' | ',
+            'close_text'  => esc_html_x( 'Close', 'Close the topic', 'bbpress' ),
+            'open_text'   => esc_html_x( 'Open',  'Open the topic', 'bbpress' )
+        ),
+        'get_topic_close_link'
+    );
+    // Get topic
+    $topic = bbp_get_topic( $r['id'] );
+    // Bail if no topic or current user cannot moderate
+    if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+        return;
+    }
+    $display = bbp_is_topic_open( $topic->ID ) ? $r['close_text'] : $r['open_text'];
+    $uri     = add_query_arg(
+        array(
+            'action'   => 'bbp_toggle_topic_close',
+            'topic_id' => $topic->ID
+        )
+    );
+    $uri     = wp_nonce_url( $uri, 'close-topic_' . $topic->ID );
+    $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-close-link">' . $display . '</a>' . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_close_link', $retval, $r, $args );
+}
+/**
+ * Output the approve link of the topic.
+ *
+ * @since 2.6.0 bbPress (r5504)
+ *
+ * @param array $args See {@link bbp_get_topic_approve_link()}.
+ */
+function bbp_topic_approve_link( $args = array() ) {
+    echo bbp_get_topic_approve_link( $args );
+}
+/**
+ * Return the approve link of the topic.
+ *
+ * @since 2.6.0 bbPress (r5504)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - sep: Separator between links
+ *  - approve_text: Approve text
+ *  - unapprove_text: Unapprove text
+ * @return string Topic approve link.
+ */
+function bbp_get_topic_approve_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'             => 0,
+            'link_before'    => '',
+            'link_after'     => '',
+            'sep'            => ' | ',
+            'approve_text'   => esc_html_x( 'Approve',   'Approve the topic', 'bbpress' ),
+            'unapprove_text' => esc_html_x( 'Unapprove', 'Unapprove the topic', 'bbpress' )
+        ),
+        'get_topic_approve_link'
+    );
+    // Get topic
+    $topic = bbp_get_topic( $r['id'] );
+    // Bail if no topic or current user cannot moderate
+    if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+        return;
+    }
+    $display = bbp_is_topic_pending( $topic->ID ) ? $r['approve_text'] : $r['unapprove_text'];
+    $uri     = add_query_arg(
+        array(
+            'action'   => 'bbp_toggle_topic_approve',
+            'topic_id' => $topic->ID
+        )
+    );
+    $uri     = wp_nonce_url( $uri, 'approve-topic_' . $topic->ID );
+    $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-approve-link">' . $display . '</a>' . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_approve_link', $retval, $r, $args );
+}
+/**
+ * Output the stick link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2754)
+ *
+ * @param array $args See {@link bbp_get_topic_stick_link()}.
+ */
+function bbp_topic_stick_link( $args = array() ) {
+    echo bbp_get_topic_stick_link( $args );
+}
+/**
+ * Return the stick link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2754)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - stick_text: Stick text
+ *  - unstick_text: Unstick text
+ *  - super_text: Stick to front text
+ *
+ * @return string Topic stick link.
+ */
+function bbp_get_topic_stick_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'           => 0,
+            'link_before'  => '',
+            'link_after'   => '',
+            'stick_text'   => esc_html__( 'Stick',      'bbpress' ),
+            'unstick_text' => esc_html__( 'Unstick',    'bbpress' ),
+            'super_text'   => esc_html__( '(to front)', 'bbpress' ),
+        ),
+        'get_topic_stick_link'
+    );
+    // Get topic
+    $topic = bbp_get_topic( $r['id'] );
+    // Bail if no topic or current user cannot moderate
+    if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+        return;
+    }
+    $is_sticky = bbp_is_topic_sticky( $topic->ID );
+    $stick_uri = add_query_arg(
+        array(
+            'action'   => 'bbp_toggle_topic_stick',
+            'topic_id' => $topic->ID
+        )
+    );
+    $stick_uri = wp_nonce_url( $stick_uri, 'stick-topic_' . $topic->ID );
+    $stick_display = ( true === $is_sticky )
+        ? $r['unstick_text']
+        : $r['stick_text'];
+    $stick_display = '<a href="' . esc_url( $stick_uri ) . '" class="bbp-topic-sticky-link">' . $stick_display . '</a>';
+    if ( empty( $is_sticky ) ) {
+        $super_uri = add_query_arg(
             array(
+                'id'          => 0,
+                'link_before' => '',
+                'link_after'  => '',
+                'sep'         => ' | ',
+                'close_text'  => esc_html_x( 'Close', 'Close the topic', 'bbpress' ),
+                'open_text'   => esc_html_x( 'Open',  'Open the topic', 'bbpress' )
+            ),
+            'get_topic_close_link'
+        );
+        // Get topic
+        $topic = bbp_get_topic( $r['id'] );
+        // Bail if no topic or current user cannot moderate
+        if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+            return;
+        }
+        $display = bbp_is_topic_open( $topic->ID ) ? $r['close_text'] : $r['open_text'];
+        $uri     = add_query_arg(
+            array(
+                'action'   => 'bbp_toggle_topic_close',
+                'topic_id' => $topic->ID
+                'action'   => 'bbp_toggle_topic_stick',
+                'topic_id' => $topic->ID,
+                'super'    => 1
+            )
         );
+        $uri     = wp_nonce_url( $uri, 'close-topic_' . $topic->ID );
+        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-close-link">' . $display . '</a>' . $r['link_after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_close_link', $retval, $r, $args );
+    }
+/**
+ * Output the approve link of the topic
+ *
+ * @since 2.6.0 bbPress (r5504)
+ *
+ * @param array $args See {@link bbp_get_topic_approve_link()}
+ */
+function bbp_topic_approve_link( $args = array() ) {
+    echo bbp_get_topic_approve_link( $args );
+}
+    /**
+     * Return the approve link of the topic
+     *
+     * @since 2.6.0 bbPress (r5504)
+     *
+     * @param array $args This function supports these args:
+     *  - id: Optional. Topic id
+     *  - link_before: Before the link
+     *  - link_after: After the link
+     *  - sep: Separator between links
+     *  - approve_text: Approve text
+     *  - unapprove_text: Unapprove text
+     * @return string Topic approve link
+     */
+    function bbp_get_topic_approve_link( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'id'             => 0,
+                'link_before'    => '',
+                'link_after'     => '',
+                'sep'            => ' | ',
+                'approve_text'   => esc_html_x( 'Approve',   'Approve the topic', 'bbpress' ),
+                'unapprove_text' => esc_html_x( 'Unapprove', 'Unapprove the topic', 'bbpress' )
+            ),
+            'get_topic_approve_link'
+        );
+        // Get topic
+        $topic = bbp_get_topic( $r['id'] );
+        // Bail if no topic or current user cannot moderate
+        if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+            return;
+        }
+        $display = bbp_is_topic_pending( $topic->ID ) ? $r['approve_text'] : $r['unapprove_text'];
+        $uri     = add_query_arg(
+            array(
+                'action'   => 'bbp_toggle_topic_approve',
+                'topic_id' => $topic->ID
+            )
+        );
+        $uri     = wp_nonce_url( $uri, 'approve-topic_' . $topic->ID );
+        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-approve-link">' . $display . '</a>' . $r['link_after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_approve_link', $retval, $r, $args );
+    }
+/**
+ * Output the stick link of the topic
+ *
+ * @since 2.0.0 bbPress (r2754)
+ *
+ * @param array $args See {@link bbp_get_topic_stick_link()}
+ */
+function bbp_topic_stick_link( $args = array() ) {
+    echo bbp_get_topic_stick_link( $args );
+}
+    /**
+     * Return the stick link of the topic
+     *
+     * @since 2.0.0 bbPress (r2754)
+     *
+     * @param array $args This function supports these args:
+     *  - id: Optional. Topic id
+     *  - link_before: Before the link
+     *  - link_after: After the link
+     *  - stick_text: Stick text
+     *  - unstick_text: Unstick text
+     *  - super_text: Stick to front text
+     *
+     * @return string Topic stick link
+     */
+    function bbp_get_topic_stick_link( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'id'           => 0,
+                'link_before'  => '',
+                'link_after'   => '',
+                'stick_text'   => esc_html__( 'Stick',      'bbpress' ),
+                'unstick_text' => esc_html__( 'Unstick',    'bbpress' ),
+                'super_text'   => esc_html__( '(to front)', 'bbpress' ),
+            ),
+            'get_topic_stick_link'
+        );
+        // Get topic
+        $topic = bbp_get_topic( $r['id'] );
+        // Bail if no topic or current user cannot moderate
+        if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+            return;
+        }
+        $is_sticky = bbp_is_topic_sticky( $topic->ID );
+        $stick_uri = add_query_arg(
+            array(
+                'action'   => 'bbp_toggle_topic_stick',
+                'topic_id' => $topic->ID
+            )
+        );
+        $stick_uri = wp_nonce_url( $stick_uri, 'stick-topic_' . $topic->ID );
+        $stick_display = ( true === $is_sticky )
+            ? $r['unstick_text']
+            : $r['stick_text'];
+        $stick_display = '<a href="' . esc_url( $stick_uri ) . '" class="bbp-topic-sticky-link">' . $stick_display . '</a>';
+        if ( empty( $is_sticky ) ) {
+            $super_uri = add_query_arg(
+                array(
+                    'action'   => 'bbp_toggle_topic_stick',
+                    'topic_id' => $topic->ID,
+                    'super'    => 1
+                )
+            );
+            $super_uri = wp_nonce_url( $super_uri, 'stick-topic_' . $topic->ID );
+            $super_display = ' <a href="' . esc_url( $super_uri ) . '" class="bbp-topic-super-sticky-link">' . $r['super_text'] . '</a>';
+        } else {
+            $super_display = '';
+        }
+        // Combine the HTML into 1 string
+        $retval = $r['link_before'] . $stick_display . $super_display . $r['link_after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_stick_link', $retval, $r, $args );
+    }
+/**
+ * Output the merge link of the topic
+        $super_uri = wp_nonce_url( $super_uri, 'stick-topic_' . $topic->ID );
+        $super_display = ' <a href="' . esc_url( $super_uri ) . '" class="bbp-topic-super-sticky-link">' . $r['super_text'] . '</a>';
+    } else {
+        $super_display = '';
+    }
+    // Combine the HTML into 1 string
+    $retval = $r['link_before'] . $stick_display . $super_display . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_stick_link', $retval, $r, $args );
+}
+/**
+ * Output the merge link of the topic.
+ *
  * @since 2.0.0 bbPress (r2756)
 …
+}
     /**
+     * Return the merge link of the topic
+     *
      * @since 2.0.0 bbPress (r2756)
+     *
      * @param array $args This function supports these args:
      *  - id: Optional. Topic id
      *  - link_before: Before the link
      *  - link_after: After the link
      *  - merge_text: Merge text
+     *
+     * @return string Topic merge link
      */
     function bbp_get_topic_merge_link( $args = array() ) {
         // Parse arguments against default values
         $r = bbp_parse_args(
             $args,
             array(
                 'id'           => 0,
                 'link_before'  => '',
                 'link_after'   => '',
                 'merge_text'   => esc_html__( 'Merge', 'bbpress' ),
             ),
             'get_topic_merge_link'
         );
         // Get topic
         $topic = bbp_get_topic( $r['id'] );
         // Bail if no topic or current user cannot moderate
         if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
             return;
+        }
         $query  = array( 'action' => 'merge' );
         $uri    = add_query_arg( $query, bbp_get_topic_edit_url( $topic->ID ) );
         $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-merge-link">' . $r['merge_text'] . '</a>' . $r['link_after'];
         // Filter & return
         return apply_filters( 'bbp_get_topic_merge_link', $retval, $r, $args );
+    }
 /**
  * Output the spam link of the topic
+/**
+ * Return the merge link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2756)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - merge_text: Merge text
+ *
+ * @return string Topic merge link.
+ */
+function bbp_get_topic_merge_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'           => 0,
+            'link_before'  => '',
+            'link_after'   => '',
+            'merge_text'   => esc_html__( 'Merge', 'bbpress' ),
+        ),
+        'get_topic_merge_link'
+    );
+    // Get topic
+    $topic = bbp_get_topic( $r['id'] );
+    // Bail if no topic or current user cannot moderate
+    if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+        return;
+    }
+    $query  = array( 'action' => 'merge' );
+    $uri    = add_query_arg( $query, bbp_get_topic_edit_url( $topic->ID ) );
+    $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-merge-link">' . $r['merge_text'] . '</a>' . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_merge_link', $retval, $r, $args );
+}
+/**
+ * Output the spam link of the topic.
+ *
  * @since 2.0.0 bbPress (r2727)
+ *
  * @param array $args See {@link bbp_get_topic_spam_link()}
+ * @param array $args See {@link bbp_get_topic_spam_link()}.
  */
 function bbp_topic_spam_link( $args = array() ) {
 …
+}
     /**
+     * Return the spam link of the topic
+     *
      * @since 2.0.0 bbPress (r2727)
+     *
      * @param array $args This function supports these args:
      *  - id: Optional. Topic id
      *  - link_before: Before the link
      *  - link_after: After the link
      *  - spam_text: Spam text
      *  - unspam_text: Unspam text
+     *
+     * @return string Topic spam link
      */
     function bbp_get_topic_spam_link( $args = array() ) {
         // Parse arguments against default values
         $r = bbp_parse_args(
             $args,
             array(
                 'id'           => 0,
                 'link_before'  => '',
                 'link_after'   => '',
                 'sep'          => ' | ',
                 'spam_text'    => esc_html__( 'Spam',   'bbpress' ),
                 'unspam_text'  => esc_html__( 'Unspam', 'bbpress' )
             ),
             'get_topic_spam_link'
         );
         $topic = bbp_get_topic( $r['id'] );
         if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
             return;
+        }
         $display = bbp_is_topic_spam( $topic->ID )
             ? $r['unspam_text']
             : $r['spam_text'];
         $uri = add_query_arg(
             array(
                 'action'   => 'bbp_toggle_topic_spam',
                 'topic_id' => $topic->ID
+            )
         );
         $uri    = wp_nonce_url( $uri, 'spam-topic_' . $topic->ID );
         $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-spam-link">' . $display . '</a>' . $r['link_after'];
         // Filter & return
         return apply_filters( 'bbp_get_topic_spam_link', $retval, $r, $args );
+    }
 /**
  * Output the link to go directly to the reply form
+/**
+ * Return the spam link of the topic.
+ *
+ * @since 2.0.0 bbPress (r2727)
+ *
+ * @param array $args This function supports these args:
+ *  - id: Optional. Topic id
+ *  - link_before: Before the link
+ *  - link_after: After the link
+ *  - spam_text: Spam text
+ *  - unspam_text: Unspam text
+ *
+ * @return string Topic spam link.
+ */
+function bbp_get_topic_spam_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'           => 0,
+            'link_before'  => '',
+            'link_after'   => '',
+            'sep'          => ' | ',
+            'spam_text'    => esc_html__( 'Spam',   'bbpress' ),
+            'unspam_text'  => esc_html__( 'Unspam', 'bbpress' )
+        ),
+        'get_topic_spam_link'
+    );
+    $topic = bbp_get_topic( $r['id'] );
+    if ( empty( $topic ) || ! current_user_can( 'moderate', $topic->ID ) ) {
+        return;
+    }
+    $display = bbp_is_topic_spam( $topic->ID )
+        ? $r['unspam_text']
+        : $r['spam_text'];
+    $uri = add_query_arg(
+        array(
+            'action'   => 'bbp_toggle_topic_spam',
+            'topic_id' => $topic->ID
+        )
+    );
+    $uri    = wp_nonce_url( $uri, 'spam-topic_' . $topic->ID );
+    $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-spam-link">' . $display . '</a>' . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_spam_link', $retval, $r, $args );
+}
+/**
+ * Output the link to go directly to the reply form.
+ *
  * @since 2.4.0 bbPress (r4966)
 …
+}
     /**
+     * Return the link to go directly to the reply form
+     *
      * @since 2.4.0 bbPress (r4966)
+     *
+     * @param array $args Arguments
+     *
+     * @return string Link for a reply to a topic
      */
     function bbp_get_topic_reply_link( $args = array() ) {
         // Parse arguments against default values
         $r = bbp_parse_args(
             $args,
             array(
                 'id'          => 0,
                 'link_before' => '',
                 'link_after'  => '',
                 'reply_text'  => esc_html_x( 'Reply', 'verb', 'bbpress' ),
                 'add_below'   => 'post',
                 'respond_id'  => 'new-reply-' . bbp_get_topic_id(),
             ),
             'get_topic_reply_link'
         );
         // Get the topic to use it's ID and post_parent
         $topic = bbp_get_topic( $r['id'] );
         // Bail if no topic or user cannot reply
         if ( empty( $topic ) || bbp_is_single_reply() || ! bbp_current_user_can_access_create_reply_form() ) {
             return;
+        }
         // Only add onclick if replies are threaded
         $onclick = bbp_thread_replies()
             ? ' onclick="return addReply.cancelForm();"'
             : '';
         // Add $uri to the array, to be passed through the filter
         $r['uri'] = remove_query_arg( array( 'bbp_reply_to', '_wpnonce' ) ) . '#new-post';
         $retval   = $r['link_before'] . '<a role="button" href="' . esc_url( $r['uri'] ) . '" class="bbp-topic-reply-link"' . $onclick . '>' . $r['reply_text'] . '</a>' . $r['link_after'];
         // Filter & return
         return apply_filters( 'bbp_get_topic_reply_link', $retval, $r, $args );
+    }
+/**
+ * Return the link to go directly to the reply form.
+ *
+ * @since 2.4.0 bbPress (r4966)
+ *
+ * @param array $args Arguments.
+ *
+ * @return string Link for a reply to a topic.
+ */
+function bbp_get_topic_reply_link( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'id'          => 0,
+            'link_before' => '',
+            'link_after'  => '',
+            'reply_text'  => esc_html_x( 'Reply', 'verb', 'bbpress' ),
+            'add_below'   => 'post',
+            'respond_id'  => 'new-reply-' . bbp_get_topic_id(),
+        ),
+        'get_topic_reply_link'
+    );
+    // Get the topic to use it's ID and post_parent
+    $topic = bbp_get_topic( $r['id'] );
+    // Bail if no topic or user cannot reply
+    if ( empty( $topic ) || bbp_is_single_reply() || ! bbp_current_user_can_access_create_reply_form() ) {
+        return;
+    }
+    // Only add onclick if replies are threaded
+    $onclick = bbp_thread_replies()
+        ? ' onclick="return addReply.cancelForm();"'
+        : '';
+    // Add $uri to the array, to be passed through the filter
+    $r['uri'] = remove_query_arg( array( 'bbp_reply_to', '_wpnonce' ) ) . '#new-post';
+    $retval   = $r['link_before'] . '<a role="button" href="' . esc_url( $r['uri'] ) . '" class="bbp-topic-reply-link"' . $onclick . '>' . $r['reply_text'] . '</a>' . $r['link_after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_reply_link', $retval, $r, $args );
+}
 /** Topic Pagination **********************************************************/
 /**
  * Return the base URL used inside of pagination links
+ * Return the base URL used inside of pagination links.
+ *
  * @since 2.6.0 bbPress (r6402)
+ *
  * @param int $forum_id
+ * @param int $forum_id Forum id.
  * @return string
  */
 …
 /**
  * Output the pagination count
+ * Output the pagination count.
+ *
  * The results are unescaped by design, to allow them to be filtered freely via
 …
     echo bbp_get_forum_pagination_count();
+}
+    /**
+     * Return the pagination count
+     *
+     * @since 2.0.0 bbPress (r2519)
+     *
+     * @return string Forum Pagination count
+     */
+    function bbp_get_forum_pagination_count() {
+        $bbp = bbpress();
+        // Define local variable(s)
+        $retstr = '';
+        // Topic query exists
+        if ( ! empty( $bbp->topic_query ) ) {
+            // Set pagination values
+            $count_int = intval( $bbp->topic_query->post_count );
+            $start_num = intval( ( $bbp->topic_query->paged - 1 ) * $bbp->topic_query->posts_per_page ) + 1;
+            $total_int = ! empty( $bbp->topic_query->found_posts )
+                ? (int) $bbp->topic_query->found_posts
+                : $count_int;
+            // Format numbers for display
+            $count_num = bbp_number_format( $count_int );
+            $from_num  = bbp_number_format( $start_num );
+            $total     = bbp_number_format( $total_int );
+            $to_num    = bbp_number_format( ( $start_num + ( $bbp->topic_query->posts_per_page - 1 ) > $bbp->topic_query->found_posts )
+                ? $bbp->topic_query->found_posts
+                : $start_num + ( $bbp->topic_query->posts_per_page - 1 )
+            );
+            // Several topics in a forum with a single page
+            if ( empty( $to_num ) ) {
+                /* translators: %1$s: Total number of topics */
+                $retstr = sprintf( _n( 'Viewing %1$s topic', 'Viewing %1$s topics', $total_int, 'bbpress' ), $total );
+            // Several topics in a forum with several pages
+            } else {
+                $retstr = sprintf( _n( 'Viewing topic %2$s (of %4$s total)', 'Viewing %1$s topics - %2$s through %3$s (of %4$s total)', $total_int, 'bbpress' ), $count_num, $from_num, $to_num, $total );  //phpcs:ignore
+            }
+            // Escape results of _n()
+            $retstr = esc_html( $retstr );
+/**
+ * Return the pagination count.
+ *
+ * @since 2.0.0 bbPress (r2519)
+ *
+ * @return string Forum Pagination count.
+ */
+function bbp_get_forum_pagination_count() {
+    $bbp = bbpress();
+    // Define local variable(s)
+    $retstr = '';
+    // Topic query exists
+    if ( ! empty( $bbp->topic_query ) ) {
+        // Set pagination values
+        $count_int = intval( $bbp->topic_query->post_count );
+        $start_num = intval( ( $bbp->topic_query->paged - 1 ) * $bbp->topic_query->posts_per_page ) + 1;
+        $total_int = ! empty( $bbp->topic_query->found_posts )
+            ? (int) $bbp->topic_query->found_posts
+            : $count_int;
+        // Format numbers for display
+        $count_num = bbp_number_format( $count_int );
+        $from_num  = bbp_number_format( $start_num );
+        $total     = bbp_number_format( $total_int );
+        $to_num    = bbp_number_format( ( $start_num + ( $bbp->topic_query->posts_per_page - 1 ) > $bbp->topic_query->found_posts )
+            ? $bbp->topic_query->found_posts
+            : $start_num + ( $bbp->topic_query->posts_per_page - 1 )
+        );
+        // Several topics in a forum with a single page
+        if ( empty( $to_num ) ) {
+            /* translators: %1$s: Total number of topics */
+            $retstr = sprintf( _n( 'Viewing %1$s topic', 'Viewing %1$s topics', $total_int, 'bbpress' ), $total );
+        // Several topics in a forum with several pages
+        } else {
+            $retstr = sprintf( _n( 'Viewing topic %2$s (of %4$s total)', 'Viewing %1$s topics - %2$s through %3$s (of %4$s total)', $total_int, 'bbpress' ), $count_num, $from_num, $to_num, $total );  //phpcs:ignore
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_forum_pagination_count', $retstr );
+    }
+/**
+ * Output pagination links
+        // Escape results of _n()
+        $retstr = esc_html( $retstr );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_forum_pagination_count', $retstr );
+}
+/**
+ * Output pagination links.
+ *
  * @since 2.0.0 bbPress (r2519)
 …
     echo bbp_get_forum_pagination_links();
+}
+    /**
+     * Return pagination links
+     *
+     * @since 2.0.0 bbPress (r2519)
+     *
+     * @return string Pagination links
+     */
+    function bbp_get_forum_pagination_links() {
+        $bbp = bbpress();
+        if ( empty( $bbp->topic_query ) ) {
+            return false;
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_forum_pagination_links', $bbp->topic_query->pagination_links );
+    }
+/**
+ * Displays topic notices
+/**
+ * Return pagination links.
+ *
+ * @since 2.0.0 bbPress (r2519)
+ *
+ * @return string Pagination links.
+ */
+function bbp_get_forum_pagination_links() {
+    $bbp = bbpress();
+    if ( empty( $bbp->topic_query ) ) {
+        return false;
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_forum_pagination_links', $bbp->topic_query->pagination_links );
+}
+/**
+ * Displays topic notices.
+ *
  * @since 2.0.0 bbPress (r2744)
 …
 /**
  * Displays topic type select box (normal/sticky/super sticky)
+ * Displays topic type select box (normal/sticky/super sticky).
+ *
  * @since 2.0.0 bbPress (r2784)
 …
 /**
  * Displays topic type select box (normal/sticky/super sticky)
+ * Displays topic type select box (normal/sticky/super sticky).
+ *
  * @since 2.4.0 bbPress (r5059)
 …
     echo bbp_get_form_topic_type_dropdown( $args );
+}
+    /**
+     * Returns topic type select box (normal/sticky/super sticky)
+     *
+     * @since 2.4.0 bbPress (r5059)
+     *
+     * @param $args This function supports these arguments:
+     *  - select_id: Select id. Defaults to bbp_stick_topic
+     *  - tab: Deprecated. Tabindex
+     *  - topic_id: Topic id
+     *  - selected: Override the selected option
+     */
+    function bbp_get_form_topic_type_dropdown( $args = array() ) {
+        // Parse arguments against default values
         $r = bbp_parse_args(
             $args,
             array(
                 'select_id'    => 'bbp_stick_topic',
                 'select_class' => 'bbp_dropdown',
                 'tab'          => false,
                 'topic_id'     => 0,
                 'selected'     => false
             ),
             'topic_type_select'
         );
+        // No specific selected value passed
         if ( empty( $r['selected'] ) ) {
+            // Post value is passed
             if ( bbp_is_topic_form_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
                 $r['selected'] = sanitize_key( $_POST[ $r['select_id'] ] );
+            // Edit topic
             } elseif ( bbp_is_single_topic() || bbp_is_topic_edit() ) {
+                // Get current topic id
                 $r['topic_id'] = bbp_get_topic_id( $r['topic_id'] );
+                // Topic is super sticky
                 if ( bbp_is_topic_super_sticky( $r['topic_id'] ) ) {
                     $r['selected'] = 'super';
+                // Topic is sticky or normal
                 } else {
                     $r['selected'] = bbp_is_topic_sticky( $r['topic_id'], false )
                         ? 'stick'
                         : 'unstick';
+                }
+/**
+ * Returns topic type select box (normal/sticky/super sticky).
+ *
+ * @since 2.4.0 bbPress (r5059)
+ *
+ * @param $args This function supports these arguments:
+ *  - select_id: Select id. Defaults to bbp_stick_topic
+ *  - tab: Deprecated. Tabindex
+ *  - topic_id: Topic id
+ *  - selected: Override the selected option
+ */
+function bbp_get_form_topic_type_dropdown( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'select_id'    => 'bbp_stick_topic',
+            'select_class' => 'bbp_dropdown',
+            'tab'          => false,
+            'topic_id'     => 0,
+            'selected'     => false
+        ),
+        'topic_type_select'
+    );
+    // No specific selected value passed
+    if ( empty( $r['selected'] ) ) {
+        // Post value is passed
+        if ( bbp_is_topic_form_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
+            $r['selected'] = sanitize_key( $_POST[ $r['select_id'] ] );
+        // Edit topic
+        } elseif ( bbp_is_single_topic() || bbp_is_topic_edit() ) {
+            // Get current topic id
+            $r['topic_id'] = bbp_get_topic_id( $r['topic_id'] );
+            // Topic is super sticky
+            if ( bbp_is_topic_super_sticky( $r['topic_id'] ) ) {
+                $r['selected'] = 'super';
+            // Topic is sticky or normal
+            } else {
+                $r['selected'] = bbp_is_topic_sticky( $r['topic_id'], false )
+                    ? 'stick'
+                    : 'unstick';
+            }
+        }
+        // Start an output buffer, we'll finish it after the select loop
+        ob_start(); ?>
+        <select name="<?php echo esc_attr( $r['select_id'] ); ?>" id="<?php echo esc_attr( $r['select_id'] ); ?>_select" class="<?php echo esc_attr( $r['select_class'] ); ?>"<?php bbp_tab_index_attribute( $r['tab'] ); ?>>
+            <?php foreach ( bbp_get_topic_types( $r['topic_id'] ) as $key => $label ) : ?>
+                <option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
+            <?php endforeach; ?>
+        </select>
+        <?php
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_type_dropdown', ob_get_clean(), $r, $args );
+    }
+/**
+ * Output value topic status dropdown
+    }
+    // Start an output buffer, we'll finish it after the select loop
+    ob_start(); ?>
+    <select name="<?php echo esc_attr( $r['select_id'] ); ?>" id="<?php echo esc_attr( $r['select_id'] ); ?>_select" class="<?php echo esc_attr( $r['select_class'] ); ?>"<?php bbp_tab_index_attribute( $r['tab'] ); ?>>
+        <?php foreach ( bbp_get_topic_types( $r['topic_id'] ) as $key => $label ) : ?>
+            <option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
+        <?php endforeach; ?>
+    </select>
+    <?php
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_type_dropdown', ob_get_clean(), $r, $args );
+}
+/**
+ * Output value topic status dropdown.
+ *
  * @since 2.4.0 bbPress (r5059)
 …
     echo bbp_get_form_topic_status_dropdown( $args );
+}
+    /**
+     * 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:
+     *  - select_id: Select id. Defaults to bbp_topic_status
+     *  - tab: Deprecated. Tabindex
+     *  - topic_id: Topic id
+     *  - selected: Override the selected option
+     */
+    function bbp_get_form_topic_status_dropdown( $args = array() ) {
+        // Parse arguments against default values
         $r = bbp_parse_args(
             $args,
             array(
                 'select_id'    => 'bbp_topic_status',
                 'select_class' => 'bbp_dropdown',
                 'tab'          => false,
                 'topic_id'     => 0,
                 'selected'     => false
             ),
             'topic_open_close_select'
         );
+        // No specific selected value passed
         if ( empty( $r['selected'] ) ) {
+            // Post value is passed
             if ( bbp_is_topic_form_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
                 $r['selected'] = sanitize_key( $_POST[ $r['select_id'] ] );
+            // Edit topic
             } elseif ( bbp_is_topic_edit() ) {
                 $r['topic_id'] = bbp_get_topic_id( $r['topic_id'] );
                 $r['selected'] = bbp_get_topic_status( $r['topic_id'] );
+            // New topic
             } else {
                 $r['selected'] = bbp_get_public_status_id();
+            }
+/**
+ * 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:
+ *  - select_id: Select id. Defaults to bbp_topic_status
+ *  - tab: Deprecated. Tabindex
+ *  - topic_id: Topic id
+ *  - selected: Override the selected option
+ */
+function bbp_get_form_topic_status_dropdown( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'select_id'    => 'bbp_topic_status',
+            'select_class' => 'bbp_dropdown',
+            'tab'          => false,
+            'topic_id'     => 0,
+            'selected'     => false
+        ),
+        'topic_open_close_select'
+    );
+    // No specific selected value passed
+    if ( empty( $r['selected'] ) ) {
+        // Post value is passed
+        if ( bbp_is_topic_form_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
+            $r['selected'] = sanitize_key( $_POST[ $r['select_id'] ] );
+        // Edit topic
+        } elseif ( bbp_is_topic_edit() ) {
+            $r['topic_id'] = bbp_get_topic_id( $r['topic_id'] );
+            $r['selected'] = bbp_get_topic_status( $r['topic_id'] );
+        // New topic
+        } else {
+            $r['selected'] = bbp_get_public_status_id();
+        }
+        // Start an output buffer, we'll finish it after the select loop
+        ob_start(); ?>
+        <select name="<?php echo esc_attr( $r['select_id'] ); ?>" id="<?php echo esc_attr( $r['select_id'] ); ?>_select" class="<?php echo esc_attr( $r['select_class'] ); ?>"<?php bbp_tab_index_attribute( $r['tab'] ); ?>>
+            <?php foreach ( bbp_get_topic_statuses( $r['topic_id'] ) as $key => $label ) : ?>
+                <option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
+            <?php endforeach; ?>
+        </select>
+        <?php
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_status_dropdown', ob_get_clean(), $r, $args );
+    }
+    }
+    // Start an output buffer, we'll finish it after the select loop
+    ob_start(); ?>
+    <select name="<?php echo esc_attr( $r['select_id'] ); ?>" id="<?php echo esc_attr( $r['select_id'] ); ?>_select" class="<?php echo esc_attr( $r['select_class'] ); ?>"<?php bbp_tab_index_attribute( $r['tab'] ); ?>>
+        <?php foreach ( bbp_get_topic_statuses( $r['topic_id'] ) as $key => $label ) : ?>
+            <option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
+        <?php endforeach; ?>
+    </select>
+    <?php
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_status_dropdown', ob_get_clean(), $r, $args );
+}
 /** Single Topic **************************************************************/
 …
     echo bbp_get_single_topic_description( $args );
+}
+    /**
+     * Return a fancy description of the current topic, including total topics,
+     * total replies, and last activity.
+     *
+     * @since 2.0.0 bbPress (r2860)
+     *
+     * @param array $args This function supports these arguments:
+     *  - topic_id: Topic id
+     *  - before: Before the text
+     *  - after: After the text
+     *  - size: Size of the avatar
+     * @return string Filtered topic description
+     */
+    function bbp_get_single_topic_description( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+/**
+ * Return a fancy description of the current topic, including total topics,
+ * total replies, and last activity.
+ *
+ * @since 2.0.0 bbPress (r2860)
+ *
+ * @param array $args This function supports these arguments:
+ *  - topic_id: Topic id
+ *  - before: Before the text
+ *  - after: After the text
+ *  - size: Size of the avatar
+ * @return string Filtered topic description.
+ */
+function bbp_get_single_topic_description( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'topic_id'  => 0,
+            'before'    => '<div class="bbp-template-notice info"><ul><li class="bbp-topic-description">',
+            'after'     => '</li></ul></div>',
+            'size'      => 14
+        ),
+        'get_single_topic_description'
+    );
+    // Validate topic_id
+    $topic_id = bbp_get_topic_id( $r['topic_id'] );
+    // Unhook the 'view all' query var adder
+    remove_filter( 'bbp_get_topic_permalink', 'bbp_add_view_all' );
+    // Build the topic description
+    $vc_int      = bbp_get_topic_voice_count   ( $topic_id, true  );
+    $voice_count = bbp_get_topic_voice_count   ( $topic_id, false );
+    $reply_count = bbp_get_topic_replies_link  ( $topic_id        );
+    $time_since  = bbp_get_topic_freshness_link( $topic_id        );
+    // Singular/Plural
+    /* translators: %s: Number of voices/participants */
+    $voice_count = sprintf( _n( '%s voice', '%s voices', $vc_int, 'bbpress' ), $voice_count );
+    // Topic has activity (could be from reply or topic author)
+    $last_active = bbp_get_topic_last_active_id( $topic_id );
+    if ( ! empty( $last_active ) ) {
+        // Last-updated-by should always exist if last-active does
+        $last_updated_by = bbp_get_author_link(
             array(
+                'topic_id'  => 0,
+                'before'    => '<div class="bbp-template-notice info"><ul><li class="bbp-topic-description">',
+                'after'     => '</li></ul></div>',
+                'size'      => 14
+            ),
+            'get_single_topic_description'
+                'post_id' => $last_active,
+                'size'    => $r['size']
+            )
         );
+        // Validate topic_id
+        $topic_id = bbp_get_topic_id( $r['topic_id'] );
+        // Unhook the 'view all' query var adder
+        remove_filter( 'bbp_get_topic_permalink', 'bbp_add_view_all' );
+        // Build the topic description
+        $vc_int      = bbp_get_topic_voice_count   ( $topic_id, true  );
+        $voice_count = bbp_get_topic_voice_count   ( $topic_id, false );
+        $reply_count = bbp_get_topic_replies_link  ( $topic_id        );
+        $time_since  = bbp_get_topic_freshness_link( $topic_id        );
+        // Singular/Plural
+        /* translators: %s: Number of voices/participants */
+        $voice_count = sprintf( _n( '%s voice', '%s voices', $vc_int, 'bbpress' ), $voice_count );
+        // Topic has activity (could be from reply or topic author)
+        $last_active = bbp_get_topic_last_active_id( $topic_id );
+        if ( ! empty( $last_active ) ) {
+            // Last-updated-by should always exist if last-active does
+            $last_updated_by = bbp_get_author_link(
+                array(
+                    'post_id' => $last_active,
+                    'size'    => $r['size']
+                )
+            );
+            // Voice count is non-zero (registered users engaged)
+            if ( ! empty( $vc_int ) ) {
+                /* translators: 1: Reply count, 2: Voice count, 3: Last updated time, 4: Last updated by */
+                $retstr = sprintf( esc_html__( 'This topic has %1$s, %2$s, and was last updated %3$s by %4$s.', 'bbpress' ), $reply_count, $voice_count, $time_since, $last_updated_by );
+            // Voice count is zero (anonymous users only)
+            } else {
+                /* translators: 1: Last updated time, 2: Last updated by */
+                $retstr = sprintf( esc_html__( 'This topic was last updated %1$s by %2$s.', 'bbpress' ), $time_since, $last_updated_by );
+            }
+        // Topic has no replies
+        } elseif ( ! empty( $vc_int ) && ! empty( $reply_count ) ) {
+            /* translators: 1: Voice count, 2: Reply count */
+            $retstr = sprintf( esc_html__( 'This topic has %1$s and %2$s.', 'bbpress' ), $voice_count, $reply_count );
+        // Topic has no replies and no voices
+        } elseif ( empty( $vc_int ) && empty( $reply_count ) ) {
+            $retstr = esc_html__( 'This topic has no replies.', 'bbpress' );
+        // Topic is pending
+        } elseif ( bbp_get_topic_status( $topic_id ) === bbp_get_pending_status_id() ) {
+            $retstr = esc_html__( 'This topic is pending moderation.', 'bbpress' );
+        // Fallback
+        // Voice count is non-zero (registered users engaged)
+        if ( ! empty( $vc_int ) ) {
+            /* translators: 1: Reply count, 2: Voice count, 3: Last updated time, 4: Last updated by */
+            $retstr = sprintf( esc_html__( 'This topic has %1$s, %2$s, and was last updated %3$s by %4$s.', 'bbpress' ), $reply_count, $voice_count, $time_since, $last_updated_by );
+        // Voice count is zero (anonymous users only)
         } else {
+            $retstr = esc_html__( 'This topic is empty.', 'bbpress' );
+            /* translators: 1: Last updated time, 2: Last updated by */
+            $retstr = sprintf( esc_html__( 'This topic was last updated %1$s by %2$s.', 'bbpress' ), $time_since, $last_updated_by );
+        }
+        // Add the 'view all' filter back
+        add_filter( 'bbp_get_topic_permalink', 'bbp_add_view_all' );
+        // Combine the elements together
+        $retstr = $r['before'] . $retstr . $r['after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_single_topic_description', $retstr, $r, $args );
+    }
+    // Topic has no replies
+    } elseif ( ! empty( $vc_int ) && ! empty( $reply_count ) ) {
+        /* translators: 1: Voice count, 2: Reply count */
+        $retstr = sprintf( esc_html__( 'This topic has %1$s and %2$s.', 'bbpress' ), $voice_count, $reply_count );
+    // Topic has no replies and no voices
+    } elseif ( empty( $vc_int ) && empty( $reply_count ) ) {
+        $retstr = esc_html__( 'This topic has no replies.', 'bbpress' );
+    // Topic is pending
+    } elseif ( bbp_get_topic_status( $topic_id ) === bbp_get_pending_status_id() ) {
+        $retstr = esc_html__( 'This topic is pending moderation.', 'bbpress' );
+    // Fallback
+    } else {
+        $retstr = esc_html__( 'This topic is empty.', 'bbpress' );
+    }
+    // Add the 'view all' filter back
+    add_filter( 'bbp_get_topic_permalink', 'bbp_add_view_all' );
+    // Combine the elements together
+    $retstr = $r['before'] . $retstr . $r['after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_single_topic_description', $retstr, $r, $args );
+}
 /** Topic Tags ****************************************************************/
 /**
  * Output the unique id of the topic tag taxonomy
+ * Output the unique id of the topic tag taxonomy.
+ *
  * @since 2.0.0 bbPress (r3348)
 …
     echo bbp_get_topic_tag_tax_id();
+}
+    /**
+     * Return the unique id of the topic tag taxonomy
+     *
+     * @since 2.0.0 bbPress (r3348)
+     *
+     * @return string The unique topic tag taxonomy
+     */
+    function bbp_get_topic_tag_tax_id() {
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_tag_tax_id', bbpress()->topic_tag_tax_id );
+    }
+/**
+ * Return array of labels used by the topic-tag taxonomy
+/**
+ * Return the unique id of the topic tag taxonomy.
+ *
+ * @since 2.0.0 bbPress (r3348)
+ *
+ * @return string The unique topic tag taxonomy.
+ */
+function bbp_get_topic_tag_tax_id() {
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_tag_tax_id', bbpress()->topic_tag_tax_id );
+}
+/**
+ * Return array of labels used by the topic-tag taxonomy.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Return an array of topic-tag taxonomy rewrite settings
+ * Return an array of topic-tag taxonomy rewrite settings.
+ *
  * @since 2.5.0 bbPress (r5129)
 …
 /**
  * Output the id of the current tag
+ * Output the id of the current tag.
+ *
  * @since 2.0.0 bbPress (r3109)
+ *
  */
 function bbp_topic_tag_id( $tag = '' ) {
     echo bbp_get_topic_tag_id( $tag );
+}
+    /**
+     * Return the id of the current tag
+     *
+     * @since 2.0.0 bbPress (r3109)
+     *
+     * @return string Term Name
+     */
+    function bbp_get_topic_tag_id( $tag = '' ) {
+        // Get the term
+        if ( ! empty( $tag ) ) {
+            $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+        } else {
+            $tag  = get_query_var( 'term' );
+            $term = get_queried_object();
+        }
+        // Get the term ID
+        $retval = ! empty( $term->term_id )
+            ? $term->term_id
+            : 0;
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_topic_tag_id', (int) $retval, $tag, $term );
+    }
+/**
+ * Output the name of the current tag
+/**
+ * Return the id of the current tag.
+ *
+ * @since 2.0.0 bbPress (r3109)
+ *
+ * @return string Term Name.
+ */
+function bbp_get_topic_tag_id( $tag = '' ) {
+    // Get the term
+    if ( ! empty( $tag ) ) {
+        $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+    } else {
+        $tag  = get_query_var( 'term' );
+        $term = get_queried_object();
+    }
+    // Get the term ID
+    $retval = ! empty( $term->term_id )
+        ? $term->term_id
+        : 0;
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_topic_tag_id', (int) $retval, $tag, $term );
+}
+/**
+ * Output the name of the current tag.
+ *
  * @since 2.0.0 bbPress (r3109)
 …
     echo bbp_get_topic_tag_name( $tag );
+}
+    /**
+     * Return the name of the current tag
+     *
+     * @since 2.0.0 bbPress (r3109)
+     *
+     * @return string Term Name
+     */
+    function bbp_get_topic_tag_name( $tag = '' ) {
+        // Get the term
+        if ( ! empty( $tag ) ) {
+            $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+        } else {
+            $tag  = get_query_var( 'term' );
+            $term = get_queried_object();
+        }
+        // Get the term name
+        $retval = ! empty( $term->name )
+            ? $term->name
+            : '';
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_tag_name', $retval, $tag, $term );
+    }
+/**
+ * Output the slug of the current tag
+/**
+ * Return the name of the current tag.
+ *
+ * @since 2.0.0 bbPress (r3109)
+ *
+ * @return string Term Name.
+ */
+function bbp_get_topic_tag_name( $tag = '' ) {
+    // Get the term
+    if ( ! empty( $tag ) ) {
+        $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+    } else {
+        $tag  = get_query_var( 'term' );
+        $term = get_queried_object();
+    }
+    // Get the term name
+    $retval = ! empty( $term->name )
+        ? $term->name
+        : '';
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_tag_name', $retval, $tag, $term );
+}
+/**
+ * Output the slug of the current tag.
+ *
  * @since 2.0.0 bbPress (r3109)
 …
     echo bbp_get_topic_tag_slug( $tag );
+}
+    /**
+     * Return the slug of the current tag
+     *
+     * @since 2.0.0 bbPress (r3109)
+     *
+     * @return string Term Name
+     */
+    function bbp_get_topic_tag_slug( $tag = '' ) {
+        // Get the term
+        if ( ! empty( $tag ) ) {
+            $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+        } else {
+            $tag  = get_query_var( 'term' );
+            $term = get_queried_object();
+        }
+        // Get the term slug
+        $retval = ! empty( $term->slug )
+            ? $term->slug
+            : '';
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_tag_slug', $retval, $tag, $term );
+    }
+/**
+ * Output the link of the current tag
+/**
+ * Return the slug of the current tag.
+ *
+ * @since 2.0.0 bbPress (r3109)
+ *
+ * @return string Term Name.
+ */
+function bbp_get_topic_tag_slug( $tag = '' ) {
+    // Get the term
+    if ( ! empty( $tag ) ) {
+        $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+    } else {
+        $tag  = get_query_var( 'term' );
+        $term = get_queried_object();
+    }
+    // Get the term slug
+    $retval = ! empty( $term->slug )
+        ? $term->slug
+        : '';
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_tag_slug', $retval, $tag, $term );
+}
+/**
+ * Output the link of the current tag.
+ *
  * @since 2.0.0 bbPress (r3348)
 …
     echo esc_url( bbp_get_topic_tag_link( $tag ) );
+}
+    /**
+     * Return the link of the current tag
+     *
+     * @since 2.0.0 bbPress (r3348)
+     *
+     * @return string Term Name
+     */
+    function bbp_get_topic_tag_link( $tag = '' ) {
+        // Get the term
+        if ( ! empty( $tag ) ) {
+            $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+        } else {
+            $tag  = get_query_var( 'term' );
+            $term = get_queried_object();
+        }
+        // Get the term link
+        $retval = ! empty( $term->term_id )
+            ? get_term_link( $term, bbp_get_topic_tag_tax_id() )
+            : '';
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_tag_link', $retval, $tag, $term );
+    }
+/**
+ * Output the link of the current tag
+/**
+ * Return the link of the current tag.
+ *
+ * @since 2.0.0 bbPress (r3348)
+ *
+ * @return string Term Name.
+ */
+function bbp_get_topic_tag_link( $tag = '' ) {
+    // Get the term
+    if ( ! empty( $tag ) ) {
+        $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+    } else {
+        $tag  = get_query_var( 'term' );
+        $term = get_queried_object();
+    }
+    // Get the term link
+    $retval = ! empty( $term->term_id )
+        ? get_term_link( $term, bbp_get_topic_tag_tax_id() )
+        : '';
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_tag_link', $retval, $tag, $term );
+}
+/**
+ * Output the link of the current tag.
+ *
  * @since 2.0.0 bbPress (r3348)
 …
     echo esc_url( bbp_get_topic_tag_edit_link( $tag ) );
+}
+    /**
+     * Return the link of the current tag
+     *
+     * @since 2.0.0 bbPress (r3348)
+     *
+     * @return string Term Name
+     */
+    function bbp_get_topic_tag_edit_link( $tag = '' ) {
+        // Get the term
+        if ( ! empty( $tag ) ) {
+            $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+        } else {
+            $tag  = get_query_var( 'term' );
+            $term = get_queried_object();
+        }
+        // Get the term's edit link
+        if ( ! empty( $term->term_id ) ) {
+            // Pretty or ugly URL
+            $retval = bbp_use_pretty_urls()
+                ? user_trailingslashit( trailingslashit( bbp_get_topic_tag_link() ) . bbp_get_edit_slug() )
+                : add_query_arg( array( bbp_get_edit_rewrite_id() => '1' ), bbp_get_topic_tag_link() );
+        // No link
+        } else {
+            $retval = '';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_tag_edit_link', $retval, $tag, $term );
+    }
+/**
+ * Output the description of the current tag
+/**
+ * Return the link of the current tag.
+ *
+ * @since 2.0.0 bbPress (r3348)
+ *
+ * @return string Term Name.
+ */
+function bbp_get_topic_tag_edit_link( $tag = '' ) {
+    // Get the term
+    if ( ! empty( $tag ) ) {
+        $term = get_term_by( 'slug', $tag, bbp_get_topic_tag_tax_id() );
+    } else {
+        $tag  = get_query_var( 'term' );
+        $term = get_queried_object();
+    }
+    // Get the term's edit link
+    if ( ! empty( $term->term_id ) ) {
+        // Pretty or ugly URL
+        $retval = bbp_use_pretty_urls()
+            ? user_trailingslashit( trailingslashit( bbp_get_topic_tag_link() ) . bbp_get_edit_slug() )
+            : add_query_arg( array( bbp_get_edit_rewrite_id() => '1' ), bbp_get_topic_tag_link() );
+    // No link
+    } else {
+        $retval = '';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_tag_edit_link', $retval, $tag, $term );
+}
+/**
+ * Output the description of the current tag.
+ *
  * @since 2.0.0 bbPress (r3109)
 …
     echo bbp_get_topic_tag_description( $args );
+}
+    /**
+     * Return the description of the current tag
+     *
+     * @since 2.0.0 bbPress (r3109)
+     *
+     * @param array $args before|after|tag
+     *
+     * @return string Term Name
+     */
+    function bbp_get_topic_tag_description( $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'before' => '<div class="bbp-topic-tag-description"><p>',
+                'after'  => '</p></div>',
+                'tag'    => ''
+            ),
+            'get_topic_tag_description'
+        );
+        // Get the term
+        if ( ! empty( $r['tag'] ) ) {
+            $term = get_term_by( 'slug', $r['tag'], bbp_get_topic_tag_tax_id() );
+        } else {
+            $tag  = $r['tag'] = get_query_var( 'term' );
+            $term = get_queried_object();
+        }
+        // Add before & after if description exists
+        $retval = ! empty( $term->description )
+            ? $r['before'] . $term->description . $r['after']
+            : '';
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_tag_description', $retval, $r, $args, $tag, $term );
+    }
+/**
+ * Return the description of the current tag.
+ *
+ * @since 2.0.0 bbPress (r3109)
+ *
+ * @param array $args before|after|tag.
+ *
+ * @return string Term Name.
+ */
+function bbp_get_topic_tag_description( $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'before' => '<div class="bbp-topic-tag-description"><p>',
+            'after'  => '</p></div>',
+            'tag'    => ''
+        ),
+        'get_topic_tag_description'
+    );
+    // Get the term
+    if ( ! empty( $r['tag'] ) ) {
+        $term = get_term_by( 'slug', $r['tag'], bbp_get_topic_tag_tax_id() );
+    } else {
+        $tag  = $r['tag'] = get_query_var( 'term' );
+        $term = get_queried_object();
+    }
+    // Add before & after if description exists
+    $retval = ! empty( $term->description )
+        ? $r['before'] . $term->description . $r['after']
+        : '';
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_tag_description', $retval, $r, $args, $tag, $term );
+}
 /** Forms *********************************************************************/
 /**
  * Output the value of topic title field
+ * Output the value of topic title field.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_title();
+}
+    /**
+     * Return the value of topic title field
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Value of topic title field
+     */
+    function bbp_get_form_topic_title() {
+        // Get _POST data
+        if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_title'] ) ) {
+            $topic_title = wp_unslash( $_POST['bbp_topic_title'] );
+        // Get edit data
+        } elseif ( bbp_is_topic_edit() ) {
+            $topic_title = bbp_get_global_post_field( 'post_title', 'raw' );
+        // No data
+        } else {
+            $topic_title = '';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_title', $topic_title );
+    }
+/**
+ * Output the value of topic content field
+/**
+ * Return the value of topic title field.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Value of topic title field.
+ */
+function bbp_get_form_topic_title() {
+    // Get _POST data
+    if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_title'] ) ) {
+        $topic_title = wp_unslash( $_POST['bbp_topic_title'] );
+    // Get edit data
+    } elseif ( bbp_is_topic_edit() ) {
+        $topic_title = bbp_get_global_post_field( 'post_title', 'raw' );
+    // No data
+    } else {
+        $topic_title = '';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_title', $topic_title );
+}
+/**
+ * Output the value of topic content field.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_content();
+}
+    /**
+     * Return the value of topic content field
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Value of topic content field
+     */
+    function bbp_get_form_topic_content() {
+        // Get _POST data
+        if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_content'] ) ) {
+            $topic_content = wp_unslash( $_POST['bbp_topic_content'] );
+        // Get edit data
+        } elseif ( bbp_is_topic_edit() ) {
+            $topic_content = bbp_get_global_post_field( 'post_content', 'raw' );
+        // No data
+        } else {
+            $topic_content = '';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_content', $topic_content );
+    }
+/**
+ * Allow topic rows to have administrative actions
+/**
+ * Return the value of topic content field.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Value of topic content field.
+ */
+function bbp_get_form_topic_content() {
+    // Get _POST data
+    if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_content'] ) ) {
+        $topic_content = wp_unslash( $_POST['bbp_topic_content'] );
+    // Get edit data
+    } elseif ( bbp_is_topic_edit() ) {
+        $topic_content = bbp_get_global_post_field( 'post_content', 'raw' );
+    // No data
+    } else {
+        $topic_content = '';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_content', $topic_content );
+}
+/**
+ * Allow topic rows to have administrative actions.
+ *
  * @since 2.1.0 bbPress (r3653)
+ *
  * @todo Links and filter
+ * @todo Links and filter.
  */
 function bbp_topic_row_actions() {
 …
 /**
  * Output value of topic tags field
+ * Output value of topic tags field.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_tags();
+}
+    /**
+     * Return value of topic tags field
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Value of topic tags field
+     */
+    function bbp_get_form_topic_tags() {
+        // Default return value
         $topic_tags = '';
+        // Get _POST data
         if ( ( bbp_is_topic_form_post_request() || bbp_is_reply_form_post_request() ) && isset( $_POST['bbp_topic_tags'] ) ) {
             $topic_tags = wp_unslash( $_POST['bbp_topic_tags'] );
+        // Get edit data
         } elseif ( bbp_is_single_topic() || bbp_is_single_reply() || bbp_is_topic_edit() || bbp_is_reply_edit() ) {
+            // Determine the topic id based on the post type
             switch ( get_post_type() ) {
+                // Post is a topic
                 case bbp_get_topic_post_type() :
                     $topic_id = bbp_get_topic_id( get_the_ID() );
                     break;
+                // Post is a reply
                 case bbp_get_reply_post_type() :
                     $topic_id = bbp_get_reply_topic_id( get_the_ID() );
                     break;
+            }
+            // Topic exists
             if ( ! empty( $topic_id ) ) {
+                // Topic is spammed so display pre-spam terms
                 if ( bbp_is_topic_spam( $topic_id ) ) {
+                    // Get pre-spam terms
                     $spam_terms = get_post_meta( $topic_id, '_bbp_spam_topic_tags', true );
                     $topic_tags = ( ! empty( $spam_terms ) ) ? implode( ', ', $spam_terms ) : '';
+                // Topic is not spam so get real terms
                 } else {
                     $topic_tags = bbp_get_topic_tag_names( $topic_id );
+                }
+/**
+ * Return value of topic tags field.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Value of topic tags field.
+ */
+function bbp_get_form_topic_tags() {
+    // Default return value
+    $topic_tags = '';
+    // Get _POST data
+    if ( ( bbp_is_topic_form_post_request() || bbp_is_reply_form_post_request() ) && isset( $_POST['bbp_topic_tags'] ) ) {
+        $topic_tags = wp_unslash( $_POST['bbp_topic_tags'] );
+    // Get edit data
+    } elseif ( bbp_is_single_topic() || bbp_is_single_reply() || bbp_is_topic_edit() || bbp_is_reply_edit() ) {
+        // Determine the topic id based on the post type
+        switch ( get_post_type() ) {
+            // Post is a topic
+            case bbp_get_topic_post_type() :
+                $topic_id = bbp_get_topic_id( get_the_ID() );
+                break;
+            // Post is a reply
+            case bbp_get_reply_post_type() :
+                $topic_id = bbp_get_reply_topic_id( get_the_ID() );
+                break;
+        }
+        // Topic exists
+        if ( ! empty( $topic_id ) ) {
+            // Topic is spammed so display pre-spam terms
+            if ( bbp_is_topic_spam( $topic_id ) ) {
+                // Get pre-spam terms
+                $spam_terms = get_post_meta( $topic_id, '_bbp_spam_topic_tags', true );
+                $topic_tags = ( ! empty( $spam_terms ) ) ? implode( ', ', $spam_terms ) : '';
+            // Topic is not spam so get real terms
+            } else {
+                $topic_tags = bbp_get_topic_tag_names( $topic_id );
+            }
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_tags', $topic_tags );
+    }
+/**
+ * Output value of topic forum
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_tags', $topic_tags );
+}
+/**
+ * Output value of topic forum.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_forum();
+}
+    /**
+     * Return value of topic forum
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Value of topic content field
+     */
+    function bbp_get_form_topic_forum() {
+        // Get _POST data
+        if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_forum_id'] ) ) {
+            $topic_forum = (int) $_POST['bbp_forum_id'];
+        // Get edit data
+        } elseif ( bbp_is_topic_edit() ) {
+            $topic_forum = bbp_get_topic_forum_id();
+        // No data
+        } else {
+            $topic_forum = 0;
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_forum', $topic_forum );
+    }
+/**
+ * Output checked value of topic subscription
+/**
+ * Return value of topic forum.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Value of topic content field.
+ */
+function bbp_get_form_topic_forum() {
+    // Get _POST data
+    if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_forum_id'] ) ) {
+        $topic_forum = (int) $_POST['bbp_forum_id'];
+    // Get edit data
+    } elseif ( bbp_is_topic_edit() ) {
+        $topic_forum = bbp_get_topic_forum_id();
+    // No data
+    } else {
+        $topic_forum = 0;
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_forum', $topic_forum );
+}
+/**
+ * Output checked value of topic subscription.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_subscribed();
+}
+    /**
+     * Return checked value of topic subscription
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Checked value of topic subscription
+     */
+    function bbp_get_form_topic_subscribed() {
+        // Default value
+        $topic_subscribed = false;
+        // Get _POST data
+        if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_subscription'] ) ) {
+            $topic_subscribed = (bool) $_POST['bbp_topic_subscription'];
+        // Get edit data
+        } elseif ( bbp_is_topic_edit() || bbp_is_reply_edit() ) {
+            $post_author      = (int) bbp_get_global_post_field( 'post_author', 'raw' );
+            $topic_subscribed = bbp_is_user_subscribed( $post_author, bbp_get_topic_id() );
+        // Get current status
+        } elseif ( bbp_is_single_topic() ) {
+            $topic_subscribed = bbp_is_user_subscribed( bbp_get_current_user_id(), bbp_get_topic_id() );
+        }
+        // Get checked output
+        $checked = checked( $topic_subscribed, true, false );
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_subscribed', $checked, $topic_subscribed );
+    }
+/**
+ * Output checked value of topic log edit field
+/**
+ * Return checked value of topic subscription.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Checked value of topic subscription.
+ */
+function bbp_get_form_topic_subscribed() {
+    // Default value
+    $topic_subscribed = false;
+    // Get _POST data
+    if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_subscription'] ) ) {
+        $topic_subscribed = (bool) $_POST['bbp_topic_subscription'];
+    // Get edit data
+    } elseif ( bbp_is_topic_edit() || bbp_is_reply_edit() ) {
+        $post_author      = (int) bbp_get_global_post_field( 'post_author', 'raw' );
+        $topic_subscribed = bbp_is_user_subscribed( $post_author, bbp_get_topic_id() );
+    // Get current status
+    } elseif ( bbp_is_single_topic() ) {
+        $topic_subscribed = bbp_is_user_subscribed( bbp_get_current_user_id(), bbp_get_topic_id() );
+    }
+    // Get checked output
+    $checked = checked( $topic_subscribed, true, false );
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_subscribed', $checked, $topic_subscribed );
+}
+/**
+ * Output checked value of topic log edit field.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_log_edit();
+}
+    /**
+     * Return checked value of topic log edit field
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Topic log edit checked value
+     */
+    function bbp_get_form_topic_log_edit() {
+        // Get _POST data
+        if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_log_topic_edit'] ) ) {
+            $topic_revision = (bool) $_POST['bbp_log_topic_edit'];
+        // No data
+        } else {
+            $topic_revision = true;
+        }
+        // Get checked output
+        $checked = checked( $topic_revision, true, false );
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_log_edit', $checked, $topic_revision );
+    }
+/**
+ * Output the value of the topic edit reason
+/**
+ * Return checked value of topic log edit field.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Topic log edit checked value.
+ */
+function bbp_get_form_topic_log_edit() {
+    // Get _POST data
+    if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_log_topic_edit'] ) ) {
+        $topic_revision = (bool) $_POST['bbp_log_topic_edit'];
+    // No data
+    } else {
+        $topic_revision = true;
+    }
+    // Get checked output
+    $checked = checked( $topic_revision, true, false );
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_log_edit', $checked, $topic_revision );
+}
+/**
+ * Output the value of the topic edit reason.
+ *
  * @since 2.0.0 bbPress (r2976)
 …
     echo bbp_get_form_topic_edit_reason();
+}
+    /**
+     * Return the value of the topic edit reason
+     *
+     * @since 2.0.0 bbPress (r2976)
+     *
+     * @return string Topic edit reason value
+     */
+    function bbp_get_form_topic_edit_reason() {
+        // Get _POST data
+        if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_edit_reason'] ) ) {
+            $topic_edit_reason = wp_unslash( $_POST['bbp_topic_edit_reason'] );
+        // No data
+        } else {
+            $topic_edit_reason = '';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_form_topic_edit_reason', $topic_edit_reason );
+    }
+/**
+ * Return the value of the topic edit reason.
+ *
+ * @since 2.0.0 bbPress (r2976)
+ *
+ * @return string Topic edit reason value.
+ */
+function bbp_get_form_topic_edit_reason() {
+    // Get _POST data
+    if ( bbp_is_topic_form_post_request() && isset( $_POST['bbp_topic_edit_reason'] ) ) {
+        $topic_edit_reason = wp_unslash( $_POST['bbp_topic_edit_reason'] );
+    // No data
+    } else {
+        $topic_edit_reason = '';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_form_topic_edit_reason', $topic_edit_reason );
+}
 /**
 …
  * @since 2.6.0 bbPress (r5558)
+ *
  * @return boolean True if is a post request with valid nonce
+ * @return boolean True if is a post request with valid nonce.
  */
 function bbp_is_topic_form_post_request() {
 …
 /**
  * Output the topic lock description
+ * Output the topic lock description.
+ *
  * @since 2.6.0 bbPress (r6343)
+ *
  * @param int $topic_id Optional. Topic id
+ * @param int $topic_id Optional. Topic id.
  */
 function bbp_topic_lock_description( $topic_id = 0 ) {
     echo bbp_get_topic_lock_description( $topic_id );
+}
+    /**
+     * Return the topic lock description
+     *
+     * @since 2.6.0 bbPress (r6343)
+     *
+     * @param int $topic_id Optional. Topic id
+     */
+    function bbp_get_topic_lock_description( $topic_id = 0 ) {
+        // Check if topic is edit locked
+        $topic_id = bbp_get_topic_id( $topic_id );
+        $user_id  = bbp_check_post_lock( $topic_id );
+        $person   = empty( $user_id )
+            ? esc_html__( 'Nobody', 'bbpress' )
+            : bbp_get_user_profile_link( $user_id );
+        // Get the text
+        /* translators: %1$s: Person who is editing (user profile link or "Nobody") */
+        $text = sprintf( esc_html__( '%1$s is currently editing this topic.', 'bbpress' ), $person );
+        // Filter & return
+        return apply_filters( 'bbp_get_topic_lock_description', $text, $user_id, $topic_id );
+    }
+/**
+ * Return the topic lock description.
+ *
+ * @since 2.6.0 bbPress (r6343)
+ *
+ * @param int $topic_id Optional. Topic id.
+ */
+function bbp_get_topic_lock_description( $topic_id = 0 ) {
+    // Check if topic is edit locked
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $user_id  = bbp_check_post_lock( $topic_id );
+    $person   = empty( $user_id )
+        ? esc_html__( 'Nobody', 'bbpress' )
+        : bbp_get_user_profile_link( $user_id );
+    // Get the text
+    /* translators: %1$s: Person who is editing (user profile link or "Nobody") */
+    $text = sprintf( esc_html__( '%1$s is currently editing this topic.', 'bbpress' ), $person );
+    // Filter & return
+    return apply_filters( 'bbp_get_topic_lock_description', $text, $user_id, $topic_id );
+}

trunk/src/includes/users/capabilities.php

-                      r7378
+                      r7380
 /**
  * bbPress User Capabilities
+ * bbPress User Capabilities.
+ *
  * Used to map user capabilities to WordPress's existing capabilities.
 …
 /**
  * Maps primary capabilities
+ * Maps primary capabilities.
+ *
  * @since 2.2.0 bbPress (r4242)
 …
  * @param array  $args Arguments.
+ *
  * @return array Actual capabilities for meta capability
+ * @return array Actual capabilities for meta capability.
  */
 function bbp_map_primary_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {
 …
 /**
  * Set a user's role in the forums
+ * Set a user's role in the forums.
+ *
  * @since 2.1.0 bbPress (r3860)
+ *
  * @param int $user_id
+ * @param int $user_id User id.
+ *
  * @return mixed False if no change. String of new role if changed.
 …
 /**
  * Return a user's forums role
+ * Return a user's forums role.
+ *
  * @since 2.1.0 bbPress (r3860)
+ *
  * @param int $user_id
+ * @param int $user_id User id.
+ *
  * @return string
 …
 /**
  * Return a user's blog role
+ * Return a user's blog role.
+ *
  * @since 2.3.0 bbPress (r4446)
+ *
  * @param int $user_id
+ * @param int $user_id User id.
+ *
  * @return string
 …
  * @since 2.2.0 bbPress (r4235)
+ *
  * @param int $user_id
+ * @param int $user_id User id.
  */
 function bbp_profile_update_role( $user_id = 0 ) {
 …
 /**
  * Check if a role ID is valid
+ * Check if a role ID is valid.
+ *
  * This helper function accepts a role ID as a string, and compares it against
 …
  * @since 2.6.5
+ *
  * @param string $role A well-formed (string) role ID to validate
+ * @param string $role A well-formed (string) role ID to validate.
+ *
  * @return bool True if role is valid. False if role is not valid.
 …
 /**
  * Add the default role to the current user if needed
+ * Add the default role to the current user if needed.
+ *
  * This function will bail if the forum is not global in a multisite
 …
  * @since 2.0.0 bbPress (r3380)
+ *
  * @return If not multisite, not global, or user is deleted/spammed
+ * @return If not multisite, not global, or user is deleted/spammed.
  */
 function bbp_set_current_user_default_role() {
 …
  * @since 2.2.0 bbPress (r4334)
+ *
  * @return array Filtered array of WordPress roles to bbPress roles
+ * @return array Filtered array of WordPress roles to bbPress roles.
  */
 function bbp_get_user_role_map() {
 …
 /**
  * Mark a users topics and replies as spam when the user is marked as spam
+ * Mark a users topics and replies as spam when the user is marked as spam.
+ *
  * @since 2.0.0 bbPress (r3405)
 …
 /**
  * Mark a users topics and replies as spam when the user is marked as spam
+ * Mark a users topics and replies as spam when the user is marked as spam.
+ *
  * @since 2.0.0 bbPress (r3405)
 …
 /**
  * Checks if user is active
+ * Checks if user is active.
+ *
  * @since 2.0.0 bbPress (r3502)
+ *
  * @param int $user_id The user ID to check
  * @return bool True if public, false if not
+ * @param int $user_id The user ID to check.
+ * @return bool True if public, false if not.
  */
 function bbp_is_user_active( $user_id = 0 ) {
 …
  * @since 2.0.0 bbPress (r3502)
+ *
  * @param int $user_id The user ID to check. Defaults to current user ID
  * @return bool True if inactive, false if active
+ * @param int $user_id The user ID to check. Defaults to current user ID.
+ * @return bool True if inactive, false if active.
  */
 function bbp_is_user_inactive( $user_id = 0 ) {
 …
 /**
  * Checks if user is a keymaster
+ * Checks if user is a keymaster.
+ *
  * @since 2.3.0 bbPress (r4783)
+ *
  * @param int $user_id
  * @return bool True if keymaster, false if not
+ * @param int $user_id The user ID to check. Defaults to current user ID.
+ * @return bool True if keymaster, false if not.
  */
 function bbp_is_user_keymaster( $user_id = 0 ) {
 …
 /**
  * Does a user have a profile for the current site
+ * Does a user have a profile for the current site.
+ *
  * @since 2.2.0 bbPress (r4362)
+ *
  * @param int $user_id User ID to check
+ * @param int $user_id User ID to check.
+ *
  * @return bool Whether or not the user has a profile on this blog_id.
 …
 /**
  * Add a moderator to an object
+ * Add a moderator to an object.
+ *
  * @since 2.6.0 bbPress (r6056)
+ *
  * @param int    $object_id   Traditionally a post ID
  * @param int    $user_id     User ID
  * @param string $object_type Type of meta (post,term,user,comment)
+ * @param int    $object_id   Traditionally a post ID.
+ * @param int    $user_id     User ID.
+ * @param string $object_type Type of meta (post,term,user,comment).
+ *
  * @return bool
 …
 /**
  * Remove a moderator user ID from an object
+ * Remove a moderator user ID from an object.
+ *
  * @since 2.6.0 bbPress (r6056)
+ *
  * @param int    $object_id   Traditionally a post ID
  * @param int    $user_id     User ID
  * @param string $object_type Type of meta (post,term,user,comment)
+ * @param int    $object_id   Traditionally a post ID.
+ * @param int    $user_id     User ID.
+ * @param string $object_type Type of meta (post,term,user,comment).
+ *
  * @return bool
 …
 /**
  * Get user IDs of moderators for an object
+ * Get user IDs of moderators for an object.
+ *
  * @since 2.6.0 bbPress (r6056)
+ *
  * @param int    $object_id   Traditionally a post ID
  * @param string $object_type Type of meta (post,term,user,comment)
+ * @param int    $object_id   Traditionally a post ID.
+ * @param string $object_type Type of meta (post,term,user,comment).
+ *
  * @return array
 …
  * @since 2.6.0 bbPress (r6056)
+ *
  * @param int    $object_id   Traditionally a post ID
  * @param string $object_type Type of meta (post,term,user,comment)
+ * @param int    $object_id   Traditionally a post ID.
+ * @param string $object_type Type of meta (post,term,user,comment).
+ *
  * @return array

trunk/src/includes/users/engagements.php

-                      r7378
+                      r7380
 /**
  * bbPress User Engagement Functions
+ * bbPress User Engagement Functions.
+ *
  * @package bbPress
 …
 /**
  * Add a user id to an object
+ * Add a user id to an object.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param int    $object_id The object id
  * @param int    $user_id   The user id
  * @param string $rel_key   The relationship key
  * @param string $rel_type  The relationship type (usually 'post')
  * @param bool   $unique    Whether meta key should be unique to the object
+ *
  * @return bool Returns true on success, false on failure
+ * @param int    $object_id The object id.
+ * @param int    $user_id   The user id.
+ * @param string $rel_key   The relationship key.
+ * @param string $rel_type  The relationship type (usually 'post').
+ * @param bool   $unique    Whether meta key should be unique to the object.
+ *
+ * @return bool Returns true on success, false on failure.
  */
 function bbp_add_user_to_object( $object_id = 0, $user_id = 0, $rel_key = '', $rel_type = 'post', $unique = false ) {
 …
 /**
  * Remove a user id from an object
+ * Remove a user id from an object.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param int    $object_id The object id
  * @param int    $user_id   The user id
  * @param string $rel_key   The relationship key
  * @param string $rel_type  The relationship type (usually 'post')
+ *
  * @return bool Returns true on success, false on failure
+ * @param int    $object_id The object id.
+ * @param int    $user_id   The user id.
+ * @param string $rel_key   The relationship key.
+ * @param string $rel_type  The relationship type (usually 'post').
+ *
+ * @return bool Returns true on success, false on failure.
  */
 function bbp_remove_user_from_object( $object_id = 0, $user_id = 0, $rel_key = '', $rel_type = 'post' ) {
 …
 /**
  * Remove a user id from all objects
+ * Remove a user id from all objects.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param int    $user_id  The user id
  * @param string $rel_key  The relationship key
  * @param string $rel_type The relationship type (usually 'post')
+ *
  * @return bool Returns true on success, false on failure
+ * @param int    $user_id  The user id.
+ * @param string $rel_key  The relationship key.
+ * @param string $rel_type The relationship type (usually 'post').
+ *
+ * @return bool Returns true on success, false on failure.
  */
 function bbp_remove_user_from_all_objects( $user_id = 0, $rel_key = '', $rel_type = 'post' ) {
 …
 /**
  * Remove an object from all users
+ * Remove an object from all users.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param int    $object_id The object id
  * @param int    $user_id   The user id
  * @param string $rel_key   The relationship key
  * @param string $rel_type  The relationship type (usually 'post')
+ *
  * @return bool Returns true on success, false on failure
+ * @param int    $object_id The object id.
+ * @param int    $user_id   The user id.
+ * @param string $rel_key   The relationship key.
+ * @param string $rel_type  The relationship type (usually 'post').
+ *
+ * @return bool Returns true on success, false on failure.
  */
 function bbp_remove_object_from_all_users( $object_id = 0, $rel_key = '', $rel_type = 'post' ) {
 …
 /**
  * Remove all users from all objects
+ * Remove all users from all objects.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param string $rel_key  The relationship key
  * @param string $rel_type The relationship type (usually 'post')
+ *
  * @return bool Returns true on success, false on failure
+ * @param string $rel_key  The relationship key.
+ * @param string $rel_type The relationship type (usually 'post').
+ *
+ * @return bool Returns true on success, false on failure.
  */
 function bbp_remove_all_users_from_all_objects( $rel_key = '', $rel_type = 'post' ) {
 …
 /**
  * Get users of an object
+ * Get users of an object.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param int    $object_id The object id
  * @param string $rel_key   The key used to index this relationship
  * @param string $rel_type  The type of meta to look in
+ * @param int    $object_id The object id.
+ * @param string $rel_key   The key used to index this relationship.
+ * @param string $rel_type  The type of meta to look in.
+ *
  * @return array Returns ids of users
 …
 /**
  * Check if an object has a specific user
+ * Check if an object has a specific user.
+ *
  * @since 2.6.0 bbPress (r6109)
+ *
  * @param int    $object_id The object id
  * @param int    $user_id   The user id
  * @param string $rel_key   The relationship key
  * @param string $rel_type  The relationship type (usually 'post')
+ *
  * @return bool Returns true if object has a user, false if not
+ * @param int    $object_id The object id.
+ * @param int    $user_id   The user id.
+ * @param string $rel_key   The relationship key.
+ * @param string $rel_type  The relationship type (usually 'post').
+ *
+ * @return bool Returns true if object has a user, false if not.
  */
 function bbp_is_object_of_user( $object_id = 0, $user_id = 0, $rel_key = '', $rel_type = 'post' ) {
 …
 /**
  * Get the query part responsible for JOINing objects to user IDs
+ * Get the query part responsible for JOINing objects to user IDs.
+ *
  * @since 2.6.0 bbPress (r6747)
+ *
  * @param array  $args      Default query arguments
  * @param string $context   Additional context
  * @param string $rel_key   The relationship key
  * @param string $rel_type  The relationship type (usually 'post')
+ * @param array  $args      Default query arguments.
+ * @param string $context   Additional context.
+ * @param string $rel_key   The relationship key.
+ * @param string $rel_type  The relationship type (usually 'post').
+ *
  * @return array
 …
 /**
  * Get the users who have engaged in a topic
+ * Get the users who have engaged in a topic.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param int $topic_id Optional. Topic id
+ *
  * @return array|bool Results if the topic has any engagements, otherwise false
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return array|bool Results if the topic has any engagements, otherwise false.
  */
 function bbp_get_topic_engagements( $topic_id = 0 ) {
 …
 /**
  * Return the users who have engaged in a topic, directly with a database query
+ * Return the users who have engaged in a topic, directly with a database query.
+ *
  * See: https://bbpress.trac.wordpress.org/ticket/3083
 …
  * @since 2.6.0 bbPress (r6522)
+ *
  * @param int $topic_id
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return array
 …
 /**
  * Get a user's topic engagements
+ * Get a user's topic engagements.
+ *
  * @since 2.6.0 bbPress (r6320)
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
+ *
  * @param array $args Optional. Arguments to pass into bbp_has_replies()
+ *
  * @return bool True if user has engaged, otherwise false
+ * @param array $args Optional. Arguments to pass into bbp_has_replies().
+ *
+ * @return bool True if user has engaged, otherwise false.
  */
 function bbp_get_user_engagements( $args = array() ) {
 …
 /**
  * Check if a user is engaged in a topic or not
+ * Check if a user is engaged in a topic or not.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ *
  * @return bool True if the topic is in user's engagements, otherwise false
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return bool True if the topic is in user's engagements, otherwise false.
  */
 function bbp_is_user_engaged( $user_id = 0, $topic_id = 0 ) {
 …
 /**
  * Add a topic to user's engagements
+ * Add a topic to user's engagements.
+ *
  * Note that both the User and Topic should be verified to exist before using
 …
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return bool Always true
 …
 /**
  * Remove a topic from user's engagements
+ * Remove a topic from user's engagements.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ *
  * @return bool True if the topic was removed from user's engagements, otherwise
  *               false
+ *               false.
  */
 function bbp_remove_user_engagement( $user_id = 0, $topic_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r6522)
+ *
  * @param int  $topic_id
  * @param bool $force
+ * @param int  $topic_id Topic id.
+ * @param bool $force    Force remove & add, even if old equals new.
+ *
  * @return boolean True if any engagements are added, false otherwise
 …
  * @since 2.6.0 bbPress (r6526)
+ *
  * @param int $topic_id
+ * @param int $topic_id Topic id.
  */
 function bbp_update_topic_engagements( $topic_id = 0 ) {
 …
 /**
  * Get the users who have made the topic favorite
+ * Get the users who have made the topic favorite.
+ *
  * @since 2.0.0 bbPress (r2658)
+ *
  * @param int $topic_id Optional. Topic id
+ *
  * @return array|bool Results if the topic has any favoriters, otherwise false
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return array|bool Results if the topic has any favoriters, otherwise false.
  */
 function bbp_get_topic_favoriters( $topic_id = 0 ) {
 …
 /**
  * Get a user's favorite topics
+ * Get a user's favorite topics.
+ *
  * @since 2.0.0 bbPress (r2652)
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
+ *
  * @param array $args Optional. Arguments to pass into bbp_has_topics()
+ *
  * @return array Array of topics if user has favorites, otherwise empty array
+ * @param array $args Optional. Arguments to pass into bbp_has_topics().
+ *
+ * @return array Array of topics if user has favorites, otherwise empty array.
  */
 function bbp_get_user_favorites( $args = array() ) {
 …
 /**
  * Check if a topic is in user's favorites or not
+ * Check if a topic is in user's favorites or not.
+ *
  * @since 2.0.0 bbPress (r2652)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ *
  * @return bool True if the topic is in user's favorites, otherwise false
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return bool True if the topic is in user's favorites, otherwise false.
  */
 function bbp_is_user_favorite( $user_id = 0, $topic_id = 0 ) {
 …
 /**
  * Add a topic to user's favorites
+ * Add a topic to user's favorites.
+ *
  * Note that both the User and Topic should be verified to exist before using
 …
  * @since 2.0.0 bbPress (r2652)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ *
  * @return bool True if the topic was added to user's favorites, otherwise false
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return bool True if the topic was added to user's favorites, otherwise false.
  */
 function bbp_add_user_favorite( $user_id = 0, $topic_id = 0 ) {
 …
 /**
  * Remove a topic from user's favorites
+ * Remove a topic from user's favorites.
+ *
  * @since 2.0.0 bbPress (r2652)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ *
  * @return bool True if the topic was removed from user's favorites, otherwise false
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return bool True if the topic was removed from user's favorites, otherwise false.
  */
 function bbp_remove_user_favorite( $user_id, $topic_id ) {
 …
 /**
+ * Handles the front end adding and removing of favorite topics
+ *
+ * @param string $action The requested action to compare this function to
+ * Handles the front end adding and removing of favorite topics.
+ *
+ * @since 2.0.0 bbPress (r2652)
+ *
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_favorites_handler( $action = '' ) {
 …
 /**
  * Get the users who have subscribed
+ * Get the users who have subscribed.
+ *
  * @since 2.6.0 bbPress (r5156)
+ *
  * @param int $object_id Optional. ID of object (forum, topic, or something else)
+ * @param int $object_id Optional. ID of object (forum, topic, or something else).
  */
 function bbp_get_subscribers( $object_id = 0, $type = 'post' ) {
 …
 /**
  * Get a user's subscribed topics
+ * Get a user's subscribed topics.
+ *
  * @since 2.0.0 bbPress (r2668)
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
+ *
  * @param array $args Optional. Arguments to pass into bbp_has_topics()
+ *
  * @return array Array of topics if user has topic subscriptions, otherwise empty array
+ * @param array $args Optional. Arguments to pass into bbp_has_topics().
+ *
+ * @return array Array of topics if user has topic subscriptions, otherwise empty array.
  */
 function bbp_get_user_topic_subscriptions( $args = array() ) {
 …
 /**
  * Get a user's subscribed forums
+ * Get a user's subscribed forums.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
+ *
  * @param array $args Optional. Arguments to pass into bbp_has_forums()
+ *
  * @return array Array of forums if user has forum subscriptions, otherwise empty array
+ * @param array $args Optional. Arguments to pass into bbp_has_forums().
+ *
+ * @return array Array of forums if user has forum subscriptions, otherwise empty array.
  */
 function bbp_get_user_forum_subscriptions( $args = array() ) {
 …
 /**
  * Check if an object (forum or topic) is in user's subscription list or not
+ * Check if an object (forum or topic) is in user's subscription list or not.
+ *
  * @since 2.5.0 bbPress (r5156)
+ *
  * @param int $user_id Optional. User id
  * @param int $object_id Optional. Object id
+ *
  * @return bool True if the object (forum or topic) is in user's subscriptions, otherwise false
+ * @param int $user_id Optional. User id.
+ * @param int $object_id Optional. Object id.
+ *
+ * @return bool True if the object (forum or topic) is in user's subscriptions, otherwise false.
  */
 function bbp_is_user_subscribed( $user_id = 0, $object_id = 0, $type = 'post' ) {
 …
 /**
  * Add a user subscription
+ * Add a user subscription.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @since 2.6.0 bbPress (r6544) Added $type parameter
+ *
  * @param int    $user_id   Optional. User id
  * @param int    $object_id Optional. Object id
  * @param string $type      Optional. Type of object being subscribed to
+ *
  * @return bool True if the object was added to user subscriptions, otherwise false
+ * @param int    $user_id   Optional. User id.
+ * @param int    $object_id Optional. Object id.
+ * @param string $type      Optional. Type of object being subscribed to.
+ *
+ * @return bool True if the object was added to user subscriptions, otherwise false.
  */
 function bbp_add_user_subscription( $user_id = 0, $object_id = 0, $type = 'post' ) {
 …
 /**
  * Remove a user subscription
+ * Remove a user subscription.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @since 2.6.0 bbPress (r6544) Added $type parameter
+ *
  * @param int    $user_id   Optional. User id
  * @param int    $object_id Optional. Object id
  * @param string $type      Optional. Type of object being subscribed to
+ *
  * @return bool True if the object was removed from user subscriptions, otherwise false
+ * @param int    $user_id   Optional. User id.
+ * @param int    $object_id Optional. Object id.
+ * @param string $type      Optional. Type of object being subscribed to.
+ *
+ * @return bool True if the object was removed from user subscriptions, otherwise false.
  */
 function bbp_remove_user_subscription( $user_id = 0, $object_id = 0, $type = 'post' ) {
 …
 /**
  * Handles the front end toggling of user subscriptions
+ * Handles the front end toggling of user subscriptions.
+ *
  * @since 2.0.0 bbPress (r2790)
  * @since 2.6.l bbPress (r6543)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_subscriptions_handler( $action = '' ) {
 …
  * @since 2.6.0 bbPress (r6606)
+ *
  * @param int    $user_id   The user id
  * @param string $rel_key   The relationship key
  * @param string $rel_type  The relationship type (usually 'post')
  * @param array  $args      The arguments to override defaults
+ *
  * @return array|bool Results if user has objects, otherwise null
+ * @param int    $user_id   The user id.
+ * @param string $rel_key   The relationship key.
+ * @param string $rel_type  The relationship type (usually 'post').
+ * @param array  $args      The arguments to override defaults.
+ *
+ * @return array|bool Results if user has objects, otherwise null.
  */
 function bbp_get_user_object_ids( $args = array() ) {
 …
 /**
  * Get array of forum IDs that a user can moderate
+ * Get array of forum IDs that a user can moderate.
+ *
  * @since 2.6.0 bbPress (r5834)
 …
  * @param int $user_id User id.
+ *
  * @return array Return array of forum ids, or empty array
+ * @return array Return array of forum ids, or empty array.
  */
 function bbp_get_moderator_forum_ids( $user_id = 0 ) {
 …
 /**
  * Get a user's engaged topic ids
+ * Get a user's engaged topic ids.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param int $user_id Optional. User id
+ *
  * @return array Return array of topic ids, or empty array
+ * @param int $user_id Optional. User id.
+ *
+ * @return array Return array of topic ids, or empty array.
  */
 function bbp_get_user_engaged_topic_ids( $user_id = 0 ) {
 …
 /**
  * Get a user's favorite topic ids
+ * Get a user's favorite topic ids.
+ *
  * @since 2.0.0 bbPress (r2652)
+ *
  * @param int $user_id Optional. User id
+ *
  * @return array Return array of favorite topic ids, or empty array
+ * @param int $user_id Optional. User id.
+ *
+ * @return array Return array of favorite topic ids, or empty array.
  */
 function bbp_get_user_favorites_topic_ids( $user_id = 0 ) {
 …
 /**
  * Get a user's subscribed forum ids
+ * Get a user's subscribed forum ids.
+ *
  * @since 2.5.0 bbPress (r5156)
+ *
  * @param int $user_id Optional. User id
+ *
  * @return array Return array of subscribed forum ids, or empty array
+ * @param int $user_id Optional. User id.
+ *
+ * @return array Return array of subscribed forum ids, or empty array.
  */
 function bbp_get_user_subscribed_forum_ids( $user_id = 0 ) {
 …
 /**
  * Get a user's subscribed topic ids
+ * Get a user's subscribed topic ids.
+ *
  * @since 2.0.0 bbPress (r2668)
+ *
  * @param int $user_id Optional. User id
+ *
  * @return array Return array of subscribed topic ids, or empty array
+ * @param int $user_id Optional. User id.
+ *
+ * @return array Return array of subscribed topic ids, or empty array.
  */
 function bbp_get_user_subscribed_topic_ids( $user_id = 0 ) {
 …
 /**
  * Get a user's subscribed topics
+ * Get a user's subscribed topics.
+ *
  * @since 2.0.0 bbPress (r2668)
  * @deprecated 2.5.0 bbPress (r5156)
+ *
  * @param int $user_id Optional. User id
+ *
  * @return array|bool Results if user has subscriptions, otherwise false
+ * @param int $user_id Optional. User id.
+ *
+ * @return array|bool Results if user has subscriptions, otherwise false.
  */
 function bbp_get_user_subscriptions( $user_id = 0 ) {
 …
 /**
  * Get the users who have subscribed to the forum
+ * Get the users who have subscribed to the forum.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $forum_id Optional. forum id
+ *
  * @return array|bool Results if the forum has any subscribers, otherwise false
+ * @param int $forum_id Optional. forum id.
+ *
+ * @return array|bool Results if the forum has any subscribers, otherwise false.
  */
 function bbp_get_forum_subscribers( $forum_id = 0 ) {
 …
 /**
  * Get the users who have subscribed to the topic
+ * Get the users who have subscribed to the topic.
+ *
  * @since 2.0.0 bbPress (r2668)
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $topic_id Optional. Topic id
+ *
  * @return array|bool Results if the topic has any subscribers, otherwise false
+ * @param int $topic_id Optional. Topic id.
+ *
+ * @return array|bool Results if the topic has any subscribers, otherwise false.
  */
 function bbp_get_topic_subscribers( $topic_id = 0 ) {
 …
 /**
  * Check if a forum is in user's subscription list or not
+ * Check if a forum is in user's subscription list or not.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $user_id  Optional. User id
  * @param int $forum_id Optional. Forum id
+ *
  * @return bool True if the forum is in user's subscriptions, otherwise false
+ * @param int $user_id  Optional. User id.
+ * @param int $forum_id Optional. Forum id.
+ *
+ * @return bool True if the forum is in user's subscriptions, otherwise false.
  */
 function bbp_is_user_subscribed_to_forum( $user_id = 0, $forum_id = 0 ) {
 …
 /**
  * Check if a topic is in user's subscription list or not
+ * Check if a topic is in user's subscription list or not.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @deprecated 2.6.0 bbPress (r6543) Use bbp_is_user_subscribed()
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
  * @return bool True if the topic is in user's subscriptions, otherwise false
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ * @return bool True if the topic is in user's subscriptions, otherwise false.
  */
 function bbp_is_user_subscribed_to_topic( $user_id = 0, $topic_id = 0 ) {
 …
 /**
  * Remove a forum from user's subscriptions
+ * Remove a forum from user's subscriptions.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $user_id Optional. User id
  * @param int $forum_id Optional. forum id
+ * @param int $user_id Optional. User id.
+ * @param int $forum_id Optional. forum id.
  * @return bool True if the forum was removed from user's subscriptions,
  *               otherwise false
+ *               otherwise false.
  */
 function bbp_remove_user_forum_subscription( $user_id = 0, $forum_id = 0 ) {
 …
 /**
  * Remove a topic from user's subscriptions
+ * Remove a topic from user's subscriptions.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
  * @return bool True if the topic was removed from user's subscriptions,
  *               otherwise false
+ *               otherwise false.
  */
 function bbp_remove_user_topic_subscription( $user_id = 0, $topic_id = 0 ) {
 …
 /**
  * Add a forum to user's subscriptions
+ * Add a forum to user's subscriptions.
+ *
  * @since 2.5.0 bbPress (r5156)
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $user_id Optional. User id
  * @param int $forum_id Optional. forum id
  * @return bool Always true
+ * @param int $user_id Optional. User id.
+ * @param int $forum_id Optional. forum id.
+ * @return bool Always true.
  */
 function bbp_add_user_forum_subscription( $user_id = 0, $forum_id = 0 ) {
 …
 /**
  * Add a topic to user's subscriptions
+ * Add a topic to user's subscriptions.
+ *
  * Note that both the User and Topic should be verified to exist before using
 …
  * @deprecated 2.6.0 bbPress (r6543)
+ *
  * @param int $user_id Optional. User id
  * @param int $topic_id Optional. Topic id
  * @return bool Always true
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ * @return bool Always true.
  */
 function bbp_add_user_topic_subscription( $user_id = 0, $topic_id = 0 ) {
 …
 /**
  * Handles the front end toggling of forum subscriptions
+ * Handles the front end toggling of forum subscriptions.
+ *
  * @since 2.5.0 bbPress (r5156)

trunk/src/includes/users/functions.php

-                      r7378
+                      r7380
 /**
  * bbPress User Functions
+ * bbPress User Functions.
+ *
  * @package bbPress
 …
 /**
  * Redirect back to $url when attempting to use the login page
+ * Redirect back to $url when attempting to use the login page.
+ *
  * @since 2.0.0 bbPress (r2815)
+ *
  * @param string $url The url
  * @param string $raw_url Raw url
  * @param object $user User object
+ * @param string $url The url.
+ * @param string $raw_url Raw url.
+ * @param object $user User object.
  */
 function bbp_redirect_login( $url = '', $raw_url = '', $user = '' ) {
 …
+ *
  * @return bool True if anonymous is allowed and user is not logged in, false if
  *               anonymous is not allowed or user is logged in
+ *               anonymous is not allowed or user is logged in.
  */
 function bbp_is_anonymous() {
 …
 /**
  * Echoes the values for current poster (uses WP comment cookies)
+ * Echoes the values for current poster (uses WP comment cookies).
+ *
  * @since 2.0.0 bbPress (r2734)
 …
+}
     /**
      * Get the cookies for current poster (uses WP comment cookies).
+     *
      * @since 2.0.0 bbPress (r2734)
+     *
      * @param string $key Optional. Which value to get? If not given, then
      *                     an array is returned.
+     * @return string|array Cookie(s) for current poster
      */
     function bbp_get_current_anonymous_user_data( $key = '' ) {
         // Array of allowed cookie names
         $cookie_names = array(
             'name'  => 'comment_author',
             'email' => 'comment_author_email',
             'url'   => 'comment_author_url',
             // Here just for the sake of them, use the above ones
             'comment_author'       => 'comment_author',
             'comment_author_email' => 'comment_author_email',
             'comment_author_url'   => 'comment_author_url',
         );
         // Get the current poster's info from the cookies
         $bbp_current_poster = wp_get_current_commenter();
         // Sanitize the cookie key being retrieved
         $key = sanitize_key( $key );
         // Maybe return a specific key
         if ( ! empty( $key ) && in_array( $key, array_keys( $cookie_names ), true ) ) {
             return $bbp_current_poster[ $cookie_names[ $key ] ];
+        }
         // Return all keys
         return $bbp_current_poster;
+    }
 /**
  * Set the cookies for current poster (uses WP comment cookies)
+/**
+ * Get the cookies for current poster (uses WP comment cookies).
+ *
+ * @since 2.0.0 bbPress (r2734)
+ *
+ * @param string $key Optional. Which value to get? If not given, then
+ *                     an array is returned.
+ * @return string|array Cookie(s) for current poster.
+ */
+function bbp_get_current_anonymous_user_data( $key = '' ) {
+    // Array of allowed cookie names
+    $cookie_names = array(
+        'name'  => 'comment_author',
+        'email' => 'comment_author_email',
+        'url'   => 'comment_author_url',
+        // Here just for the sake of them, use the above ones
+        'comment_author'       => 'comment_author',
+        'comment_author_email' => 'comment_author_email',
+        'comment_author_url'   => 'comment_author_url',
+    );
+    // Get the current poster's info from the cookies
+    $bbp_current_poster = wp_get_current_commenter();
+    // Sanitize the cookie key being retrieved
+    $key = sanitize_key( $key );
+    // Maybe return a specific key
+    if ( ! empty( $key ) && in_array( $key, array_keys( $cookie_names ), true ) ) {
+        return $bbp_current_poster[ $cookie_names[ $key ] ];
+    }
+    // Return all keys
+    return $bbp_current_poster;
+}
+/**
+ * Set the cookies for current poster (uses WP comment cookies).
+ *
  * @since 2.0.0 bbPress (r2734)
 …
  * @param array $anonymous_data Optional - if it's an anonymous post. Do not
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
+ *                              sanitized (see {@link bbp_filter_anonymous_post_data()}.
  */
 function bbp_set_current_anonymous_user_data( $anonymous_data = array() ) {
 …
 /**
  * Get the poster IP address
+ * Get the poster IP address.
+ *
  * @since 2.0.0 bbPress (r3120)
 …
 /**
  * Get the poster user agent
+ * Get the poster user agent.
+ *
  * @since 2.0.0 bbPress (r3446)
 …
 /**
  * Handles the front end user editing from POST requests
+ * Handles the front end user editing from POST requests.
+ *
  * @since 2.0.0 bbPress (r2790)
+ *
  * @param string $action The requested action to compare this function to
+ * @param string $action The requested action to compare this function to.
  */
 function bbp_edit_user_handler( $action = '' ) {
 …
 /**
  * Handles user email address updating from GET requests
+ * Handles user email address updating from GET requests.
+ *
  * @since 2.6.0 bbPress (r5660)
 …
 /**
  * Sends an email when an email address change occurs on POST requests
+ * Sends an email when an email address change occurs on POST requests.
+ *
  * @since 2.6.0 bbPress (r5660)
 …
 /**
  * Conditionally hook the core WordPress output actions to the end of the
  * default user's edit profile template
+ * default user's edit profile template.
+ *
  * This allows clever plugin authors to conditionally unhook the WordPress core
 …
 /**
  * Get the topics that a user created
+ * Get the topics that a user created.
+ *
  * @since 2.0.0 bbPress (r2660)
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
+ *
  * @param array $args    Optional. Arguments to pass into bbp_has_topics()
+ *
  * @return bool True if user has started topics, otherwise false
+ * @param array $args    Optional. Arguments to pass into bbp_has_topics().
+ *
+ * @return bool True if user has started topics, otherwise false.
  */
 function bbp_get_user_topics_started( $args = array() ) {
 …
 /**
  * Get the replies that a user created
+ * Get the replies that a user created.
+ *
  * @since 2.2.0 bbPress (r4225)
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
+ *
  * @param array $args Optional. Arguments to pass into bbp_has_replies()
+ *
  * @return bool True if user has created replies, otherwise false
+ * @param array $args Optional. Arguments to pass into bbp_has_replies().
+ *
+ * @return bool True if user has created replies, otherwise false.
  */
 function bbp_get_user_replies_created( $args = array() ) {
 …
 /**
  * Get user IDs from nicenames
+ *
  * This function is primarily used when saving object moderators
+ * Get user IDs from nicenames.
+ *
+ * This function is primarily used when saving object moderators.
+ *
  * @since 2.6.0 bbPress
 …
 /**
  * Get user nicenames from IDs
+ *
  * This function is primarily used when saving object moderators
+ * Get user nicenames from IDs.
+ *
+ * This function is primarily used when saving object moderators.
+ *
  * @since 2.6.0 bbPress
+ *
  * @param mixed $user_ids
+ * @param mixed $user_ids User ids.
  * @return array
  */
 …
 /**
  * Return the raw database count of topics by a user
+ * Return the raw database count of topics by a user.
+ *
  * @since 2.1.0 bbPress (r3633)
+ *
  * @param int $user_id User ID to get count for
+ *
  * @return int Raw DB count of topics
+ * @param int $user_id User ID to get count for.
+ *
+ * @return int Raw DB count of topics.
  */
 function bbp_get_user_topic_count_raw( $user_id = 0 ) {
 …
 /**
  * Return the raw database count of replies by a user
+ * Return the raw database count of replies by a user.
+ *
  * @since 2.1.0 bbPress (r3633)
+ *
  * @param int $user_id User ID to get count for
+ *
  * @return int Raw DB count of replies
+ * @param int $user_id User ID to get count for.
+ *
+ * @return int Raw DB count of replies.
  */
 function bbp_get_user_reply_count_raw( $user_id = 0 ) {
 …
  * @since 2.6.0 bbPress (r5309)
+ *
  * @param int $user_id
  * @param int $difference
+ * @param int $user_id    User id.
+ * @param int $difference Optional. Default 1. Number to bump.
  */
 function bbp_bump_user_topic_count( $user_id = 0, $difference = 1 ) {
 …
  * @since 2.6.0 bbPress (r5309)
+ *
  * @param int $user_id
  * @param int $difference
+ * @param int $user_id    User id.
+ * @param int $difference Optional. Default 1. Number to bump.
  */
 function bbp_bump_user_reply_count( $user_id = 0, $difference = 1 ) {
 …
  * a reply is published.
+ *
  * This is a helper function, hooked to `bbp_new_reply`
+ * This is a helper function, hooked to `bbp_new_reply`.
+ *
  * @since 2.6.0 bbPress (r5309)
 …
 /**
  * Redirect if unauthorized user is attempting to edit another user
+ * Redirect if unauthorized user is attempting to edit another user.
+ *
  * This is hooked to 'bbp_template_redirect' and controls the conditions under

trunk/src/includes/users/options.php

-                      r7378
+                      r7380
 /**
  * bbPress User Options
+ * bbPress User Options.
+ *
  * @package bbPress
 …
 /**
  * Get the default user options and their values
+ *
  * @since 2.1.0 bbPress (r3910)
+ *
  * @return array Filtered user option names and values
+ * Get the default user options and their values.
+ *
+ * @since 2.1.0 bbPress (r3910)
+ *
+ * @return array Filtered user option names and values.
  */
 function bbp_get_default_user_options() {
 …
 /**
  * Add default user options
+ * Add default user options.
+ *
  * This is destructive, so existing bbPress user options will be overridden.
 …
 /**
  * Delete default user options
+ * Delete default user options.
+ *
  * Hooked to bbp_uninstall, it is only called once when bbPress is uninstalled.
 …
  * @since 2.1.0 bbPress (r3910)
+ *
  * @param bool $value Optional. Default value false
  * @return mixed false if not overloaded, mixed if set
+ * @param bool $value Optional. Default value false.
+ * @return mixed false if not overloaded, mixed if set.
  */
 function bbp_filter_get_user_option( $value = false, $option = '', $user = 0 ) {
 …
 /**
  * Update the topic count for a user
+ * Update the topic count for a user.
+ *
  * @since 2.6.0 bbPress (r5309)
 …
 /**
  * Update the reply count for a user
+ * Update the reply count for a user.
+ *
  * @since 2.6.0 bbPress (r5309)
+ *
  * @param int $user_id
+ * @param int $user_id User id.
  * @param mixed $count
  * @return boolean
 …
 /**
  * Output a users topic count
+ *
  * @since 2.1.0 bbPress (r3632)
+ *
  * @param int $user_id
  * @param boolean $integer Optional. Whether or not to format the result
+ * Output a users topic count.
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id User id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ *
  * @return string
 …
     echo esc_html( bbp_get_user_topic_count( $user_id, $integer ) );
+}
+    /**
+     * Return a users reply count
+     *
+     * @since 2.1.0 bbPress (r3632)
+     *
+     * @param int $user_id
+     * @param boolean $integer Optional. Whether or not to format the result
+     *
+     * @return string
+     */
+    function bbp_get_user_topic_count( $user_id = 0, $integer = false ) {
+        // Validate user id
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        $count  = get_user_option( '_bbp_topic_count', $user_id );
+        $filter = ( true === $integer )
+            ? 'bbp_get_user_topic_count_int'
+            : 'bbp_get_user_topic_count';
+        // Filter & return
+        return apply_filters( $filter, $count, $user_id );
+    }
+/**
+ * Output a users reply count
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id
+ * @param boolean $integer Optional. Whether or not to format the result
+/**
+ * Return a users reply count.
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id User id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ *
+ * @return string
+ */
+function bbp_get_user_topic_count( $user_id = 0, $integer = false ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    $count  = get_user_option( '_bbp_topic_count', $user_id );
+    $filter = ( true === $integer )
+        ? 'bbp_get_user_topic_count_int'
+        : 'bbp_get_user_topic_count';
+    // Filter & return
+    return apply_filters( $filter, $count, $user_id );
+}
+/**
+ * Output a users reply count.
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id User id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ *
  * @return string
 …
     echo esc_html( bbp_get_user_reply_count( $user_id, $integer ) );
+}
+    /**
+     * Return a users reply count
+     *
+     * @since 2.1.0 bbPress (r3632)
+     *
+     * @param int $user_id
+     * @param boolean $integer Optional. Whether or not to format the result
+     *
+     * @return string
+     */
+    function bbp_get_user_reply_count( $user_id = 0, $integer = false ) {
+        // Validate user id
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        $count  = get_user_option( '_bbp_reply_count', $user_id );
+        $filter = ( true === $integer )
+            ? 'bbp_get_user_reply_count_int'
+            : 'bbp_get_user_reply_count';
+        return apply_filters( $filter, $count, $user_id );
+    }
+/**
+ * Output a users total post count
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id
+/**
+ * Return a users reply count.
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id User id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ *
+ * @return string
+ */
+function bbp_get_user_reply_count( $user_id = 0, $integer = false ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    $count  = get_user_option( '_bbp_reply_count', $user_id );
+    $filter = ( true === $integer )
+        ? 'bbp_get_user_reply_count_int'
+        : 'bbp_get_user_reply_count';
+    return apply_filters( $filter, $count, $user_id );
+}
+/**
+ * Output a users total post count.
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id User id.
  * @param boolean $integer Optional. Whether or not to format the result
+ *
 …
     echo esc_html( bbp_get_user_post_count( $user_id, $integer ) );
+}
+    /**
+     * Return a users total post count
+     *
+     * @since 2.1.0 bbPress (r3632)
+     *
+     * @param int $user_id
+     * @param boolean $integer Optional. Whether or not to format the result
+     *
+     * @return string
+     */
+    function bbp_get_user_post_count( $user_id = 0, $integer = false ) {
+        // Validate user id
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        $topics  = bbp_get_user_topic_count( $user_id, true );
+        $replies = bbp_get_user_reply_count( $user_id, true );
+        $count   = $topics + $replies;
+        $filter  = ( true === $integer )
+            ? 'bbp_get_user_post_count_int'
+            : 'bbp_get_user_post_count';
+        return apply_filters( $filter, $count, $user_id );
+    }
+/**
+ * Return a users total post count.
+ *
+ * @since 2.1.0 bbPress (r3632)
+ *
+ * @param int $user_id User id.
+ * @param boolean $integer Optional. Whether or not to format the result.
+ *
+ * @return string
+ */
+function bbp_get_user_post_count( $user_id = 0, $integer = false ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    $topics  = bbp_get_user_topic_count( $user_id, true );
+    $replies = bbp_get_user_reply_count( $user_id, true );
+    $count   = $topics + $replies;
+    $filter  = ( true === $integer )
+        ? 'bbp_get_user_post_count_int'
+        : 'bbp_get_user_post_count';
+    return apply_filters( $filter, $count, $user_id );
+}
 /** Last Posted ***************************************************************/
 /**
  * Update a users last posted time, for use with post throttling
+ *
  * @since 2.1.0 bbPress (r3910)
+ *
  * @param int $user_id User ID to update
  * @param int $time Time in time() format
  * @return bool False if no user or failure, true if successful
+ * Update a users last posted time, for use with post throttling.
+ *
+ * @since 2.1.0 bbPress (r3910)
+ *
+ * @param int $user_id User ID to update.
+ * @param int $time Time in time() format.
+ * @return bool False if no user or failure, true if successful.
  */
 function bbp_update_user_last_posted( $user_id = 0, $time = 0 ) {
 …
  * @since 2.1.0 bbPress (r3910)
+ *
  * @param int $user_id User ID to retrieve value for
+ * @param int $user_id User ID to retrieve value for.
  */
 function bbp_user_last_posted( $user_id = 0 ) {
 …
+}
     /**
      * Return the raw value of the last posted time.
+     *
      * @since 2.1.0 bbPress (r3910)
+     *
+     * @param int $user_id User ID to retrieve value for
+     * @return mixed False if no user, time() format if exists
      */
     function bbp_get_user_last_posted( $user_id = 0 ) {
         // Validate user id
         $user_id = bbp_get_user_id( $user_id );
         if ( empty( $user_id ) ) {
             return false;
+        }
         $time = get_user_option( '_bbp_last_posted', $user_id );
         // Filter & return
         return apply_filters( 'bbp_get_user_last_posted', $time, $user_id );
+    }
+/**
+ * Return the raw value of the last posted time.
+ *
+ * @since 2.1.0 bbPress (r3910)
+ *
+ * @param int $user_id User ID to retrieve value for.
+ * @return mixed False if no user, time() format if exists.
+ */
+function bbp_get_user_last_posted( $user_id = 0 ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    $time = get_user_option( '_bbp_last_posted', $user_id );
+    // Filter & return
+    return apply_filters( 'bbp_get_user_last_posted', $time, $user_id );
+}

trunk/src/includes/users/signups.php

-                      r7361
+                      r7380
 /**
  * Output the forum-role field when adding a new user
+ * Output the forum-role field when adding a new user.
+ *
  * @since 2.6.0 bbPress (r6674)
 …
 /**
  * Maybe add forum role to signup meta array
+ *
  * @since 2.6.0 bbPress (r6674)
+ *
  * @param array $meta
+ * Maybe add forum role to signup meta array.
+ *
+ * @since 2.6.0 bbPress (r6674)
+ *
+ * @param array $meta The signup meta.
+ *
  * @return array
 …
 /**
  * Add forum meta data when inviting a user to a site
+ * Add forum meta data when inviting a user to a site.
+ *
  * @since 2.6.0 bbPress (r6674)
 …
 /**
  * Single-site handler for adding a new user
+ *
  * @since 2.6.0 bbPress (r6674)
+ *
+ * @param int $user_id
+ * Single-site handler for adding a new user.
+ *
+ * @since 2.6.0 bbPress (r6674)
+ *
+* @param int $user_id The user ID.
+ *
  * @return void
 …
 /**
  * Multi-site handler for adding a new user
+ *
  * @since 2.6.0 bbPress (r6674)
+ *
  * @param int    $user_id  User ID
  * @param string $password User password
  * @param array  $meta     Array of metadata
+ * Multi-site handler for adding a new user.
+ *
+ * @since 2.6.0 bbPress (r6674)
+ *
+ * @param int    $user_id  User ID.
+ * @param string $password User password.
+ * @param array  $meta     Array of metadata.
+ *
  * @return void
 …
  * @since 2.6.5
+ *
  * @param string $to_validate A role ID to validate
+ *
  * @return string A valid role ID, or empty string on error
+ * @param string $to_validate A role ID to validate.
+ *
+ * @return string A valid role ID, or empty string on error.
  */
 function bbp_validate_signup_role( $to_validate = '' ) {
 …
 /**
  * Validate the Forum role during the registration process
+ * Validate the Forum role during the registration process.
+ *
  * @since 2.6.5
+ *
  * @param string $to_validate A role ID to validate
+ *
  * @return string A valid role ID, or empty string on error
+ * @param string $to_validate A role ID to validate.
+ *
+ * @return string A valid role ID, or empty string on error.
  */
 function bbp_validate_registration_role( $to_validate = '' ) {
 …
 /**
  * Validate the Forum role during multisite activation
+ * Validate the Forum role during multisite activation.
+ *
  * This function exists simply for parity with registrations, and to maintain an
 …
  * @since 2.6.5
+ *
  * @param string $to_validate A role ID to validate
+ *
  * @return string A valid role ID, or empty string on error
+ * @param string $to_validate A role ID to validate.
+ *
+ * @return string A valid role ID, or empty string on error.
  */
 function bbp_validate_activation_role( $to_validate = '' ) {

trunk/src/includes/users/template.php

-                      r7378
+                      r7380
 /**
  * bbPress User Template Tags
+ * bbPress User Template Tags.
+ *
  * @package bbPress
 …
 /**
  * Extension of WP_User_Query to allow easy looping
+ * Extension of WP_User_Query to allow easy looping.
+ *
  * @since 2.6.0 bbPress (r6330)
 …
  * @since 2.6.0 bbPress (r6330)
+ *
  * @param array $args All the arguments supported by {@link WP_User_Query}
  * @return object Multidimensional array of user information
+ * @param array $args All the arguments supported by {@link WP_User_Query}.
+ * @return object Multidimensional array of user information.
  */
 function bbp_has_users( $args = array() ) {
 …
 /**
  * Whether there are more users available in the loop
+ * Whether there are more users available in the loop.
+ *
  * @since 2.6.0 bbPress (r2464)
+ *
  * @return object User information
+ * @return object User information.
  */
 function bbp_users() {
 …
 /**
  * Loads up the current user in the loop
+ * Loads up the current user in the loop.
+ *
  * @since 2.6.0 bbPress (r2464)
+ *
  * @return object User information
+ * @return object User information.
  */
 function bbp_the_user() {
 …
 /**
  * Output a validated user id
+ * Output a validated user id.
+ *
  * @since 2.0.0 bbPress (r2729)
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  * @param bool $displayed_user_fallback Fallback on displayed user?
  * @param bool $current_user_fallback Fallback on current user?
 …
     echo bbp_get_user_id( $user_id, $displayed_user_fallback, $current_user_fallback );
+}
+    /**
+     * Return a validated user id
+     *
+     * @since 2.0.0 bbPress (r2729)
+     *
+     * @param int $user_id Optional. User id
+     * @param bool $displayed_user_fallback Fallback on displayed user?
+     * @param bool $current_user_fallback Fallback on current user?
+     * @return int Validated user id
+     */
+    function bbp_get_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
+        $bbp = bbpress();
+        // Easy empty checking
+        if ( ! empty( $user_id ) && is_numeric( $user_id ) ) {
+            $bbp_user_id = $user_id;
+        // Currently inside a user loop
+        } elseif ( ! empty( $bbp->user_query->in_the_loop ) && isset( $bbp->user_query->user->ID ) ) {
+            $bbp_user_id = $bbp->user_query->user->ID;
+        // Currently viewing or editing a user
+        } elseif ( ( true === $displayed_user_fallback ) && ! empty( $bbp->displayed_user->ID ) ) {
+            $bbp_user_id = $bbp->displayed_user->ID;
+        // Maybe fallback on the current_user ID
+        } elseif ( ( true === $current_user_fallback ) && ! empty( $bbp->current_user->ID ) ) {
+            $bbp_user_id = $bbp->current_user->ID;
+        // Failsafe
+        } else {
+            $bbp_user_id = 0;
+        }
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_user_id', (int) $bbp_user_id, $displayed_user_fallback, $current_user_fallback );
+    }
+/**
+ * Output ID of current user
+/**
+ * Return a validated user id.
+ *
+ * @since 2.0.0 bbPress (r2729)
+ *
+ * @param int $user_id Optional. User id.
+ * @param bool $displayed_user_fallback Fallback on displayed user?
+ * @param bool $current_user_fallback Fallback on current user?
+ * @return int Validated user id.
+ */
+function bbp_get_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
+    $bbp = bbpress();
+    // Easy empty checking
+    if ( ! empty( $user_id ) && is_numeric( $user_id ) ) {
+        $bbp_user_id = $user_id;
+    // Currently inside a user loop
+    } elseif ( ! empty( $bbp->user_query->in_the_loop ) && isset( $bbp->user_query->user->ID ) ) {
+        $bbp_user_id = $bbp->user_query->user->ID;
+    // Currently viewing or editing a user
+    } elseif ( ( true === $displayed_user_fallback ) && ! empty( $bbp->displayed_user->ID ) ) {
+        $bbp_user_id = $bbp->displayed_user->ID;
+    // Maybe fallback on the current_user ID
+    } elseif ( ( true === $current_user_fallback ) && ! empty( $bbp->current_user->ID ) ) {
+        $bbp_user_id = $bbp->current_user->ID;
+    // Failsafe
+    } else {
+        $bbp_user_id = 0;
+    }
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_user_id', (int) $bbp_user_id, $displayed_user_fallback, $current_user_fallback );
+}
+/**
+ * Output ID of current user.
+ *
  * @since 2.0.0 bbPress (r2574)
 …
     echo bbp_get_current_user_id();
+}
+    /**
+     * Return ID of current user
+     *
+     * @since 2.0.0 bbPress (r2574)
+     *
+     * @return int Current user id
+     */
+    function bbp_get_current_user_id() {
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_current_user_id', bbp_get_user_id( 0, false, true ) );
+    }
+/**
+ * Output ID of displayed user
+/**
+ * Return ID of current user.
+ *
+ * @since 2.0.0 bbPress (r2574)
+ *
+ * @return int Current user id.
+ */
+function bbp_get_current_user_id() {
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_current_user_id', bbp_get_user_id( 0, false, true ) );
+}
+/**
+ * Output ID of displayed user.
+ *
  * @since 2.0.0 bbPress (r2688)
 …
     echo bbp_get_displayed_user_id();
+}
+    /**
+     * Return ID of displayed user
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @return int Displayed user id
+     */
+    function bbp_get_displayed_user_id() {
+        // Filter & return
+        return apply_filters( 'bbp_get_displayed_user_id', bbp_get_user_id( 0, true, false ) );
+    }
+/**
+ * Output a sanitized user field value
+/**
+ * Return ID of displayed user.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @return int Displayed user id.
+ */
+function bbp_get_displayed_user_id() {
+    // Filter & return
+    return apply_filters( 'bbp_get_displayed_user_id', bbp_get_user_id( 0, true, false ) );
+}
+/**
+ * Output a sanitized user field value.
+ *
  * This function relies on the $filter parameter to decide how to sanitize
 …
  * @since 2.0.0 bbPress (r2688)
+ *
  * @param string $field Field to get
  * @param string $filter How to filter the field value (null|raw|db|display|edit)
+ * @param string $field Field to get.
+ * @param string $filter How to filter the field value (null|raw|db|display|edit).
  */
 function bbp_displayed_user_field( $field = '', $filter = 'display' ) {
     echo bbp_get_displayed_user_field( $field, $filter );
+}
+    /**
+     * Return a sanitized user field value
+     *
+     * This function relies on the $filter parameter to decide how to sanitize
+     * the field value that it finds. Since it uses the WP_User object's magic
+     * __get() method, it can also be used to get user_meta values.
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @param string $field Field to get
+     * @param string $filter How to filter the field value (null|raw|db|display|edit)
+     * @see WP_User::__get() for more on how the value is retrieved
+     * @see sanitize_user_field() for more on how the value is sanitized
+     * @return string|bool Value of the field if it exists, else false
+     */
+    function bbp_get_displayed_user_field( $field = '', $filter = 'display' ) {
+        // Get the displayed user
+        $user         = bbpress()->displayed_user;
+        // Juggle the user filter property because we don't want to muck up how
+        // other code might interact with this object.
+        $old_filter   = $user->filter;
+        $user->filter = $filter;
+        // Get the field value from the WP_User object. We don't need to perform
+        // an isset() because the WP_User::__get() does it for us.
+        $value        = $user->$field;
+        // Put back the user filter property that was previously juggled above.
+        $user->filter = $old_filter;
+        // Filter & return
+        return apply_filters( 'bbp_get_displayed_user_field', $value, $field, $filter );
+    }
+/**
+ * Output name of current user
+/**
+ * Return a sanitized user field value.
+ *
+ * This function relies on the $filter parameter to decide how to sanitize
+ * the field value that it finds. Since it uses the WP_User object's magic
+ * __get() method, it can also be used to get user_meta values.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @see WP_User::__get() for more on how the value is retrieved.
+ * @see sanitize_user_field() for more on how the value is sanitized.
+ *
+ * @param string $field Field to get.
+ * @param string $filter How to filter the field value (null|raw|db|display|edit).
+ * @return string|bool Value of the field if it exists, else false.
+ */
+function bbp_get_displayed_user_field( $field = '', $filter = 'display' ) {
+    // Get the displayed user
+    $user         = bbpress()->displayed_user;
+    // Juggle the user filter property because we don't want to muck up how
+    // other code might interact with this object.
+    $old_filter   = $user->filter;
+    $user->filter = $filter;
+    // Get the field value from the WP_User object. We don't need to perform
+    // an isset() because the WP_User::__get() does it for us.
+    $value        = $user->$field;
+    // Put back the user filter property that was previously juggled above.
+    $user->filter = $old_filter;
+    // Filter & return
+    return apply_filters( 'bbp_get_displayed_user_field', $value, $field, $filter );
+}
+/**
+ * Output name of current user.
+ *
  * @since 2.0.0 bbPress (r2574)
 …
     echo esc_attr( bbp_get_current_user_name() );
+}
+    /**
+     * Return name of current user
+     *
+     * @since 2.0.0 bbPress (r2574)
+     *
+     * @return string
+     */
+    function bbp_get_current_user_name() {
+        // Default current user name
+        $default = bbp_get_fallback_display_name();
+        // Check the $user_identity global
+        $current_user_name = is_user_logged_in()
+            ? bbp_get_global_object( 'user_identity', false, $default )
+            : $default;
+        // Filter & return
+        return apply_filters( 'bbp_get_current_user_name', $current_user_name );
+    }
+/**
+ * Output avatar of current user
+/**
+ * Return name of current user.
+ *
  * @since 2.0.0 bbPress (r2574)
+ *
+ * @param int $size Size of the avatar. Defaults to 40
+ * @return string
+ */
+function bbp_get_current_user_name() {
+    // Default current user name
+    $default = bbp_get_fallback_display_name();
+    // Check the $user_identity global
+    $current_user_name = is_user_logged_in()
+        ? bbp_get_global_object( 'user_identity', false, $default )
+        : $default;
+    // Filter & return
+    return apply_filters( 'bbp_get_current_user_name', $current_user_name );
+}
+/**
+ * Output avatar of current user.
+ *
+ * @since 2.0.0 bbPress (r2574)
+ *
+ * @param int $size Size of the avatar. Defaults to 40.
  */
 function bbp_current_user_avatar( $size = 40 ) {
 …
+}
     /**
+     * Return avatar of current user
+     *
      * @since 2.0.0 bbPress (r2574)
+     *
+     * @param int $size Size of the avatar. Defaults to 40
+     * @return string Current user avatar
      */
     function bbp_get_current_user_avatar( $size = 40 ) {
         $user = bbp_get_current_user_id();
         if ( empty( $user ) ) {
             $user = bbp_get_current_anonymous_user_data( 'email' );
+        }
         $avatar = get_avatar( $user, $size );
         // Filter & return
         return apply_filters( 'bbp_get_current_user_avatar', $avatar, $size );
+    }
 /**
  * Output link to the profile page of a user
+/**
+ * Return avatar of current user.
+ *
+ * @since 2.0.0 bbPress (r2574)
+ *
+ * @param int $size Size of the avatar. Defaults to 40.
+ * @return string Current user avatar.
+ */
+function bbp_get_current_user_avatar( $size = 40 ) {
+    $user = bbp_get_current_user_id();
+    if ( empty( $user ) ) {
+        $user = bbp_get_current_anonymous_user_data( 'email' );
+    }
+    $avatar = get_avatar( $user, $size );
+    // Filter & return
+    return apply_filters( 'bbp_get_current_user_avatar', $avatar, $size );
+}
+/**
+ * Output link to the profile page of a user.
+ *
  * @since 2.0.0 bbPress (r2688)
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_user_profile_link( $user_id = 0 ) {
     echo bbp_get_user_profile_link( $user_id );
+}
+    /**
+     * Return link to the profile page of a user
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @param int $user_id Optional. User id
+     * @return string User profile link
+     */
+    function bbp_get_user_profile_link( $user_id = 0 ) {
+        // Validate user id
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Get the user
+        $user = get_userdata( $user_id );
+        if ( empty( $user ) ) {
+            return false;
+        }
+        // Display Name
+        $name = ! empty( $user->display_name )
+            ? $user->display_name
+            : bbp_get_fallback_display_name();
+        // URL
+        $url = bbp_get_user_profile_url( $user_id );
+        // Link
+        $link = ! empty( $url )
+            ? '<a href="' . esc_url( $url ) . '">' . esc_html( $name ) . '</a>'
+            : esc_html( $name );
+        // Filter & return
+        return (string) apply_filters( 'bbp_get_user_profile_link', $link, $user_id );
+    }
+/**
+ * Output a users nicename to the screen
+/**
+ * Return link to the profile page of a user.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @param int $user_id Optional. User id.
+ * @return string User profile link.
+ */
+function bbp_get_user_profile_link( $user_id = 0 ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Get the user
+    $user = get_userdata( $user_id );
+    if ( empty( $user ) ) {
+        return false;
+    }
+    // Display Name
+    $name = ! empty( $user->display_name )
+        ? $user->display_name
+        : bbp_get_fallback_display_name();
+    // URL
+    $url = bbp_get_user_profile_url( $user_id );
+    // Link
+    $link = ! empty( $url )
+        ? '<a href="' . esc_url( $url ) . '">' . esc_html( $name ) . '</a>'
+        : esc_html( $name );
+    // Filter & return
+    return (string) apply_filters( 'bbp_get_user_profile_link', $link, $user_id );
+}
+/**
+ * Output a users nicename to the screen.
+ *
  * @since 2.3.0 bbPress (r4671)
+ *
  * @param int $user_id User ID whose nicename to get
  * @param array $args before|after|user_id|force
+ * @param int $user_id User ID whose nicename to get.
+ * @param array $args before|after|user_id|force.
  */
 function bbp_user_nicename( $user_id = 0, $args = array() ) {
     echo bbp_get_user_nicename( $user_id, $args );
+}
+    /**
+     * Return a users nicename to the screen
+     *
+     * @since 2.3.0 bbPress (r4671)
+     *
+     * @param int $user_id User ID whose nicename to get
+     * @param array $args before|after|user_id|force
+     * @return string User nicename, maybe wrapped in before/after strings
+     */
+    function bbp_get_user_nicename( $user_id = 0, $args = array() ) {
+        // Bail if no user ID passed
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Parse default arguments
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'user_id' => $user_id,
+                'before'  => '',
+                'after'   => '',
+                'force'   => ''
+            ),
+            'get_user_nicename'
+        );
+        // Force the nicename (likely from a previous user query)
+        if ( ! empty( $r['force'] ) ) {
+            $nicename = (string) $r['force'];
+        // Maybe fallback to getting the nicename from user data
+        } elseif ( ! empty( $r['user_id'] ) ) {
+            $user     = get_userdata( $r['user_id'] );
+            $nicename = ! empty( $user )
+                ? $user->user_nicename
+                : '';
+        // Maybe fallback to empty string so filter still applies
+        } else {
+            $nicename = '';
+        }
+        // Maybe wrap the nicename
+        $retval = ! empty( $nicename )
+            ? $r['before'] . esc_html( $nicename ) . $r['after']
+/**
+ * Return a users nicename to the screen.
+ *
+ * @since 2.3.0 bbPress (r4671)
+ *
+ * @param int $user_id User ID whose nicename to get.
+ * @param array $args before|after|user_id|force.
+ * @return string User nicename, maybe wrapped in before/after strings.
+ */
+function bbp_get_user_nicename( $user_id = 0, $args = array() ) {
+    // Bail if no user ID passed
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Parse default arguments
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'user_id' => $user_id,
+            'before'  => '',
+            'after'   => '',
+            'force'   => ''
+        ),
+        'get_user_nicename'
+    );
+    // Force the nicename (likely from a previous user query)
+    if ( ! empty( $r['force'] ) ) {
+        $nicename = (string) $r['force'];
+    // Maybe fallback to getting the nicename from user data
+    } elseif ( ! empty( $r['user_id'] ) ) {
+        $user     = get_userdata( $r['user_id'] );
+        $nicename = ! empty( $user )
+            ? $user->user_nicename
             : '';
+        // Filter & return
+        return (string) apply_filters( 'bbp_get_user_nicename', $retval, $user_id, $r, $args );
+    }
+/**
+ * Output URL to the profile page of a user
+    // Maybe fallback to empty string so filter still applies
+    } else {
+        $nicename = '';
+    }
+    // Maybe wrap the nicename
+    $retval = ! empty( $nicename )
+        ? $r['before'] . esc_html( $nicename ) . $r['after']
+        : '';
+    // Filter & return
+    return (string) apply_filters( 'bbp_get_user_nicename', $retval, $user_id, $r, $args );
+}
+/**
+ * Output URL to the profile page of a user.
+ *
  * @since 2.0.0 bbPress (r2688)
+ *
  * @param int $user_id Optional. User id
  * @param string $user_nicename Optional. User nicename
+ * @param int $user_id Optional. User id.
+ * @param string $user_nicename Optional. User nicename.
  */
 function bbp_user_profile_url( $user_id = 0, $user_nicename = '' ) {
     echo esc_url( bbp_get_user_profile_url( $user_id, $user_nicename ) );
+}
+    /**
+     * Return URL to the profile page of a user
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @param int $user_id Optional. User id
+     * @param string $user_nicename Optional. User nicename
+     * @return string User profile url
+     */
+    function bbp_get_user_profile_url( $user_id = 0, $user_nicename = '' ) {
+        // Use displayed user ID if there is one, and one isn't requested
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+/**
+ * Return URL to the profile page of a user.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @param int $user_id Optional. User id.
+ * @param string $user_nicename Optional. User nicename.
+ * @return string User profile url.
+ */
+function bbp_get_user_profile_url( $user_id = 0, $user_nicename = '' ) {
+    // Use displayed user ID if there is one, and one isn't requested
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_url', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        // Get username if not passed
+        if ( empty( $user_nicename ) ) {
+            $user_nicename = bbp_get_user_nicename( $user_id );
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        }
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            // Get username if not passed
+            if ( empty( $user_nicename ) ) {
+                $user_nicename = bbp_get_user_nicename( $user_id );
+            }
+            // Run through home_url()
+            $url = trailingslashit( bbp_get_root_url() . bbp_get_user_slug() ) . $user_nicename;
+            $url = user_trailingslashit( $url );
+            $url = home_url( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_user_rewrite_id() => $user_id
+                ),
+                home_url( '/' )
+            );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_profile_url', $url, $user_id, $user_nicename );
+    }
+/**
+ * Output link to the profile edit page of a user
+        // Run through home_url()
+        $url = trailingslashit( bbp_get_root_url() . bbp_get_user_slug() ) . $user_nicename;
+        $url = user_trailingslashit( $url );
+        $url = home_url( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_user_rewrite_id() => $user_id
+            ),
+            home_url( '/' )
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_profile_url', $url, $user_id, $user_nicename );
+}
+/**
+ * Output link to the profile edit page of a user.
+ *
  * @since 2.0.0 bbPress (r2688)
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_user_profile_edit_link( $user_id = 0 ) {
     echo bbp_get_user_profile_edit_link( $user_id );
+}
+    /**
+     * Return link to the profile edit page of a user
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @param int $user_id Optional. User id
+     * @return string User profile edit link
+     */
+    function bbp_get_user_profile_edit_link( $user_id = 0 ) {
+        // Validate user id
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Get the user
+        $user = get_userdata( $user_id );
+        if ( empty( $user ) ) {
+            return false;
+        }
+        // Display Name
+        $name = ! empty( $user->display_name )
+            ? $user->display_name
+            : bbp_get_fallback_display_name();
+        // URL
+        $url = bbp_get_user_profile_edit_url( $user_id );
+        // Link
+        $link = ! empty( $url )
+            ? '<a href="' . esc_url( $url ) . '">' . esc_html( $name ) . '</a>'
+            : esc_html( $name );
+        // Filter & return
+        return (string) apply_filters( 'bbp_get_user_profile_edit_link', $link, $user_id );
+    }
+/**
+ * Output URL to the profile edit page of a user
+/**
+ * Return link to the profile edit page of a user.
+ *
  * @since 2.0.0 bbPress (r2688)
+ *
+ * @param int $user_id Optional. User id
+ * @param string $user_nicename Optional. User nicename
+ * @param int $user_id Optional. User id.
+ * @return string User profile edit link.
+ */
+function bbp_get_user_profile_edit_link( $user_id = 0 ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Get the user
+    $user = get_userdata( $user_id );
+    if ( empty( $user ) ) {
+        return false;
+    }
+    // Display Name
+    $name = ! empty( $user->display_name )
+        ? $user->display_name
+        : bbp_get_fallback_display_name();
+    // URL
+    $url = bbp_get_user_profile_edit_url( $user_id );
+    // Link
+    $link = ! empty( $url )
+        ? '<a href="' . esc_url( $url ) . '">' . esc_html( $name ) . '</a>'
+        : esc_html( $name );
+    // Filter & return
+    return (string) apply_filters( 'bbp_get_user_profile_edit_link', $link, $user_id );
+}
+/**
+ * Output URL to the profile edit page of a user.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @param int $user_id Optional. User id.
+ * @param string $user_nicename Optional. User nicename.
  */
 function bbp_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
     echo esc_url( bbp_get_user_profile_edit_url( $user_id, $user_nicename ) );
+}
+    /**
+     * Return URL to the profile edit page of a user
+     *
+     * @since 2.0.0 bbPress (r2688)
+     *
+     * @param int $user_id Optional. User id
+     * @param string $user_nicename Optional. User nicename
+     * @return string
+     */
+    function bbp_get_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_edit_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        }
+        // Get user profile URL
+        $profile_url = bbp_get_user_profile_url( $user_id, $user_nicename );
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            $url = trailingslashit( $profile_url ) . bbp_get_edit_slug();
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_edit_rewrite_id() => '1'
+                ),
+                $profile_url
+            );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_edit_profile_url', $url, $user_id, $user_nicename );
+    }
+/**
+ * Output a user's main role for display
+/**
+ * Return URL to the profile edit page of a user.
+ *
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @param int $user_id Optional. User id.
+ * @param string $user_nicename Optional. User nicename.
+ * @return string
+ */
+function bbp_get_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_edit_url', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Get user profile URL
+    $profile_url = bbp_get_user_profile_url( $user_id, $user_nicename );
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        $url = trailingslashit( $profile_url ) . bbp_get_edit_slug();
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_edit_rewrite_id() => '1'
+            ),
+            $profile_url
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_edit_profile_url', $url, $user_id, $user_nicename );
+}
+/**
+ * Output a user's main role for display.
+ *
  * @since 2.1.0 bbPress (r3860)
+ *
  * @param int $user_id
+ * @param int $user_id User id.
  */
 function bbp_user_display_role( $user_id = 0 ) {
     echo esc_attr( bbp_get_user_display_role( $user_id ) );
+}
+    /**
+     * Return a user's main role for display
+     *
+     * @since 2.1.0 bbPress (r3860)
+     *
+     * @param int $user_id
+     * @return string
+     */
+    function bbp_get_user_display_role( $user_id = 0 ) {
+        // Validate user id
+        $user_id = bbp_get_user_id( $user_id );
+        // User is not registered
+        if ( empty( $user_id ) ) {
+            $role = esc_html__( 'Guest', 'bbpress' );
+        // User is not active
+        } elseif ( bbp_is_user_inactive( $user_id ) ) {
+            $role = esc_html__( 'Inactive', 'bbpress' );
+        // User have a role
+        } else {
+            $role_id = bbp_get_user_role( $user_id );
+            $role    = bbp_get_dynamic_role_name( $role_id );
+        }
+        // No role found so default to generic "Member"
+        if ( empty( $role ) ) {
+            $role = esc_html__( 'Member', 'bbpress' );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_display_role', $role, $user_id );
+    }
+/**
+ * Output the link to the admin section
+/**
+ * Return a user's main role for display.
+ *
+ * @since 2.1.0 bbPress (r3860)
+ *
+ * @param int $user_id User id.
+ * @return string
+ */
+function bbp_get_user_display_role( $user_id = 0 ) {
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    // User is not registered
+    if ( empty( $user_id ) ) {
+        $role = esc_html__( 'Guest', 'bbpress' );
+    // User is not active
+    } elseif ( bbp_is_user_inactive( $user_id ) ) {
+        $role = esc_html__( 'Inactive', 'bbpress' );
+    // User have a role
+    } else {
+        $role_id = bbp_get_user_role( $user_id );
+        $role    = bbp_get_dynamic_role_name( $role_id );
+    }
+    // No role found so default to generic "Member"
+    if ( empty( $role ) ) {
+        $role = esc_html__( 'Member', 'bbpress' );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_display_role', $role, $user_id );
+}
+/**
+ * Output the link to the admin section.
+ *
  * @since 2.0.0 bbPress (r2827)
+ *
  * @param array $args Optional. See {@link bbp_get_admin_link()}
+ * @param array $args Optional. See {@link bbp_get_admin_link()}.
  */
 function bbp_admin_link( $args = array() ) {
     echo bbp_get_admin_link( $args );
+}
+    /**
+     * Return the link to the admin section
+     *
+     * @since 2.0.0 bbPress (r2827)
+     *
+     * @param array $args Optional. This function supports these arguments:
+     *  - text: The text
+     *  - before: Before the lnk
+     *  - after: After the link
+     * @return The link
+     */
+    function bbp_get_admin_link( $args = array() ) {
+        // Bail if user cannot globally moderate
+        if ( ! current_user_can( 'moderate' ) ) {
+            return;
+        }
+        if ( ! empty( $args ) && is_string( $args ) && ( false === strpos( $args, '=' ) ) ) {
+            $args = array( 'text' => $args );
+        }
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'text'   => esc_html__( 'Admin', 'bbpress' ),
+                'before' => '',
+                'after'  => ''
+            ),
+            'get_admin_link'
+        );
+        $retval = $r['before'] . '<a href="' . esc_url( admin_url() ) . '">' . $r['text'] . '</a>' . $r['after'];
+        // Filter & return
+        return apply_filters( 'bbp_get_admin_link', $retval, $r, $args );
+    }
+/**
+ * Return the link to the admin section.
+ *
+ * @since 2.0.0 bbPress (r2827)
+ *
+ * @param array $args Optional. This function supports these arguments:
+ *  - text: The text
+ *  - before: Before the lnk
+ *  - after: After the link
+ * @return The link.
+ */
+function bbp_get_admin_link( $args = array() ) {
+    // Bail if user cannot globally moderate
+    if ( ! current_user_can( 'moderate' ) ) {
+        return;
+    }
+    if ( ! empty( $args ) && is_string( $args ) && ( false === strpos( $args, '=' ) ) ) {
+        $args = array( 'text' => $args );
+    }
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'text'   => esc_html__( 'Admin', 'bbpress' ),
+            'before' => '',
+            'after'  => ''
+        ),
+        'get_admin_link'
+    );
+    $retval = $r['before'] . '<a href="' . esc_url( admin_url() ) . '">' . $r['text'] . '</a>' . $r['after'];
+    // Filter & return
+    return apply_filters( 'bbp_get_admin_link', $retval, $r, $args );
+}
 /** User IP *******************************************************************/
 /**
  * Output the author IP address of a post
+ * Output the author IP address of a post.
+ *
  * @since 2.0.0 bbPress (r3120)
 …
     echo bbp_get_author_ip( $args );
+}
+    /**
+     * Return the author IP address of a post
+     *
+     * @since 2.0.0 bbPress (r3120)
+     *
+     * @param array $args Optional. If an integer, it is used as reply id.
+     * @return string Author link of reply
+     */
+    function bbp_get_author_ip( $args = array() ) {
+        // Used as post id
+        $post_id = is_numeric( $args ) ? (int) $args : 0;
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'post_id' => $post_id,
+                'before'  => '<span class="bbp-author-ip">(',
+                'after'   => ')</span>'
+            ),
+            'get_author_ip'
+        );
+        // Get the author IP meta value
+        $author_ip = get_post_meta( $r['post_id'], '_bbp_author_ip', true );
+        $author_ip = ! empty( $author_ip )
+            ? $r['before'] . esc_html( $author_ip ) . $r['after']
+            : '';
+        // Filter & return
+        return apply_filters( 'bbp_get_author_ip', $author_ip, $r, $args );
+    }
+/**
+ * Return the author IP address of a post.
+ *
+ * @since 2.0.0 bbPress (r3120)
+ *
+ * @param array $args Optional. If an integer, it is used as reply id.
+ * @return string Author link of reply.
+ */
+function bbp_get_author_ip( $args = array() ) {
+    // Used as post id
+    $post_id = is_numeric( $args ) ? (int) $args : 0;
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'post_id' => $post_id,
+            'before'  => '<span class="bbp-author-ip">(',
+            'after'   => ')</span>'
+        ),
+        'get_author_ip'
+    );
+    // Get the author IP meta value
+    $author_ip = get_post_meta( $r['post_id'], '_bbp_author_ip', true );
+    $author_ip = ! empty( $author_ip )
+        ? $r['before'] . esc_html( $author_ip ) . $r['after']
+        : '';
+    // Filter & return
+    return apply_filters( 'bbp_get_author_ip', $author_ip, $r, $args );
+}
 /** Anonymous Fields **********************************************************/
 …
  * @since 2.6.0 bbPress (r6561)
+ *
  * @param int $object_id For additional context only, usually a post ID
+ * @param int $object_id For additional context only, usually a post ID.
+ *
  * @return string
 …
  * @since 2.5.0 bbPress (r5119)
+ *
  * @param int $post_id
+ * @param int $post_id Post id.
  */
 function bbp_author_display_name( $post_id = 0 ) {
 …
+}
     /**
      * Return the author display-name of a topic or reply.
+     *
      * Convenience function to ensure proper template functions are called
      * and correct filters are executed. Used primarily to display topic
      * and reply author information in the anonymous form template-part.
+     *
      * @since 2.5.0 bbPress (r5119)
+     *
+     * @param int $post_id
+     *
+     * @return string The name of the author
      */
     function bbp_get_author_display_name( $post_id = 0 ) {
         // Define local variable(s)
         $retval = '';
         // Topic edit
         if ( bbp_is_topic_edit() ) {
             $retval = bbp_get_topic_author_display_name( $post_id );
         // Reply edit
         } elseif ( bbp_is_reply_edit() ) {
             $retval = bbp_get_reply_author_display_name( $post_id );
         // Not an edit, so rely on current user cookie data
         } else {
             $retval = bbp_get_current_anonymous_user_data( 'name' );
+        }
         // Filter & return
         return apply_filters( 'bbp_get_author_display_name', $retval, $post_id );
+    }
+/**
+ * Return the author display-name of a topic or reply.
+ *
+ * Convenience function to ensure proper template functions are called
+ * and correct filters are executed. Used primarily to display topic
+ * and reply author information in the anonymous form template-part.
+ *
+ * @since 2.5.0 bbPress (r5119)
+ *
+ * @param int $post_id Post id.
+ *
+ * @return string The name of the author.
+ */
+function bbp_get_author_display_name( $post_id = 0 ) {
+    // Define local variable(s)
+    $retval = '';
+    // Topic edit
+    if ( bbp_is_topic_edit() ) {
+        $retval = bbp_get_topic_author_display_name( $post_id );
+    // Reply edit
+    } elseif ( bbp_is_reply_edit() ) {
+        $retval = bbp_get_reply_author_display_name( $post_id );
+    // Not an edit, so rely on current user cookie data
+    } else {
+        $retval = bbp_get_current_anonymous_user_data( 'name' );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_author_display_name', $retval, $post_id );
+}
 /**
 …
  * @since 2.5.0 bbPress (r5119)
+ *
  * @param int $post_id
+ * @param int $post_id Post id.
  */
 function bbp_author_email( $post_id = 0 ) {
 …
+}
+    /**
+     * Return the author email of a topic or reply.
+     *
+     * Convenience function to ensure proper template functions are called
+     * and correct filters are executed. Used primarily to display topic
+     * and reply author information in the anonymous user form template-part.
+     *
+     * @since 2.5.0 bbPress (r5119)
+     *
+     * @param int $post_id
+     *
+     * @return string The email of the author
+     */
+    function bbp_get_author_email( $post_id = 0 ) {
+        // Define local variable(s)
+        $retval = '';
+        // Topic edit
+        if ( bbp_is_topic_edit() ) {
+            $retval = bbp_get_topic_author_email( $post_id );
+        // Reply edit
+        } elseif ( bbp_is_reply_edit() ) {
+            $retval = bbp_get_reply_author_email( $post_id );
+        // Not an edit, so rely on current user cookie data
+        } else {
+            $retval = bbp_get_current_anonymous_user_data( 'email' );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_author_email', $retval, $post_id );
+    }
+/**
+ * Output the author url of a topic or reply.
+/**
+ * Return the author email of a topic or reply.
+ *
  * Convenience function to ensure proper template functions are called
 …
  * @since 2.5.0 bbPress (r5119)
+ *
+ * @param int $post_id
+ * @param int $post_id Post id.
+*
+ * @return string The email of the author.
+ */
+function bbp_get_author_email( $post_id = 0 ) {
+    // Define local variable(s)
+    $retval = '';
+    // Topic edit
+    if ( bbp_is_topic_edit() ) {
+        $retval = bbp_get_topic_author_email( $post_id );
+    // Reply edit
+    } elseif ( bbp_is_reply_edit() ) {
+        $retval = bbp_get_reply_author_email( $post_id );
+    // Not an edit, so rely on current user cookie data
+    } else {
+        $retval = bbp_get_current_anonymous_user_data( 'email' );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_author_email', $retval, $post_id );
+}
+/**
+ * Output the author url of a topic or reply.
+ *
+ * Convenience function to ensure proper template functions are called
+ * and correct filters are executed. Used primarily to display topic
+ * and reply author information in the anonymous user form template-part.
+ *
+ * @since 2.5.0 bbPress (r5119)
+ *
+ * @param int $post_id Post id.
  */
 function bbp_author_url( $post_id = 0 ) {
 …
+}
     /**
      * Return the author url of a topic or reply.
+     *
      * Convenience function to ensure proper template functions are called
      * and correct filters are executed. Used primarily to display topic
      * and reply author information in the anonymous user form template-part.
+     *
      * @since 2.5.0 bbPress (r5119)
+     *
+     * @param int $post_id
+     *
+     * @return string The url of the author
      */
     function bbp_get_author_url( $post_id = 0 ) {
         // Define local variable(s)
         $retval = '';
         // Topic edit
         if ( bbp_is_topic_edit() ) {
             $retval = bbp_get_topic_author_url( $post_id );
         // Reply edit
         } elseif ( bbp_is_reply_edit() ) {
             $retval = bbp_get_reply_author_url( $post_id );
         // Not an edit, so rely on current user cookie data
         } else {
             $retval = bbp_get_current_anonymous_user_data( 'url' );
+        }
         // Filter & return
         return apply_filters( 'bbp_get_author_url', $retval, $post_id );
+    }
+/**
+ * Return the author url of a topic or reply.
+ *
+ * Convenience function to ensure proper template functions are called
+ * and correct filters are executed. Used primarily to display topic
+ * and reply author information in the anonymous user form template-part.
+ *
+ * @since 2.5.0 bbPress (r5119)
+ *
+ * @param int $post_id Post id.
+ *
+ * @return string The url of the author.
+ */
+function bbp_get_author_url( $post_id = 0 ) {
+    // Define local variable(s)
+    $retval = '';
+    // Topic edit
+    if ( bbp_is_topic_edit() ) {
+        $retval = bbp_get_topic_author_url( $post_id );
+    // Reply edit
+    } elseif ( bbp_is_reply_edit() ) {
+        $retval = bbp_get_reply_author_url( $post_id );
+    // Not an edit, so rely on current user cookie data
+    } else {
+        $retval = bbp_get_current_anonymous_user_data( 'url' );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_author_url', $retval, $post_id );
+}
 /** Favorites *****************************************************************/
 /**
  * Output the link to the user's favorites page (profile page)
+ * Output the link to the user's favorites page (profile page).
+ *
  * @since 2.0.0 bbPress (r2652)
  * @since 2.6.0 bbPress (r6308) Add pagination if in the loop
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_favorites_permalink( $user_id = 0 ) {
     echo esc_url( bbp_get_favorites_permalink( $user_id ) );
+}
+    /**
+     * Return the link to the user's favorites page (profile page)
+     *
+     * @since 2.0.0 bbPress (r2652)
+     * @since 2.6.0 bbPress (r6308) Add pagination if in the loop
+     *
+     * @param int $user_id Optional. User id
+     * @return string Permanent link to user profile page
+     */
+    function bbp_get_favorites_permalink( $user_id = 0 ) {
+        // Use displayed user ID if there is one, and one isn't requested
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+/**
+ * Return the link to the user's favorites page (profile page).
+ *
+ * @since 2.0.0 bbPress (r2652)
+ * @since 2.6.0 bbPress (r6308) Add pagination if in the loop
+ *
+ * @param int $user_id Optional. User id.
+ * @return string Permanent link to user profile page.
+ */
+function bbp_get_favorites_permalink( $user_id = 0 ) {
+    // Use displayed user ID if there is one, and one isn't requested
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_favorites_permalink', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Get user profile URL & page
+    $profile_url = bbp_get_user_profile_url( $user_id );
+    $page        = (int) bbpress()->topic_query->paged;
+    $paged       = (bool) bbpress()->topic_query->in_the_loop;
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        // Base URL
+        $url = trailingslashit( $profile_url ) . bbp_get_user_favorites_slug();
+        // Add page
+        if ( ( true === $paged ) && ( $page > 1 ) ) {
+            $url = trailingslashit( $url ) . bbp_get_paged_slug() . '/' . $page;
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_favorites_permalink', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        // Ensure correct trailing slash
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        // Base arguments
+        $args = array(
+            bbp_get_user_favorites_rewrite_id() => bbp_get_user_favorites_slug(),
+        );
+        // Add page
+        if ( ( true === $paged ) && ( $page > 1 ) ) {
+            $args['page'] = $page;
+        }
+        // Get user profile URL & page
+        $profile_url = bbp_get_user_profile_url( $user_id );
+        $page        = (int) bbpress()->topic_query->paged;
+        $paged       = (bool) bbpress()->topic_query->in_the_loop;
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            // Base URL
+            $url = trailingslashit( $profile_url ) . bbp_get_user_favorites_slug();
+            // Add page
+            if ( ( true === $paged ) && ( $page > 1 ) ) {
+                $url = trailingslashit( $url ) . bbp_get_paged_slug() . '/' . $page;
+            }
+            // Ensure correct trailing slash
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            // Base arguments
+            $args = array(
+                bbp_get_user_favorites_rewrite_id() => bbp_get_user_favorites_slug(),
+            );
+            // Add page
+            if ( ( true === $paged ) && ( $page > 1 ) ) {
+                $args['page'] = $page;
+            }
+            // Add arguments
+            $url = add_query_arg( $args, $profile_url );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_favorites_permalink', $url, $user_id );
+    }
+/**
+ * Output the link to make a topic favorite/remove a topic from favorites
+        // Add arguments
+        $url = add_query_arg( $args, $profile_url );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_favorites_permalink', $url, $user_id );
+}
+/**
+ * Output the link to make a topic favorite/remove a topic from favorites.
+ *
  * @since 2.0.0 bbPress (r2652)
  * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+ *
  * @param array $args See {@link bbp_get_user_favorites_link()}
  * @param int $user_id Optional. User id
+ * @param array $args See {@link bbp_get_user_favorites_link()}.
+ * @param int $user_id Optional. User id.
  * @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">.
  */
 …
     echo bbp_get_user_favorites_link( $args, $user_id, $wrap );
+}
+    /**
+     * User favorites link
+     *
+     * Return the link to make a topic favorite/remove a topic from
+     * favorites
+     *
+     * @since 2.0.0 bbPress (r2652)
+     * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+     *
+     * @param array $args This function supports these arguments:
+     *  - subscribe: Favorite text
+     *  - unsubscribe: Unfavorite text
+     *  - user_id: User id
+     *  - topic_id: Topic id
+     *  - before: Before the link
+     *  - after: After the link
+     * @param int $user_id Optional. User id
+     * @param int $topic_id Optional. Topic id
+     * @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">. See ajax_favorite()
+     * @return string User favorites link
+     */
+    function bbp_get_user_favorites_link( $args = array(), $user_id = 0, $wrap = true ) {
+        // Bail if favorites are inactive
+        if ( ! bbp_is_favorites_active() ) {
+            return false;
+        }
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'favorite'    => esc_html__( 'Favorite',   'bbpress' ),
+                'favorited'   => esc_html__( 'Unfavorite', 'bbpress' ),
+                'user_id'     => 0,
+                'object_id'   => 0,
+                'object_type' => 'post',
+                'before'      => '',
+                'after'       => '',
+                'redirect_to' => '',
+                // Deprecated. Use object_id.
+                'forum_id'    => 0,
+                'topic_id'    => 0
+            ),
+            'get_user_favorites_link'
+/**
+ * User favorites link.
+ *
+ * Return the link to make a topic favorite/remove a topic from
+ * favorites.
+ *
+ * @since 2.0.0 bbPress (r2652)
+ * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+ *
+ * @param array $args This function supports these arguments:
+ *  - subscribe: Favorite text
+ *  - unsubscribe: Unfavorite text
+ *  - user_id: User id
+ *  - topic_id: Topic id
+ *  - before: Before the link
+ *  - after: After the link
+ * @param int $user_id Optional. User id.
+ * @param int $topic_id Optional. Topic id.
+ * @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">. See ajax_favorite().
+ * @return string User favorites link.
+ */
+function bbp_get_user_favorites_link( $args = array(), $user_id = 0, $wrap = true ) {
+    // Bail if favorites are inactive
+    if ( ! bbp_is_favorites_active() ) {
+        return false;
+    }
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'favorite'    => esc_html__( 'Favorite',   'bbpress' ),
+            'favorited'   => esc_html__( 'Unfavorite', 'bbpress' ),
+            'user_id'     => 0,
+            'object_id'   => 0,
+            'object_type' => 'post',
+            'before'      => '',
+            'after'       => '',
+            'redirect_to' => '',
+            // Deprecated. Use object_id.
+            'forum_id'    => 0,
+            'topic_id'    => 0
+        ),
+        'get_user_favorites_link'
+    );
+    // Validate user and object ID's
+    $user_id     = bbp_get_user_id( $r['user_id'], true, true );
+    $object_type = sanitize_key( $r['object_type'] );
+    // Back-compat for deprecated arguments
+    if ( ! empty( $r['topic_id'] ) ) {
+        $object_id = absint( $r['topic_id'] );
+    } elseif ( ! empty( $r['forum_id'] ) ) {
+        $object_id = absint( $r['forum_id'] );
+    } else {
+        $object_id = absint( $r['object_id'] );
+    }
+    // Bail if empty
+    if ( empty( $user_id ) || empty( $object_id ) || empty( $object_type ) ) {
+        return false;
+    }
+    // No link if you can't edit yourself
+    if ( ! current_user_can( 'edit_user', $user_id ) ) {
+        return false;
+    }
+    // Decide which link to show
+    $is_fav = bbp_is_user_favorite( $user_id, $object_id );
+    if ( ! empty( $is_fav ) ) {
+        $text   = $r['favorited'];
+        $q_args = array(
+            'action'    => 'bbp_favorite_remove',
+            'object_id' => $object_id
         );
+        // Validate user and object ID's
+        $user_id     = bbp_get_user_id( $r['user_id'], true, true );
+        $object_type = sanitize_key( $r['object_type'] );
+        // Back-compat for deprecated arguments
+        if ( ! empty( $r['topic_id'] ) ) {
+            $object_id = absint( $r['topic_id'] );
+        } elseif ( ! empty( $r['forum_id'] ) ) {
+            $object_id = absint( $r['forum_id'] );
+        } else {
+            $object_id = absint( $r['object_id'] );
+        }
+        // Bail if empty
+        if ( empty( $user_id ) || empty( $object_id ) || empty( $object_type ) ) {
+            return false;
+        }
+        // No link if you can't edit yourself
+        if ( ! current_user_can( 'edit_user', $user_id ) ) {
+            return false;
+        }
+        // Decide which link to show
+        $is_fav = bbp_is_user_favorite( $user_id, $object_id );
+        if ( ! empty( $is_fav ) ) {
+            $text   = $r['favorited'];
+            $q_args = array(
+                'action'    => 'bbp_favorite_remove',
+                'object_id' => $object_id
+            );
+        } else {
+            $text   = $r['favorite'];
+            $q_args = array(
+                'action'    => 'bbp_favorite_add',
+                'object_id' => $object_id
+            );
+        }
+        // Custom redirect
+        if ( ! empty( $r['redirect_to'] ) ) {
+            $q_args['redirect_to'] = urlencode( $r['redirect_to'] );
+        }
+        // URL
+        $url  = esc_url( wp_nonce_url( add_query_arg( $q_args ), 'toggle-favorite_' . $object_id ) );
+        $sub  = $is_fav ? ' class="is-favorite"' : '';
+        $html = sprintf( '%s<span id="favorite-%d"  %s><a href="%s" class="favorite-toggle" data-bbp-object-id="%d" data-bbp-object-type="%s" data-bbp-nonce="%s">%s</a></span>%s', $r['before'], $object_id, $sub, $url, $object_id, $object_type, wp_create_nonce( 'toggle-favorite_' . $object_id ), $text, $r['after'] );
+        // Initial output is wrapped in a span, ajax output is hooked to this
+        if ( ! empty( $wrap ) ) {
+            $html = '<span id="favorite-toggle">' . $html . '</span>';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_favorites_link', $html, $r, $user_id, $object_id );
+    }
+    } else {
+        $text   = $r['favorite'];
+        $q_args = array(
+            'action'    => 'bbp_favorite_add',
+            'object_id' => $object_id
+        );
+    }
+    // Custom redirect
+    if ( ! empty( $r['redirect_to'] ) ) {
+        $q_args['redirect_to'] = urlencode( $r['redirect_to'] );
+    }
+    // URL
+    $url  = esc_url( wp_nonce_url( add_query_arg( $q_args ), 'toggle-favorite_' . $object_id ) );
+    $sub  = $is_fav ? ' class="is-favorite"' : '';
+    $html = sprintf( '%s<span id="favorite-%d"  %s><a href="%s" class="favorite-toggle" data-bbp-object-id="%d" data-bbp-object-type="%s" data-bbp-nonce="%s">%s</a></span>%s', $r['before'], $object_id, $sub, $url, $object_id, $object_type, wp_create_nonce( 'toggle-favorite_' . $object_id ), $text, $r['after'] );
+    // Initial output is wrapped in a span, ajax output is hooked to this
+    if ( ! empty( $wrap ) ) {
+        $html = '<span id="favorite-toggle">' . $html . '</span>';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_favorites_link', $html, $r, $user_id, $object_id );
+}
 /** Subscriptions *************************************************************/
 /**
  * Output the link to the user's subscriptions page (profile page)
+ * Output the link to the user's subscriptions page (profile page).
+ *
  * @since 2.0.0 bbPress (r2688)
  * @since 2.6.0 bbPress (r6308) Add pagination if in the loop
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_subscriptions_permalink( $user_id = 0 ) {
     echo esc_url( bbp_get_subscriptions_permalink( $user_id ) );
+}
+    /**
+     * Return the link to the user's subscriptions page (profile page)
+     *
+     * @since 2.0.0 bbPress (r2688)
+     * @since 2.6.0 bbPress (r6308) Add pagination if in the loop
+     *
+     * @param int $user_id Optional. User id
+     * @return string Permanent link to user subscriptions page
+     */
+    function bbp_get_subscriptions_permalink( $user_id = 0 ) {
+        // Use displayed user ID if there is one, and one isn't requested
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+/**
+ * Return the link to the user's subscriptions page (profile page).
+ *
+ * @since 2.0.0 bbPress (r2688)
+ * @since 2.6.0 bbPress (r6308) Add pagination if in the loop
+ *
+ * @param int $user_id Optional. User id.
+ * @return string Permanent link to user subscriptions page.
+ */
+function bbp_get_subscriptions_permalink( $user_id = 0 ) {
+    // Use displayed user ID if there is one, and one isn't requested
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_subscriptions_permalink', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Get user profile URL
+    $profile_url = bbp_get_user_profile_url( $user_id );
+    $page        = 0;
+    $paged       = false;
+    // Get pagination data
+    if ( bbpress()->topic_query->in_the_loop ) {
+        $page  = (int) bbpress()->topic_query->paged;
+        $paged = (bool) bbpress()->topic_query->in_the_loop;
+    } elseif ( bbpress()->forum_query->in_the_loop ) {
+        $page  = (int) bbpress()->forum_query->paged;
+        $paged = (bool) bbpress()->forum_query->in_the_loop;
+    }
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        // Base URL
+        $url = trailingslashit( $profile_url ) . bbp_get_user_subscriptions_slug();
+        // Add page
+        if ( ( true === $paged ) && ( $page > 1 ) ) {
+            $url = trailingslashit( $url ) . bbp_get_paged_slug() . '/' . $page;
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_subscriptions_permalink', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        // Ensure correct trailing slash
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        // Base arguments
+        $args = array(
+            bbp_get_user_subscriptions_rewrite_id() => bbp_get_user_subscriptions_slug(),
+        );
+        // Add page
+        if ( ( true === $paged ) && ( $page > 1 ) ) {
+            $args['page'] = $page;
+        }
+        // Get user profile URL
+        $profile_url = bbp_get_user_profile_url( $user_id );
+        $page        = 0;
+        $paged       = false;
+        // Get pagination data
+        if ( bbpress()->topic_query->in_the_loop ) {
+            $page  = (int) bbpress()->topic_query->paged;
+            $paged = (bool) bbpress()->topic_query->in_the_loop;
+        } elseif ( bbpress()->forum_query->in_the_loop ) {
+            $page  = (int) bbpress()->forum_query->paged;
+            $paged = (bool) bbpress()->forum_query->in_the_loop;
+        }
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            // Base URL
+            $url = trailingslashit( $profile_url ) . bbp_get_user_subscriptions_slug();
+            // Add page
+            if ( ( true === $paged ) && ( $page > 1 ) ) {
+                $url = trailingslashit( $url ) . bbp_get_paged_slug() . '/' . $page;
+            }
+            // Ensure correct trailing slash
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            // Base arguments
+            $args = array(
+                bbp_get_user_subscriptions_rewrite_id() => bbp_get_user_subscriptions_slug(),
+            );
+            // Add page
+            if ( ( true === $paged ) && ( $page > 1 ) ) {
+                $args['page'] = $page;
+            }
+            // Add arguments
+            $url = add_query_arg( $args, $profile_url );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_subscriptions_permalink', $url, $user_id );
+    }
+/**
+ * Output the link to subscribe/unsubscribe from a topic
+        // Add arguments
+        $url = add_query_arg( $args, $profile_url );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_subscriptions_permalink', $url, $user_id );
+}
+/**
+ * Output the link to subscribe/unsubscribe from a topic.
+ *
  * @since 2.0.0 bbPress (r2668)
  * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+ *
  * @param array $args See {@link bbp_get_user_subscribe_link()}
  * @param int $user_id Optional. User id
+ * @param array $args See {@link bbp_get_user_subscribe_link()}.
+ * @param int $user_id Optional. User id.
  * @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
  */
 …
     echo bbp_get_user_subscribe_link( $args, $user_id, $wrap );
+}
+    /**
+     * Return the link to subscribe/unsubscribe from a forum or topic
+     *
+     * @since 2.0.0 bbPress (r2668)
+     * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+     *
+     * @param array $args This function supports these arguments:
+     *  - subscribe: Subscribe text
+     *  - unsubscribe: Unsubscribe text
+     *  - user_id: User id
+     *  - topic_id: Topic id
+     *  - forum_id: Forum id
+     *  - before: Before the link
+     *  - after: After the link
+     * @param int $user_id Optional. User id
+     * @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
+     * @return string Permanent link to topic
+     */
+    function bbp_get_user_subscribe_link( $args = array(), $user_id = 0, $wrap = true ) {
+        // Bail if subscriptions are inactive
+        if ( ! bbp_is_subscriptions_active() ) {
+            return;
+        }
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'subscribe'   => esc_html__( 'Subscribe',   'bbpress' ),
+                'unsubscribe' => esc_html__( 'Unsubscribe', 'bbpress' ),
+                'user_id'     => 0,
+                'object_id'   => 0,
+                'object_type' => 'post',
+                'before'      => '',
+                'after'       => '',
+                'redirect_to' => '',
+                // Deprecated. Use object_id.
+                'forum_id'    => 0,
+                'topic_id'    => 0
+            ),
+            'get_user_subscribe_link'
+/**
+ * Return the link to subscribe/unsubscribe from a forum or topic.
+ *
+ * @since 2.0.0 bbPress (r2668)
+ * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
+ *
+ * @param array $args This function supports these arguments:
+ *  - subscribe: Subscribe text
+ *  - unsubscribe: Unsubscribe text
+ *  - user_id: User id
+ *  - topic_id: Topic id
+ *  - forum_id: Forum id
+ *  - before: Before the link
+ *  - after: After the link
+ * @param int $user_id Optional. User id.
+ * @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
+ * @return string Permanent link to topic.
+ */
+function bbp_get_user_subscribe_link( $args = array(), $user_id = 0, $wrap = true ) {
+    // Bail if subscriptions are inactive
+    if ( ! bbp_is_subscriptions_active() ) {
+        return;
+    }
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'subscribe'   => esc_html__( 'Subscribe',   'bbpress' ),
+            'unsubscribe' => esc_html__( 'Unsubscribe', 'bbpress' ),
+            'user_id'     => 0,
+            'object_id'   => 0,
+            'object_type' => 'post',
+            'before'      => '',
+            'after'       => '',
+            'redirect_to' => '',
+            // Deprecated. Use object_id.
+            'forum_id'    => 0,
+            'topic_id'    => 0
+        ),
+        'get_user_subscribe_link'
+    );
+    // Validate user
+    $user_id     = bbp_get_user_id( $r['user_id'], true, true );
+    $object_type = sanitize_key( $r['object_type'] );
+    // Back-compat for deprecated arguments
+    if ( ! empty( $r['topic_id'] ) ) {
+        $object_id = absint( $r['topic_id'] );
+    } elseif ( ! empty( $r['forum_id'] ) ) {
+        $object_id = absint( $r['forum_id'] );
+    } else {
+        $object_id = absint( $r['object_id'] );
+    }
+    // Bail if anything is missing
+    if ( empty( $user_id ) || empty( $object_id ) || empty( $object_type ) ) {
+        return false;
+    }
+    // No link if you can't edit yourself
+    if ( ! current_user_can( 'edit_user', $user_id ) ) {
+        return false;
+    }
+    // Decide which link to show
+    $is_subscribed = bbp_is_user_subscribed( $user_id, $object_id );
+    if ( ! empty( $is_subscribed ) ) {
+        $text   = $r['unsubscribe'];
+        $q_args = array(
+            'action'      => 'bbp_unsubscribe',
+            'object_id'   => $object_id,
+            'object_type' => $object_type
         );
+        // Validate user
+        $user_id     = bbp_get_user_id( $r['user_id'], true, true );
+        $object_type = sanitize_key( $r['object_type'] );
+        // Back-compat for deprecated arguments
+        if ( ! empty( $r['topic_id'] ) ) {
+            $object_id = absint( $r['topic_id'] );
+        } elseif ( ! empty( $r['forum_id'] ) ) {
+            $object_id = absint( $r['forum_id'] );
+        } else {
+            $object_id = absint( $r['object_id'] );
+        }
+        // Bail if anything is missing
+        if ( empty( $user_id ) || empty( $object_id ) || empty( $object_type ) ) {
+            return false;
+        }
+        // No link if you can't edit yourself
+        if ( ! current_user_can( 'edit_user', $user_id ) ) {
+            return false;
+        }
+        // Decide which link to show
+        $is_subscribed = bbp_is_user_subscribed( $user_id, $object_id );
+        if ( ! empty( $is_subscribed ) ) {
+            $text   = $r['unsubscribe'];
+            $q_args = array(
+                'action'      => 'bbp_unsubscribe',
+                'object_id'   => $object_id,
+                'object_type' => $object_type
+            );
+        } else {
+            $text   = $r['subscribe'];
+            $q_args = array(
+                'action'      => 'bbp_subscribe',
+                'object_id'   => $object_id,
+                'object_type' => $object_type
+            );
+        }
+        // Custom redirect
+        if ( ! empty( $r['redirect_to'] ) ) {
+            $q_args['redirect_to'] = urlencode( $r['redirect_to'] );
+        }
+        // URL
+        $url  = esc_url( wp_nonce_url( add_query_arg( $q_args ), 'toggle-subscription_' . $object_id ) );
+        $sub  = $is_subscribed ? ' class="is-subscribed"' : '';
+        $html = sprintf( '%s<span id="subscribe-%d"  %s><a href="%s" class="subscription-toggle" data-bbp-object-id="%d" data-bbp-object-type="%d" data-bbp-nonce="%s">%s</a></span>%s', $r['before'], $object_id, $sub, $url, $object_id, $object_type, wp_create_nonce( 'toggle-subscription_' . $object_id ), $text, $r['after'] );
+        // Initial output is wrapped in a span, ajax output is hooked to this
+        if ( ! empty( $wrap ) ) {
+            $html = '<span id="subscription-toggle">' . $html . '</span>';
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_subscribe_link', $html, $r, $user_id, $object_id );
+    }
+    } else {
+        $text   = $r['subscribe'];
+        $q_args = array(
+            'action'      => 'bbp_subscribe',
+            'object_id'   => $object_id,
+            'object_type' => $object_type
+        );
+    }
+    // Custom redirect
+    if ( ! empty( $r['redirect_to'] ) ) {
+        $q_args['redirect_to'] = urlencode( $r['redirect_to'] );
+    }
+    // URL
+    $url  = esc_url( wp_nonce_url( add_query_arg( $q_args ), 'toggle-subscription_' . $object_id ) );
+    $sub  = $is_subscribed ? ' class="is-subscribed"' : '';
+    $html = sprintf( '%s<span id="subscribe-%d"  %s><a href="%s" class="subscription-toggle" data-bbp-object-id="%d" data-bbp-object-type="%d" data-bbp-nonce="%s">%s</a></span>%s', $r['before'], $object_id, $sub, $url, $object_id, $object_type, wp_create_nonce( 'toggle-subscription_' . $object_id ), $text, $r['after'] );
+    // Initial output is wrapped in a span, ajax output is hooked to this
+    if ( ! empty( $wrap ) ) {
+        $html = '<span id="subscription-toggle">' . $html . '</span>';
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_subscribe_link', $html, $r, $user_id, $object_id );
+}
 /** Edit User *****************************************************************/
 /**
  * Display profile edit success notice on user edit page
+ * Display profile edit success notice on user edit page.
+ *
  * @since 2.0.0 bbPress (r2688)
 …
 /**
  * Display pending email change notice on user edit page
+ * Display pending email change notice on user edit page.
+ *
  * @since 2.6.0 bbPress (r5660)
 …
 /**
  * Super admin privileges notice
+ * Super admin privileges notice.
+ *
  * @since 2.0.0 bbPress (r2688)
 …
 /**
  * Drop down for selecting the user's display name
+ * Drop down for selecting the user's display name.
+ *
  * @since 2.0.0 bbPress (r2688)
 …
 /**
  * Output blog role selector (for user edit)
+ * Output blog role selector (for user edit).
+ *
  * @since 2.0.0 bbPress (r2688)
 …
 /**
  * Output forum role selector (for user edit)
+ * Output forum role selector (for user edit).
+ *
  * @since 2.2.0 bbPress (r4284)
 …
 /**
  * Return user contact methods select box
+ * Return user contact methods select box.
+ *
  * @since 2.0.0 bbPress (r2688)
+ * @return string User contact methods
+ *
+ * @return string User contact methods.
  */
 function bbp_edit_user_contact_methods() {
 …
 /**
  * Output the language chooser (for user edit)
+ * Output the language chooser (for user edit).
+ *
  * @since 2.6.0 bbPress (r6488)
+ *
  * @param array $args See wp_dropdown_languages()
+ * @param array $args See wp_dropdown_languages().
  * @return string
  */
 …
 /**
  * Output the link to the user's topics
+ * Output the link to the user's topics.
+ *
  * @since 2.2.0 bbPress (r4225)
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_user_topics_created_url( $user_id = 0 ) {
     echo esc_url( bbp_get_user_topics_created_url( $user_id ) );
+}
+    /**
+     * Return the link to the user's topics
+     *
+     * @since 2.2.0 bbPress (r4225)
+     *
+     * @param int $user_id Optional. User id
+     * @return string Permanent link to user profile page
+     */
+    function bbp_get_user_topics_created_url( $user_id = 0 ) {
+        // Use displayed user ID if there is one, and one isn't requested
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_topics_created_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        }
+        // Get user profile URL
+        $profile_url = bbp_get_user_profile_url( $user_id );
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            $url = trailingslashit( $profile_url ) . bbp_get_topic_archive_slug();
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_user_topics_rewrite_id() => '1',
+                ),
+                $profile_url
+            );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_topics_created_url', $url, $user_id );
+    }
+/**
+ * Return the link to the user's topics.
+ *
+ * @since 2.2.0 bbPress (r4225)
+ *
+ * @param int $user_id Optional. User id.
+ * @return string Permanent link to user profile page.
+ */
+function bbp_get_user_topics_created_url( $user_id = 0 ) {
+    // Use displayed user ID if there is one, and one isn't requested
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_topics_created_url', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Get user profile URL
+    $profile_url = bbp_get_user_profile_url( $user_id );
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        $url = trailingslashit( $profile_url ) . bbp_get_topic_archive_slug();
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_user_topics_rewrite_id() => '1',
+            ),
+            $profile_url
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_topics_created_url', $url, $user_id );
+}
 /** Replies Created ************************************************************/
 /**
  * Output the link to the user's replies
+ * Output the link to the user's replies.
+ *
  * @since 2.2.0 bbPress (r4225)
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_user_replies_created_url( $user_id = 0 ) {
     echo esc_url( bbp_get_user_replies_created_url( $user_id ) );
+}
+    /**
+     * Return the link to the user's replies
+     *
+     * @since 2.2.0 bbPress (r4225)
+     *
+     * @param int $user_id Optional. User id
+     * @return string Permanent link to user profile page
+     */
+    function bbp_get_user_replies_created_url( $user_id = 0 ) {
+        // Use displayed user ID if there is one, and one isn't requested
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_replies_created_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        }
+        // Get user profile URL
+        $profile_url = bbp_get_user_profile_url( $user_id );
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            $url = trailingslashit( $profile_url ) . bbp_get_reply_archive_slug();
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_user_replies_rewrite_id() => '1',
+                ),
+                $profile_url
+            );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_replies_created_url', $url, $user_id );
+    }
+/**
+ * Return the link to the user's replies.
+ *
+ * @since 2.2.0 bbPress (r4225)
+ *
+ * @param int $user_id Optional. User id.
+ * @return string Permanent link to user profile page.
+ */
+function bbp_get_user_replies_created_url( $user_id = 0 ) {
+    // Use displayed user ID if there is one, and one isn't requested
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_replies_created_url', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Get user profile URL
+    $profile_url = bbp_get_user_profile_url( $user_id );
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        $url = trailingslashit( $profile_url ) . bbp_get_reply_archive_slug();
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_user_replies_rewrite_id() => '1',
+            ),
+            $profile_url
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_replies_created_url', $url, $user_id );
+}
 /** Engagements ***************************************************************/
 /**
  * Output the link to the user's engagements
+ * Output the link to the user's engagements.
+ *
  * @since 2.6.0 bbPress (r6320)
+ *
  * @param int $user_id Optional. User id
+ * @param int $user_id Optional. User id.
  */
 function bbp_user_engagements_url( $user_id = 0 ) {
     echo esc_url( bbp_get_user_engagements_url( $user_id ) );
+}
+    /**
+     * Return the link to the user's engagements
+     *
+     * @since 2.6.0 bbPress (r6320)
+     *
+     * @param int $user_id Optional. User id
+     * @return string Permanent link to user profile page
+     */
+    function bbp_get_user_engagements_url( $user_id = 0 ) {
+        // Use displayed user ID if there is one, and one isn't requested
+        $user_id = bbp_get_user_id( $user_id );
+        if ( empty( $user_id ) ) {
+            return false;
+        }
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_engagements_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
+        }
+        // Get user profile URL
+        $profile_url = bbp_get_user_profile_url( $user_id );
+        // Pretty permalinks
+        if ( bbp_use_pretty_urls() ) {
+            $url = trailingslashit( $profile_url ) . bbp_get_user_engagements_slug();
+            $url = user_trailingslashit( $url );
+        // Unpretty permalinks
+        } else {
+            $url = add_query_arg(
+                array(
+                    bbp_get_user_engagements_rewrite_id() => '1',
+                ),
+                $profile_url
+            );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_user_engagements_url', $url, $user_id );
+    }
+/**
+ * Return the link to the user's engagements.
+ *
+ * @since 2.6.0 bbPress (r6320)
+ *
+ * @param int $user_id Optional. User id.
+ * @return string Permanent link to user profile page.
+ */
+function bbp_get_user_engagements_url( $user_id = 0 ) {
+    // Use displayed user ID if there is one, and one isn't requested
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_engagements_url', func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
+    }
+    // Get user profile URL
+    $profile_url = bbp_get_user_profile_url( $user_id );
+    // Pretty permalinks
+    if ( bbp_use_pretty_urls() ) {
+        $url = trailingslashit( $profile_url ) . bbp_get_user_engagements_slug();
+        $url = user_trailingslashit( $url );
+    // Unpretty permalinks
+    } else {
+        $url = add_query_arg(
+            array(
+                bbp_get_user_engagements_rewrite_id() => '1',
+            ),
+            $profile_url
+        );
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_user_engagements_url', $url, $user_id );
+}
 /** Language ******************************************************************/
 /**
  * Output the select element used to save a user's language
+ * Output the select element used to save a user's language.
+ *
  * @since 2.6.0 bbPress (r6488)
+ *
  * @param array $args See wp_dropdown_languages()
+ * @param array $args See wp_dropdown_languages().
  */
 function bbp_user_languages_dropdown( $args = array() ) {
 …
+}
     /**
      * Return the select element used to save a user's language.
+     *
      * @since 2.6.0 bbPress (r6488)
+     *
+     * @param array $args See wp_dropdown_languages()
      * @return string
      */
     function bbp_get_user_languages_dropdown( $args = array() ) {
         // Get user language
         $user_id = ! empty( $args['user_id'] )
             ? bbp_get_user_id( $args['user_id'], false, false )
             : bbp_get_displayed_user_id();
         // Get user locale
         $user_locale = ! empty( $user_id )
             ? get_userdata( $user_id )->locale
             : 'site-default';
         // Get all languages
         $languages = get_available_languages();
         // No locale for English
         if ( 'en_US' === $user_locale ) {
             $user_locale = '';
         // Fallback to site-default if there is a mismatch
         } elseif ( '' === $user_locale || ! in_array( $user_locale, $languages, true ) ) {
             $user_locale = 'site-default';
+        }
         // Don't pass user ID in
         unset( $args['user_id'] );
         // Parse arguments
         $r = bbp_parse_args(
             $args,
             array(
                 'name'                        => 'locale',
                 'id'                          => 'locale',
                 'selected'                    => $user_locale,
                 'languages'                   => $languages,
                 'echo'                        => false,
                 'show_available_translations' => false,
                 'show_option_site_default'    => true
             ),
             'user_languages_dropdown'
         );
         // Get the markup for the languages drop-down
         $retval = wp_dropdown_languages( $r );
         // Filter & return
         return apply_filters( 'bbp_get_user_languages_dropdown', $retval, $r, $args );
+    }
+/**
+ * Return the select element used to save a user's language.
+ *
+ * @since 2.6.0 bbPress (r6488)
+ *
+ * @param array $args See wp_dropdown_languages().
+ * @return string
+ */
+function bbp_get_user_languages_dropdown( $args = array() ) {
+    // Get user language
+    $user_id = ! empty( $args['user_id'] )
+        ? bbp_get_user_id( $args['user_id'], false, false )
+        : bbp_get_displayed_user_id();
+    // Get user locale
+    $user_locale = ! empty( $user_id )
+        ? get_userdata( $user_id )->locale
+        : 'site-default';
+    // Get all languages
+    $languages = get_available_languages();
+    // No locale for English
+    if ( 'en_US' === $user_locale ) {
+        $user_locale = '';
+    // Fallback to site-default if there is a mismatch
+    } elseif ( '' === $user_locale || ! in_array( $user_locale, $languages, true ) ) {
+        $user_locale = 'site-default';
+    }
+    // Don't pass user ID in
+    unset( $args['user_id'] );
+    // Parse arguments
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'name'                        => 'locale',
+            'id'                          => 'locale',
+            'selected'                    => $user_locale,
+            'languages'                   => $languages,
+            'echo'                        => false,
+            'show_available_translations' => false,
+            'show_option_site_default'    => true
+        ),
+        'user_languages_dropdown'
+    );
+    // Get the markup for the languages drop-down
+    $retval = wp_dropdown_languages( $r );
+    // Filter & return
+    return apply_filters( 'bbp_get_user_languages_dropdown', $retval, $r, $args );
+}
 /** Login *********************************************************************/
 /**
  * Handle the login and registration template notices
+ * Handle the login and registration template notices.
+ *
  * @since 2.0.0 bbPress (r2970)
 …
  * @since 2.0.0 bbPress (r2815)
+ *
  * @param string $url The URL to redirect to
+ * @param string $url The URL to redirect to.
  */
 function bbp_logged_in_redirect( $url = '' ) {
 …
 /**
  * Output the required hidden fields when logging in
+ * Output the required hidden fields when logging in.
+ *
  * @since 2.0.0 bbPress (r2815)
 …
 /**
  * Output the required hidden fields when registering
+ * Output the required hidden fields when registering.
+ *
  * @since 2.0.0 bbPress (r2815)
 …
 /**
  * Output the required hidden fields when user lost password
+ * Output the required hidden fields when user lost password.
+ *
  * @since 2.0.0 bbPress (r2815)
 …
 /**
  * Output the author link of a post
+ * Output the author link of a post.
+ *
  * @since 2.0.0 bbPress (r2875)
 …
     echo bbp_get_author_link( $args );
+}
+    /**
+     * Return the author link of the post
+     *
+     * @since 2.0.0 bbPress (r2875)
+     *
+     * @param array $args Optional. If an integer, it is used as reply id.
+     * @return string Author link of reply
+     */
+    function bbp_get_author_link( $args = array() ) {
+        $post_id = is_numeric( $args ) ? (int) $args : 0;
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'post_id'    => $post_id,
+                'link_title' => '',
+                'type'       => 'both',
+                'size'       => 80,
+                'sep'        => ''
+            ),
+            'get_author_link'
+        );
+        // Confirmed topic
+        if ( bbp_is_topic( $r['post_id'] ) ) {
+            return bbp_get_topic_author_link( $r );
+        // Confirmed reply
+        } elseif ( bbp_is_reply( $r['post_id'] ) ) {
+            return bbp_get_reply_author_link( $r );
+/**
+ * Return the author link of the post.
+ *
+ * @since 2.0.0 bbPress (r2875)
+ *
+ * @param array $args Optional. If an integer, it is used as reply id.
+ * @return string Author link of reply.
+ */
+function bbp_get_author_link( $args = array() ) {
+    $post_id = is_numeric( $args ) ? (int) $args : 0;
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'post_id'    => $post_id,
+            'link_title' => '',
+            'type'       => 'both',
+            'size'       => 80,
+            'sep'        => ''
+        ),
+        'get_author_link'
+    );
+    // Confirmed topic
+    if ( bbp_is_topic( $r['post_id'] ) ) {
+        return bbp_get_topic_author_link( $r );
+    // Confirmed reply
+    } elseif ( bbp_is_reply( $r['post_id'] ) ) {
+        return bbp_get_reply_author_link( $r );
+    }
+    // Default return value
+    $author_link = '';
+    // Neither a reply nor a topic, so could be a revision
+    if ( ! empty( $r['post_id'] ) ) {
+        // Get some useful reply information
+        $user_id    = get_post_field( 'post_author', $r['post_id'] );
+        $author_url = bbp_get_user_profile_url( $user_id );
+        $anonymous  = bbp_is_reply_anonymous( $r['post_id'] );
+        // Generate title with the display name of the author
+        if ( empty( $r['link_title'] ) ) {
+            $author = get_the_author_meta( 'display_name', $user_id );
+            $title  = empty( $anonymous )
+                /* translators: %s: Author's display name */
+                ? esc_attr__( "View %s's profile",  'bbpress' )
+                /* translators: %s: Author's display name */
+                : esc_attr__( "Visit %s's website", 'bbpress' );
+            $r['link_title'] = sprintf( $title, $author );
+        }
+        // Default return value
+        $author_link = '';
+        // Neither a reply nor a topic, so could be a revision
+        if ( ! empty( $r['post_id'] ) ) {
+            // Get some useful reply information
+            $user_id    = get_post_field( 'post_author', $r['post_id'] );
+            $author_url = bbp_get_user_profile_url( $user_id );
+            $anonymous  = bbp_is_reply_anonymous( $r['post_id'] );
+            // Generate title with the display name of the author
+            if ( empty( $r['link_title'] ) ) {
+                $author = get_the_author_meta( 'display_name', $user_id );
+                $title  = empty( $anonymous )
+                    /* translators: %s: Author's display name */
+                    ? esc_attr__( "View %s's profile",  'bbpress' )
+                    /* translators: %s: Author's display name */
+                    : esc_attr__( "Visit %s's website", 'bbpress' );
+                $r['link_title'] = sprintf( $title, $author );
+            }
+            // Setup title and author_links array
+            $author_links = array();
+            $link_title   = ! empty( $r['link_title'] )
+                ? ' title="' . esc_attr( $r['link_title'] ) . '"'
+                : '';
+            // Get avatar (unescaped, because HTML)
+            if ( ( 'avatar' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+                $author_links['avatar'] = get_avatar( $user_id, $r['size'] );
+            }
+            // Get display name (escaped, because never HTML)
+            if ( ( 'name' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+                $author_links['name'] = esc_html( get_the_author_meta( 'display_name', $user_id ) );
+            }
+            // Empty array
+            $links  = array();
+            $sprint = '<span%1$s>%2$s</span>';
+            // Wrap each link
+            foreach ( $author_links as $link => $link_text ) {
+                $link_class = ' class="bbp-author-' . esc_attr( $link ) . '"';
+                $links[]    = sprintf( $sprint, $link_class, $link_text );
+            }
+            // Juggle
+            $author_links = $links;
+            unset( $links );
+            // Filter sections
+            $sections    = apply_filters( 'bbp_get_author_links', $author_links, $r, $args );
+            // Assemble sections into author link
+            $author_link = implode( $r['sep'], $sections );
+            // Only wrap in link if profile exists
+            if ( empty( $anonymous ) && bbp_user_has_profile( $user_id ) ) {
+                $author_link = sprintf( '<a href="%1$s"%2$s%3$s>%4$s</a>', esc_url( $author_url ), $link_title, ' class="bbp-author-link"', $author_link );
+            }
+        // Setup title and author_links array
+        $author_links = array();
+        $link_title   = ! empty( $r['link_title'] )
+            ? ' title="' . esc_attr( $r['link_title'] ) . '"'
+            : '';
+        // Get avatar (unescaped, because HTML)
+        if ( ( 'avatar' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+            $author_links['avatar'] = get_avatar( $user_id, $r['size'] );
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_author_link', $author_link, $r, $args );
+    }
+        // Get display name (escaped, because never HTML)
+        if ( ( 'name' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
+            $author_links['name'] = esc_html( get_the_author_meta( 'display_name', $user_id ) );
+        }
+        // Empty array
+        $links  = array();
+        $sprint = '<span%1$s>%2$s</span>';
+        // Wrap each link
+        foreach ( $author_links as $link => $link_text ) {
+            $link_class = ' class="bbp-author-' . esc_attr( $link ) . '"';
+            $links[]    = sprintf( $sprint, $link_class, $link_text );
+        }
+        // Juggle
+        $author_links = $links;
+        unset( $links );
+        // Filter sections
+        $sections    = apply_filters( 'bbp_get_author_links', $author_links, $r, $args );
+        // Assemble sections into author link
+        $author_link = implode( $r['sep'], $sections );
+        // Only wrap in link if profile exists
+        if ( empty( $anonymous ) && bbp_user_has_profile( $user_id ) ) {
+            $author_link = sprintf( '<a href="%1$s"%2$s%3$s>%4$s</a>', esc_url( $author_url ), $link_title, ' class="bbp-author-link"', $author_link );
+        }
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_author_link', $author_link, $r, $args );
+}
 /** Capabilities **************************************************************/
 /**
  * Check if the user can access a specific forum
+ * Check if the user can access a specific forum.
+ *
  * @since 2.0.0 bbPress (r3127)
 …
 /**
  * Check if the current user can publish topics
+ * Check if the current user can publish topics.
+ *
  * @since 2.0.0 bbPress (r3127)
 …
 /**
  * Check if the current user can publish forums
+ * Check if the current user can publish forums.
+ *
  * @since 2.1.0 bbPress (r3549)
 …
 /**
  * Check if the current user can publish replies
+ * Check if the current user can publish replies.
+ *
  * @since 2.0.0 bbPress (r3127)
 …
 /**
  * Get the forums the current user has the ability to see and post to
+ * Get the forums the current user has the ability to see and post to.
+ *
  * @since 2.0.0 bbPress (r3127)
 …
 /**
  * Output the moderators of a forum
+ * Output the moderators of a forum.
+ *
  * @since 2.6.0 bbPress
+ *
  * @param int   $forum_id Optional. Topic id
  * @param array $args     See {@link bbp_get_moderator_list()}
+ * @param int   $forum_id Optional. Topic id.
+ * @param array $args     See {@link bbp_get_moderator_list()}.
  */
 function bbp_moderator_list( $forum_id = 0, $args = array() ) {
 …
+}
+    /**
+     * Return the moderators for an object
+     *
+     * @since 2.6.0 bbPress
+     *
+     * @param int   $object_id Optional. Object id
+     * @param array $args     This function supports these arguments:
+     *  - before: Before the tag list
+     *  - sep: Tag separator
+     *  - after: After the tag list
+     *
+     * @return string Moderator list of the object
+     */
+    function bbp_get_moderator_list( $object_id = 0, $args = array() ) {
+        // Parse arguments against default values
+        $r = bbp_parse_args(
+            $args,
+            array(
+                'before' => '<div class="bbp-moderators"><p>' . esc_html__( 'Moderators:', 'bbpress' ) . '&nbsp;',
+                'sep'    => ', ',
+                'after'  => '</p></div>',
+                'none'   => ''
+            ),
+            'get_moderator_list'
+        );
+        // Get forum moderators
+        $user_ids = bbp_get_moderator_ids( $object_id );
+        if ( ! empty( $user_ids ) ) {
+            // In admin, use nicenames
+            if ( is_admin() ) {
+                $users = bbp_get_user_nicenames_from_ids( $user_ids );
+            // In theme, use display names & profile links
+            } else {
+                foreach ( $user_ids as $user_id ) {
+                    $users[] = bbp_get_user_profile_link( $user_id );
+                }
+/**
+ * Return the moderators for an object.
+ *
+ * @since 2.6.0 bbPress
+ *
+ * @param int   $object_id Optional. Object id.
+ * @param array $args     This function supports these arguments:
+ *  - before: Before the tag list
+ *  - sep: Tag separator
+ *  - after: After the tag list
+ *
+ * @return string Moderator list of the object.
+ */
+function bbp_get_moderator_list( $object_id = 0, $args = array() ) {
+    // Parse arguments against default values
+    $r = bbp_parse_args(
+        $args,
+        array(
+            'before' => '<div class="bbp-moderators"><p>' . esc_html__( 'Moderators:', 'bbpress' ) . '&nbsp;',
+            'sep'    => ', ',
+            'after'  => '</p></div>',
+            'none'   => ''
+        ),
+        'get_moderator_list'
+    );
+    // Get forum moderators
+    $user_ids = bbp_get_moderator_ids( $object_id );
+    if ( ! empty( $user_ids ) ) {
+        // In admin, use nicenames
+        if ( is_admin() ) {
+            $users = bbp_get_user_nicenames_from_ids( $user_ids );
+        // In theme, use display names & profile links
+        } else {
+            foreach ( $user_ids as $user_id ) {
+                $users[] = bbp_get_user_profile_link( $user_id );
+            }
-            $retval = $r['before'] . implode( $r['sep'], $users ) . $r['after'];
-        // No forum moderators
-        } else {
-            $retval = $r['none'];
+        }
+        // Filter & return
+        return apply_filters( 'bbp_get_moderator_list', $retval );
+    }
+        $retval = $r['before'] . implode( $r['sep'], $users ) . $r['after'];
+    // No forum moderators
+    } else {
+        $retval = $r['none'];
+    }
+    // Filter & return
+    return apply_filters( 'bbp_get_moderator_list', $retval );
+}

Context Navigation

Legend:

Download in other formats: