Skip to:
Content

bbPress.org

Changeset 2758


Ignore:
Timestamp:
01/06/2011 08:25:58 AM (16 years ago)
Author:
johnjamesjacoby
Message:

"...pursuing a career in the custodial arts." phpDoc fixes and code clean-up. Props GautamGupta via Google Code-in

Location:
branches/plugin
Files:
39 edited

Legend:

Unmodified
Added
Removed
  • branches/plugin/bbp-admin/bbp-functions.php

    r2749 r2758  
    11<?php
    22
    3 function bbp_admin_notices ( $message, $class = false ) {
     3/**
     4 * bbPress Admin Functions
     5 *
     6 * @package bbPress
     7 * @subpackage Administration
     8 */
     9
     10/**
     11 * Display the admin notices
     12 *
     13 * @since bbPress (r2613)
     14 *
     15 * @param string|WP_Error $message A message to be displayed or {@link WP_Error}
     16 * @param string $class Optional. A class to be added to the message div
     17 * @uses WP_Error::get_error_messages() To get the error messages of $message
     18 * @uses add_action() Adds the admin notice action with the message HTML
     19 * @return string The message HTML
     20 */
     21function bbp_admin_notices( $message, $class = false ) {
    422        if ( is_string( $message ) ) {
    523                $message = '<p>' . $message . '</p>';
    … …  
    3654}
    3755
    38 function bbp_recount_list () {
     56/**
     57 * Get the array of the recount list
     58 *
     59 * @since bbPress (r2613)
     60 *
     61 * @uses apply_filters() Calls 'bbp_recount_list' with the recount list array
     62 * @return array Recount list
     63 */
     64function bbp_recount_list() {
    3965        $recount_list = array(
    4066                5  => array( 'bbp-forum-topics',          __( 'Count topics in each forum',                    'bbpress' ), 'bbp_recount_forum_topics'          ),
    … …  
    5581}
    5682
    57 function bbp_recount_topic_replies () {
     83/**
     84 * Recount topic replies
     85 *
     86 * @since bbPress (r2613)
     87 *
     88 * @uses wpdb::query() To run our recount sql queries
     89 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     90 * @return array An array of the status code and the message
     91 */
     92function bbp_recount_topic_replies() {
    5893        global $wpdb, $bbp;
    5994
    … …  
    73108}
    74109
    75 function bbp_recount_topic_voices () {
     110/**
     111 * Recount topic voices
     112 *
     113 * @since bbPress (r2613)
     114 *
     115 * @uses wpdb::query() To run our recount sql queries
     116 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     117 * @return array An array of the status code and the message
     118 */
     119function bbp_recount_topic_voices() {
    76120        global $wpdb, $bbp;
    77121
    … …  
    83127                return array( 1, sprintf( $statement, $result ) );
    84128
    85         $sql = "INSERT INTO `{$wpdb->postmeta}` (`post_id`, `meta_key`, `meta_value`) (SELECT `ID`, '_bbp_topic_voice_count', COUNT(DISTINCT `post_author`) as `meta_value` FROM `{$wpdb->posts}` WHERE `post_type` IN ( '{$bbp->topic_id}', '{{$bbp->reply_id}}' ) AND `post_status` = 'publish' GROUP BY `post_parent`);";
     129        $sql = "INSERT INTO `{$wpdb->postmeta}` (`post_id`, `meta_key`, `meta_value`) (SELECT `ID`, '_bbp_topic_voice_count', COUNT(DISTINCT `post_author`) as `meta_value` FROM `{$wpdb->posts}` WHERE `post_type` IN ( '{$bbp->topic_id}', '{$bbp->reply_id}' ) AND `post_status` = 'publish' GROUP BY `post_parent`);";
    86130        if ( is_wp_error( $wpdb->query( $sql ) ) )
    87131                return array( 2, sprintf( $statement, $result ) );
    … …  
    118162}
    119163
    120 function bbp_recount_forum_topics () {
     164/**
     165 * Recount forum topics
     166 *
     167 * @since bbPress (r2613)
     168 *
     169 * @uses wpdb::query() To run our recount sql queries
     170 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     171 * @return array An array of the status code and the message
     172 */
     173function bbp_recount_forum_topics() {
    121174        global $wpdb, $bbp;
    122175
    … …  
    136189}
    137190
    138 function bbp_recount_forum_replies () {
     191/**
     192 * Recount forum replies
     193 *
     194 * @since bbPress (r2613)
     195 *
     196 * @uses wpdb::query() To run our recount sql queries
     197 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     198 * @return array An array of the status code and the message
     199 */
     200function bbp_recount_forum_replies() {
    139201        global $wpdb, $bbp;
    140202
    … …  
    154216}
    155217
    156 function bbp_recount_user_topics_replied () {
     218/**
     219 * Recount topic replied by the users
     220 *
     221 * @since bbPress (r2613)
     222 *
     223 * @uses wpdb::query() To run our recount sql queries
     224 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     225 * @return array An array of the status code and the message
     226 */
     227function bbp_recount_user_topics_replied() {
    157228        global $wpdb, $bbp;
    158229
    … …  
    191262
    192263// This function bypasses the taxonomy API
    193 function bbp_recount_topic_tags () {
     264/**
     265 * Recount topic tags in each topic
     266 *
     267 * @since bbPress (r2613)
     268 *
     269 * @uses wpdb::query() To run our recount sql queries
     270 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     271 * @return array An array of the status code and the message
     272 */
     273function bbp_recount_topic_tags() {
    194274        global $wpdb;
    195275
    … …  
    261341
    262342// This function bypasses the taxonomy API
    263 function bbp_recount_tag_topics () {
     343/**
     344 * Recount the number of topics in each topic tag
     345 *
     346 * @since bbPress (r2613)
     347 *
     348 * @uses wpdb::query() To run our recount sql queries
     349 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     350 * @return array An array of the status code and the message
     351 */
     352function bbp_recount_tag_topics() {
    264353        global $wpdb;
    265354
    … …  
    334423
    335424// This function bypasses the taxonomy API
    336 function bbp_recount_tag_delete_empty () {
     425/**
     426 * Recount topic tags with no topics
     427 *
     428 * @since bbPress (r2613)
     429 *
     430 * @uses wpdb::query() To run our recount sql queries
     431 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     432 * @return array An array of the status code and the message
     433 */
     434function bbp_recount_tag_delete_empty() {
    337435        global $wpdb;
    338436
    … …  
    456554}
    457555
    458 function bbp_recount_clean_favorites () {
     556/**
     557 * Clean the users' favorites
     558 *
     559 * @since bbPress (r2613)
     560 *
     561 * @uses wpdb::query() To run our recount sql queries
     562 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     563 * @return array An array of the status code and the message
     564 */
     565function bbp_recount_clean_favorites() {
    459566        global $wpdb, $bbp;
    460567
    … …  
    505612}
    506613
    507 function bbp_recount_clean_subscriptions () {
     614/**
     615 * Clean the users' subscriptions
     616 *
     617 * @since bbPress (r2668)
     618 *
     619 * @uses wpdb::query() To run our recount sql queries
     620 * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
     621 * @return array An array of the status code and the message
     622 */
     623function bbp_recount_clean_subscriptions() {
    508624        global $wpdb, $bbp;
    509625
  • branches/plugin/bbp-admin/bbp-settings.php

    r2738 r2758  
    22
    33/**
    4  * bbp_admin_setting_callback_section ()
     4 * bbPress Admin Settings
    55 *
    6  * Main settings description for the settings page
     6 * @package bbPress
     7 * @subpackage Administration
     8 */
     9
     10/**
     11 * Main settings section description for the settings page
    712 *
    813 * @since bbPress (r2737)
    914 */
    10 function bbp_admin_setting_callback_section () {
     15function bbp_admin_setting_callback_section() {
    1116?>
    1217
    … …  
    1722
    1823/**
    19  * bbp_admin_setting_callback_editlock ()
    20  *
    2124 * Edit lock setting field
    2225 *
    2326 * @since bbPress (r2737)
     27 *
     28 * @uses form_option() To output the option value
    2429 */
    2530function bbp_admin_setting_callback_editlock () {
    … …  
    3338
    3439/**
    35  * bbp_admin_setting_callback_throttle ()
    36  *
    3740 * Throttle setting field
    3841 *
    3942 * @since bbPress (r2737)
     43 *
     44 * @uses form_option() To output the option value
    4045 */
    41 function bbp_admin_setting_callback_throttle () {
     46function bbp_admin_setting_callback_throttle() {
    4247?>
    4348
    … …  
    4954
    5055/**
    51  * bbp_admin_setting_callback_subscriptions ()
    52  *
    5356 * Allow subscriptions setting field
    5457 *
    5558 * @since bbPress (r2737)
     59 *
     60 * @uses checked() To display the checked attribute
    5661 */
    57 function bbp_admin_setting_callback_subscriptions () {
     62function bbp_admin_setting_callback_subscriptions() {
    5863?>
    5964
    … …  
    6570
    6671/**
    67  * bbp_admin_setting_callback_anonymous ()
    68  *
    6972 * Allow anonymous posting setting field
    7073 *
    7174 * @since bbPress (r2737)
     75 *
     76 * @uses checked() To display the checked attribute
    7277 */
    73 function bbp_admin_setting_callback_anonymous () {
     78function bbp_admin_setting_callback_anonymous() {
    7479?>
    7580
    … …  
    8186
    8287/**
    83  * bbp_admin_settings ()
    84  *
    8588 * The main settings page
    8689 *
    87  * @uses settings_fields() To output the hidden fields
     90 * @since bbPress (r2643)
     91 *
     92 * @uses screen_icon() To display the screen icon
     93 * @uses settings_fields() To output the hidden fields for the form
    8894 * @uses do_settings_sections() To output the settings sections
    89  *
    90  * @since bbPress (r2643)
    9195 */
    92 function bbp_admin_settings () {
     96function bbp_admin_settings() {
    9397?>
    9498        <div class="wrap">
  • branches/plugin/bbp-admin/bbp-tools.php

    r2679 r2758  
    11<?php
    22
    3 function bbp_admin_tools () {
     3/**
     4 * bbPress Admin Tools Page
     5 *
     6 * @package bbPress
     7 * @subpackage Administration
     8 */
     9
     10/**
     11 * Admin tools page
     12 *
     13 * @since bbPress (r2613)
     14 *
     15 * @uses bbp_recount_list() To get the recount list
     16 * @uses check_admin_referer() To verify the nonce and the referer
     17 * @uses wp_cache_flush() To flush the cache
     18 * @uses do_action() Calls 'admin_notices' to display the notices
     19 * @uses screen_icon() To display the screen icon
     20 * @uses wp_nonce_field() To add a hidden nonce field
     21 */
     22function bbp_admin_tools() {
    423
    524        $recount_list = bbp_recount_list();
  • branches/plugin/bbp-css/admin.css

    r2679 r2758  
    1 /*
    2  Document   : admin.css
    3  Created on : Aug 3, 2010, 3:11:16 AM
    4  Author     : John
    5  Description: wp-admin area stylesheet with a bbPress twist
    6  */
     1/* =wp-admin area stylesheet with a bbPress twist
     2-------------------------------------------------------------- */
    73
    84html {
    … …  
    16941690}
    16951691
    1696 #nav-menu-header, .menu-item-handle {
     1692#nav-menu-header,
     1693.menu-item-handle {
    16971694        background: url("../../../../wp-admin/images/gray-grad.png") repeat-x scroll left top #dfdfdf;
    16981695}
  • branches/plugin/bbp-includes/bbp-classes.php

    r2747 r2758  
    33if ( !class_exists( 'BBP_Component' ) ) :
    44/**
    5  * BBP_Component
     5 * bbPress Component Class
    66 *
    77 * The bbPress component class is responsible for simplifying the creation
    8  * of components that share similar behaviors and routines. It is used internally
    9  * by bbPress to create forums, topics, and replies, but can be extended to create
    10  * other really neat things.
    11  *
    12  * @since (r2688)
     8 * of components that share similar behaviors and routines. It is used
     9 * internally by bbPress to create forums, topics and replies, but can be
     10 * extended to create other really neat things.
     11 *
     12 * @package bbpress
     13 * @subpackage Classes
     14 *
     15 * @since bbPress (r2688)
    1316 */
    1417class BBP_Component {
    1518
    16         // Unique name (For internal identification)
     19        /**
     20         * @var string Unique name (for internal identification)
     21         * @internal
     22         */
    1723        var $name;
    1824
    19         // Unique ID (Normally for custom post type)
     25        /**
     26         * @var Unique ID (normally for custom post type)
     27         */
    2028        var $id;
    2129
    22         // Unique slug (Used in query string and permalinks)
     30        /**
     31         * @var string Unique slug (used in query string and permalinks)
     32         */
    2333        var $slug;
    2434
    25         // The loop for this component
     35        /**
     36         * @var WP_Query The loop for this component
     37         */
    2638        var $query;
    2739
    28         // The current ID of the queried object
     40        /**
     41         * @var string The current ID of the queried object
     42         */
    2943        var $current_id;
    3044
    31         function BBP_Component ( $args = '' ) {
     45
     46        /**
     47         * bbPress Component loader
     48         *
     49         * @since bbPress (r2700)
     50         *
     51         * @param mixed $args Required. Supports these args:
     52         *  - name: Unique name (for internal identification)
     53         *  - id: Unique ID (normally for custom post type)
     54         *  - slug: Unique slug (used in query string and permalinks)
     55         *  - query: The loop for this component (WP_Query)
     56         *  - current_id: The current ID of the queried object
     57         * @uses BBP_Component::_setup_globals() Setup the globals needed
     58         * @uses BBP_Component::_includes() Include the required files
     59         * @uses BBP_Component::_setup_actions() Setup the hooks and actions
     60         */
     61        function BBP_Component( $args = '' ) {
    3262                if ( empty( $args ) )
    3363                        return;
    … …  
    3969
    4070        /**
    41          * _setup_globals ()
    42          *
    4371         * Component global variables
    44          */
    45         function _setup_globals ( $args = '' ) {
     72         *
     73         * @since bbPress (r2700)
     74         * @access private
     75         *
     76         * @uses apply_filters() Calls 'bbp_{@link BBP_Component::name}_id'
     77         * @uses apply_filters() Calls 'bbp_{@link BBP_Component::name}_slug'
     78         */
     79        function _setup_globals( $args = '' ) {
    4680                $this->name = $args['name'];
    4781                $this->id   = apply_filters( 'bbp_' . $this->name . '_id',   $args['id']   );
    … …  
    5084
    5185        /**
    52          * _includes ()
    53          *
    5486         * Include required files
    5587         *
    56          * @since bbPress (r2688)
    57          */
    58         function _includes () {
     88         * @since bbPress (r2700)
     89         * @access private
     90         *
     91         * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_includes'
     92         */
     93        function _includes() {
    5994                do_action( 'bbp_' . $this->name . '_includes' );
    6095        }
    6196
    6297        /**
    63          * _setup_actions ()
    64          *
    65          * Setup the default hooks and actions
    66          *
    67          * @since bbPress (r2688)
    68          */
    69         function _setup_actions () {
    70                 // Register content types
     98         * Setup the actions
     99         *
     100         * @since bbPress (r2700)
     101         * @access private
     102         *
     103         * @uses add_action() To add various actions
     104         * @uses do_action() Calls
     105         *                    'bbp_{@link BBP_Component::name}_setup_actions'
     106         */
     107        function _setup_actions() {
     108                // Register post types
    71109                add_action( 'bbp_register_post_types',      array ( $this, 'register_post_types'      ), 10, 2 );
    72110
    … …  
    85123
    86124        /**
    87          * register_post_types ()
    88          *
    89125         * Setup the component post types
    90126         *
    91          * @since bbPress (r2688)
    92          */
    93         function register_post_types () {
     127         * @since bbPress (r2700)
     128         *
     129         * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_post_types'
     130         */
     131        function register_post_types() {
    94132                do_action( 'bbp_' . $this->name . '_register_post_types' );
    95133        }
    96134
    97135        /**
    98          * register_taxonomies ()
    99          *
    100136         * Register component specific taxonomies
    101137         *
    102          * @since bbPress (r2688)
    103          */
    104         function register_taxonomies () {
     138         * @since bbPress (r2700)
     139         *
     140         * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_taxonomies'
     141         */
     142        function register_taxonomies() {
    105143                do_action( 'bbp_' . $this->name . '_register_taxonomies' );
    106144        }
    107145
    108146        /**
    109          * add_rewrite_tags ()
    110          *
    111147         * Add any additional rewrite tags
    112148         *
    113          * @since bbPress (r2688)
    114          */
    115         function add_rewrite_tags () {
     149         * @since bbPress (r2700)
     150         *
     151         * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_add_rewrite_tags'
     152         */
     153        function add_rewrite_tags() {
    116154                do_action( 'bbp_' . $this->name . '_add_rewrite_tags' );
    117155        }
    118156
    119157        /**
    120          * generate_rewrite_rules ()
    121          *
    122158         * Generate any additional rewrite rules
    123159         *
    124          * @since bbPress (r2688)
     160         * @since bbPress (r2700)
     161         *
     162         * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_generate_rewrite_rules'
    125163         */
    126164        function generate_rewrite_rules ( $wp_rewrite ) {
    … …  
    135173 *
    136174 * @package bbPress
    137  * @since r2514
     175 * @subpackage Classes
     176 *
     177 * @since bbPress (r2514)
     178 *
    138179 * @uses Walker
    139180 */
    … …  
    141182        /**
    142183         * @see Walker::$tree_type
    143          * @since r2514
     184         *
     185         * @since bbPress (r2514)
     186         *
    144187         * @var string
    145188         */
    … …  
    148191        /**
    149192         * @see Walker::$db_fields
    150          * @since r2514
     193         *
     194         * @since bbPress (r2514)
     195         *
    151196         * @var array
    152197         */
    153         var $db_fields = array ( 'parent' => 'post_parent', 'id' => 'ID' );
     198        var $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
    154199
    155200        /**
    156201         * Set the tree_type
    157202         *
    158          * @global bbPress $bbp
    159          */
    160         function BBP_Walker_Forum () {
     203         * @since bbPress (r2514)
     204         */
     205        function BBP_Walker_Forum() {
    161206                global $bbp;
    162207
    … …  
    167212         * @see Walker::start_lvl()
    168213         *
    169          * @since r2514
    170          *
    171          * @param string $output Passed by reference. Used to append additional content.
     214         * @since bbPress (r2514)
     215         *
     216         * @param string $output Passed by reference. Used to append additional
     217         *                        content.
    172218         * @param int $depth Depth of page. Used for padding.
    173219         */
    174220        function start_lvl( &$output, $depth ) {
    175                 $indent = str_repeat( "\t", $depth );
     221                $indent  = str_repeat( "\t", $depth );
    176222                $output .= "\n$indent<ul class='children'>\n";
    177223        }
    … …  
    180226         * @see Walker::end_lvl()
    181227         *
    182          * @since r2514
    183          *
    184          * @param string $output Passed by reference. Used to append additional content.
     228         * @since bbPress (r2514)
     229         *
     230         * @param string $output Passed by reference. Used to append additional
     231         *                        content.
    185232         * @param int $depth Depth of page. Used for padding.
    186233         */
    187234        function end_lvl( &$output, $depth ) {
    188                 $indent = str_repeat( "\t", $depth );
     235                $indent  = str_repeat( "\t", $depth );
    189236                $output .= "$indent</ul>\n";
    190237        }
    … …  
    193240         * @see Walker::start_el()
    194241         *
    195          * @since r2514
    196          *
    197          * @param string $output Passed by reference. Used to append additional content.
     242         * @since bbPress (r2514)
     243         *
     244         * @param string $output Passed by reference. Used to append additional
     245         *                        content.
    198246         * @param object $forum Page data object.
    199247         * @param int $depth Depth of page. Used for padding.
    … …  
    235283         * @see Walker::end_el()
    236284         *
    237          * @since r2514
    238          *
    239          * @param string $output Passed by reference. Used to append additional content.
     285         * @since bbPress (r2514)
     286         *
     287         * @param string $output Passed by reference. Used to append additional
     288         *                        content.
    240289         * @param object $forum Page data object. Not used.
    241290         * @param int $depth Depth of page. Not Used.
  • branches/plugin/bbp-includes/bbp-forum-template.php

    r2747 r2758  
    11<?php
    22
     3/**
     4 * bbPress Forum Template Tags
     5 *
     6 * @package bbPress
     7 * @subpackage TemplateTags
     8 */
     9
    310/** START - Forum Loop Functions **********************************************/
    411
    512/**
    6  * bbp_has_forums ()
    7  *
    8  * The main forum loop. WordPress makes this easy for us
    9  *
    10  * @package bbPress
    11  * @subpackage Template Tags
    12  * @since bbPress (r2464)
    13  *
    14  * @global WP_Query $bbp->forum_query
    15  * @param array $args Possible arguments to change returned forums
     13 * The main forum loop.
     14 *
     15 * WordPress makes this easy for us.
     16 *
     17 * @since bbPress (r2464)
     18 *
     19 * @param mixed $args All the arguments supported by {@link WP_Query}
     20 * @uses WP_Query To make query and get the forums
     21 * @uses current_user_can() To check if the current user is capable of editing
     22 *                           others' forums
     23 * @uses apply_filters() Calls 'bbp_has_forums' with
     24 *                        bbPres::forum_query::have_posts()
     25 *                        and bbPres::forum_query
    1626 * @return object Multidimensional array of forum information
    1727 */
    18 function bbp_has_forums ( $args = '' ) {
     28function bbp_has_forums( $args = '' ) {
    1929        global $wp_query, $bbp;
    2030
    … …  
    4252
    4353/**
    44  * bbp_forums ()
    45  *
    4654 * Whether there are more forums available in the loop
    4755 *
    48  * @package bbPress
    49  * @subpackage Template Tags
    50  * @since bbPress (r2464)
    51  *
    52  * @global WP_Query $bbp->forum_query
     56 * @since bbPress (r2464)
     57 *
     58 * @uses bbPress:forum_query::have_posts() To check if there are more forums
     59 *                                          available
    5360 * @return object Forum information
    5461 */
    55 function bbp_forums () {
     62function bbp_forums() {
    5663        global $bbp;
    5764        return $bbp->forum_query->have_posts();
    … …  
    5966
    6067/**
    61  * bbp_the_forum ()
    62  *
    6368 * Loads up the current forum in the loop
    6469 *
    65  * @package bbPress
    66  * @subpackage Template Tags
    67  * @since bbPress (r2464)
    68  *
    69  * @global WP_Query $bbp->forum_query
     70 * @since bbPress (r2464)
     71 *
     72 * @uses bbPress:forum_query::the_post() To get the current forum
    7073 * @return object Forum information
    7174 */
    72 function bbp_the_forum () {
     75function bbp_the_forum() {
    7376        global $bbp;
    7477        return $bbp->forum_query->the_post();
    … …  
    7881
    7982/**
    80  * bbp_forum_id ()
    81  *
    82  * Output id from bbp_forum_id()
    83  *
    84  * @package bbPress
    85  * @subpackage Template Tags
    86  * @since bbPress (r2464)
    87  *
    88  * @uses bbp_get_forum_id()
    89  */
    90 function bbp_forum_id () {
    91         echo bbp_get_forum_id();
    92 }
    93         /**
    94          * bbp_get_forum_id ()
    95          *
    96          * Return the forum ID
    97          *
    98          * @package bbPress
    99          * @subpackage Template Tags
     83 * Output forum id
     84 *
     85 * @since bbPress (r2464)
     86 *
     87 * @param $forum_id Optional. Used to check emptiness
     88 * @uses bbp_get_forum_id() To get the forum id
     89 */
     90function bbp_forum_id( $forum_id = 0 ) {
     91        echo bbp_get_forum_id( $forum_id );
     92}
     93        /**
     94         * Return the forum id
     95         *
    10096         * @since bbPress (r2464)
    10197         *
    102          * @param $forum_id Use to check emptiness
    103          * @global object $forums_template
    104          * @return string Forum id
    105          */
    106         function bbp_get_forum_id ( $forum_id = 0 ) {
     98         * @param $forum_id Optional. Used to check emptiness
     99         * @uses bbPress::forum_query::in_the_loop To check if we're in the loop
     100         * @uses bbPress::forum_query::post::ID To get the forum id
     101         * @uses WP_Query::post::ID To get the forum id
     102         * @uses bbp_is_forum() To check if it's a forum page
     103         * @uses bbp_is_topic() To check if it's a topic page
     104         * @uses bbp_get_topic_forum_id() To get the topic forum id
     105         * @uses apply_filters() Calls 'bbp_get_forum_id' with the forum id
     106         * @return int Forum id
     107         */
     108        function bbp_get_forum_id( $forum_id = 0 ) {
    107109                global $bbp, $wp_query;
    108110
    … …  
    130132                $bbp->current_forum_id = $bbp_forum_id;
    131133
    132                 return apply_filters( 'bbp_get_forum_id', (int)$bbp_forum_id );
    133         }
    134 
    135 /**
    136  * bbp_forum_permalink ()
    137  *
     134                return apply_filters( 'bbp_get_forum_id', (int) $bbp_forum_id );
     135        }
     136
     137/**
    138138 * Output the link to the forum
    139139 *
    140  * @package bbPress
    141  * @subpackage Template Tags
    142  * @since bbPress (r2464)
    143  *
    144  * @param int $forum_id optional
    145  * @uses bbp_get_forum_permalink()
    146  */
    147 function bbp_forum_permalink ( $forum_id = 0 ) {
     140 * @since bbPress (r2464)
     141 *
     142 * @param int $forum_id Optional. Forum id
     143 * @uses bbp_get_forum_permalink() To get the permalink
     144 */
     145function bbp_forum_permalink( $forum_id = 0 ) {
    148146        echo bbp_get_forum_permalink( $forum_id );
    149147}
    150148        /**
    151          * bbp_get_forum_permalink ()
    152          *
    153149         * Return the link to the forum
    154150         *
    155          * @package bbPress
    156          * @subpackage Template Tags
    157151         * @since bbPress (r2464)
    158152         *
    159          * @param int $forum_id optional
    160          * @uses apply_filters
    161          * @uses get_permalink
     153         * @param int $forum_id Optional. Forum id
     154         * @uses bbp_get_forum_id() To get the forum id
     155         * @uses get_permalink() Get the permalink of the forum
     156         * @uses apply_filters() Calls 'bbp_get_forum_permalink' with the forum
     157         *                        link
    162158         * @return string Permanent link to forum
    163159         */
    164         function bbp_get_forum_permalink ( $forum_id = 0 ) {
     160        function bbp_get_forum_permalink( $forum_id = 0 ) {
    165161                $forum_id = bbp_get_forum_id( $forum_id );
    166162                return apply_filters( 'bbp_get_forum_permalink', get_permalink( $forum_id ) );
    … …  
    168164
    169165/**
    170  * bbp_forum_title ()
    171  *
    172166 * Output the title of the forum in the loop
    173167 *
    174  * @package bbPress
    175  * @subpackage Template Tags
    176  * @since bbPress (r2464)
    177  *
    178  * @param int $forum_id optional
    179  * @uses bbp_get_forum_title()
    180  */
    181 function bbp_forum_title ( $forum_id = 0 ) {
     168 * @since bbPress (r2464)
     169 *
     170 * @param int $forum_id Optional. Forum id
     171 * @uses bbp_get_forum_title() To get the forum title
     172 */
     173function bbp_forum_title( $forum_id = 0 ) {
    182174        echo bbp_get_forum_title( $forum_id );
    183175}
    184176        /**
    185          * bbp_get_forum_title ()
    186          *
    187177         * Return the title of the forum in the loop
    188178         *
    189          * @package bbPress
    190          * @subpackage Template Tags
    191179         * @since bbPress (r2464)
    192180         *
    193          * @param int $forum_id optional
    194          * @uses apply_filters
    195          * @uses get_the_title()
     181         * @param int $forum_id Optional. Forum id
     182         * @uses bbp_get_forum_id() To get the forum id
     183         * @uses get_the_title() To get the forum title
     184         * @uses apply_filters() Calls 'bbp_get_forum_title' with the title
    196185         * @return string Title of forum
    197          *
    198          */
    199         function bbp_get_forum_title ( $forum_id = 0 ) {
     186         */
     187        function bbp_get_forum_title( $forum_id = 0 ) {
    200188                $forum_id = bbp_get_forum_id( $forum_id );
    201189
    … …  
    204192
    205193/**
    206  * bbp_forum_last_active ()
    207  *
    208194 * Output the forums last update date/time (aka freshness)
    209195 *
    210  * @package bbPress
    211  * @subpackage Template Tags
    212  * @since bbPress (r2464)
    213  *
    214  * @uses bbp_get_forum_last_active()
    215  * @param int $forum_id optional
    216  */
    217 function bbp_forum_last_active ( $forum_id = 0 ) {
     196 * @since bbPress (r2464)
     197 *
     198 * @uses bbp_get_forum_last_active() To get the forum freshness
     199 * @param int $forum_id Optional. Forum id
     200 */
     201function bbp_forum_last_active( $forum_id = 0 ) {
    218202        echo bbp_get_forum_last_active( $forum_id );
    219203}
    220204        /**
    221          * bbp_get_forum_last_active ()
    222          *
    223205         * Return the forums last update date/time (aka freshness)
    224206         *
    225          * @package bbPress
    226          * @subpackage Template Tags
    227207         * @since bbPress (r2464)
    228208         *
    229          * @return string
    230          * @param int $forum_id optional
    231          */
    232         function bbp_get_forum_last_active ( $forum_id = 0 ) {
     209         * @param int $forum_id Optional. Forum id
     210         * @uses bbp_get_forum_id() To get the forum id
     211         * @uses get_post_meta() To retrieve forum last active meta
     212         * @uses bbp_get_forum_last_reply_id() To get forum's last reply id
     213         * @uses get_post_field() To get the post date of the reply
     214         * @uses bbp_get_forum_last_topic_id() To get forum's last topic id
     215         * @uses bbp_get_topic_last_active() To get time when the topic was
     216         *                                    last active
     217         * @uses bbp_convert_date() To convert the date
     218         * @uses bbp_get_time_since() To get time in since format
     219         * @uses apply_filters() Calls 'bbp_get_forum_last_active' with last
     220         *                        active time and forum id
     221         * @return string Forum last update date/time (freshness)
     222         */
     223        function bbp_get_forum_last_active( $forum_id = 0 ) {
    233224                $forum_id = bbp_get_forum_id( $forum_id );
    234225
    … …  
    238229                        } else {
    239230                                if ( $topic_id = bbp_get_forum_last_topic_id( $forum_id ) ) {
    240                                         $last_active = bbp_get_topic_last_active( $forum_id, '_bbp_forum_last_active', true );
     231                                        $last_active = bbp_get_topic_last_active( $topic_id );
    241232                                }
    242233                        }
    … …  
    245236                $last_active = !empty( $last_active ) ? bbp_get_time_since( bbp_convert_date( $last_active ) ) : '';
    246237
    247                 return apply_filters( 'bbp_get_forum_last_active', $last_active );
    248         }
    249 
    250 /**
    251  * bbp_get_forum_parent ()
    252  *
     238                return apply_filters( 'bbp_get_forum_last_active', $last_active, $forum_id );
     239        }
     240
     241/**
     242 * Output link to the most recent activity inside a forum.
     243 *
     244 * Outputs a complete link with attributes and content.
     245 *
     246 * @since bbPress (r2625)
     247 *
     248 * @param int $forum_id Optional. Forum id
     249 * @uses bbp_get_forum_freshness_link() To get the forum freshness link
     250 */
     251function bbp_forum_freshness_link( $forum_id = 0) {
     252        echo bbp_get_forum_freshness_link( $forum_id );
     253}
     254        /**
     255         * Returns link to the most recent activity inside a forum.
     256         *
     257         * Returns a complete link with attributes and content.
     258         *
     259         * @since bbPress (r2625)
     260         *
     261         * @param int $forum_id Optional. Forum id
     262         * @uses bbp_get_forum_id() To get the forum id
     263         * @uses bbp_get_forum_last_reply_url() To get the forum last reply url
     264         * @uses bbp_get_forum_last_reply_title() To get the forum last reply
     265         *                                         title
     266         * @uses bbp_get_forum_last_active() To get the time when the forum was
     267         *                                    last active
     268         * @uses apply_filters() Calls 'bbp_get_forum_freshness_link' with the
     269         *                        link and forum id
     270         */
     271        function bbp_get_forum_freshness_link( $forum_id = 0 ) {
     272                $forum_id   = bbp_get_forum_id( $forum_id );
     273                $link_url   = bbp_get_forum_last_reply_url( $forum_id );
     274                $title      = bbp_get_forum_last_reply_title( $forum_id );
     275                $time_since = bbp_get_forum_last_active( $forum_id );
     276
     277                if ( !empty( $time_since ) )
     278                        $anchor = '<a href="' . $link_url . '" title="' . esc_attr( $title ) . '">' . $time_since . '</a>';
     279                else
     280                        $anchor = __( 'No Topics', 'bbpress' );
     281
     282                return apply_filters( 'bbp_get_forum_freshness_link', $anchor, $forum_id );
     283        }
     284
     285/**
    253286 * Return ID of forum parent, if exists
    254287 *
    255  * @package bbPress
    256  * @subpackage Template Tags
    257288 * @since bbPress (r2625)
    258289 *
    259  * @param int $forum_id
    260  * @return int
    261  */
    262 function bbp_get_forum_parent ( $forum_id = 0 ) {
     290 * @param int $forum_id Optional. Forum id
     291 * @uses bbp_get_forum_id() To get the forum id
     292 * @uses get_post_field() To get the forum parent
     293 * @uses apply_filters() Calls 'bbp_get_forum_parent' with the parent & forum id
     294 * @return int Forum parent
     295 */
     296function bbp_get_forum_parent( $forum_id = 0 ) {
    263297        $forum_id = bbp_get_forum_id( $forum_id );
    264         return apply_filters( 'bbp_get_forum_parent', (int)get_post_field( 'post_parent', $forum_id ) );
    265 }
    266 
    267 /**
    268  * bbp_get_forum_ancestors ()
    269  *
     298        return apply_filters( 'bbp_get_forum_parent', (int) get_post_field( 'post_parent', $forum_id ), $forum_id );
     299}
     300
     301/**
    270302 * Return array of parent forums
    271303 *
    272  * @package bbPress
    273  * @subpackage Template Tags
    274304 * @since bbPress (r2625)
    275305 *
    276  * @param int $forum_id
    277  * @return array
    278  */
    279 function bbp_get_forum_ancestors ( $forum_id = 0 ) {
     306 * @param int $forum_id Optional. Forum id
     307 * @uses bbp_get_forum_id() To get the forum id
     308 * @uses get_post() To get the forum
     309 * @uses apply_filters() Calls 'bbp_get_forum_ancestors' with the ancestors
     310 *                        and forum id
     311 * @return array Forum ancestors
     312 */
     313function bbp_get_forum_ancestors( $forum_id = 0 ) {
    280314        $forum_id = bbp_get_forum_id( $forum_id );
    281315
    … …  
    292326
    293327/**
    294  * bbp_forum_has_sub_forums ()
    295  *
    296  * Return sub forums of given forum
    297  *
    298  * @package bbPress
    299  * @subpackage Template Tags
    300  * @since bbPress (r2705)
     328 * Return subforums of given forum
     329 *
     330 * @since bbPress (r2747)
    301331 *
    302332 * @param mixed $args All the arguments supported by {@link WP_Query}
    303  * @return false if none, array of subs if yes
    304  */
    305 function bbp_forum_has_sub_forums ( $args = '' ) {
     333 * @uses bbp_get_forum_id() To get the forum id
     334 * @uses current_user_can() To check if the current user is capable of
     335 *                           reading private forums
     336 * @uses get_posts() To get the subforums
     337 * @uses apply_filters() Calls 'bbp_forum_has_subforums' with the subforums
     338 *                        and the args
     339 * @return mixed false if none, array of subs if yes
     340 */
     341function bbp_forum_has_subforums( $args = '' ) {
    306342        global $bbp;
    307343
    … …  
    333369
    334370/**
    335  * bbp_list_forums ()
    336  *
    337  * Output a list of forums (can be used to list sub forums)
    338  *
    339  * @param int $forum_id
    340  */
    341 function bbp_list_forums ( $args = '' ) {
     371 * Output a list of forums (can be used to list subforums)
     372 *
     373 * @todo - Implement reply counts.
     374 *
     375 * @param mixed $args The function supports these args:
     376 *  - before: To put before the output. Defaults to '<ul class="bbp-forums">'
     377 *  - after: To put after the output. Defaults to '</ul>'
     378 *  - link_before: To put before every link. Defaults to '<li class="bbp-forum">'
     379 *  - link_after: To put after every link. Defaults to '</li>'
     380 *  - separator: Separator. Defaults to ', '
     381 *  - forum_id: Forum id. Defaults to ''
     382 *  - show_topic_count - To show forum topic count or not. Defaults to true
     383 *  - show_reply_count - To show forum reply count or not. Defaults to true
     384 * @uses bbp_forum_has_subforums() To check if the forum has subforums or not
     385 * @uses bbp_get_forum_permalink() To get forum permalink
     386 * @uses bbp_get_forum_title() To get forum title
     387 * @uses bbp_is_forum_category() To check if a forum is a category
     388 * @uses bbp_get_forum_topic_count() To get forum topic count
     389 * @uses bbp_get_forum_reply_count() To get forum reply count
     390 */
     391function bbp_list_forums( $args = '' ) {
    342392        global $bbp;
    343393
    … …  
    361411
    362412        // Loop through forums and create a list
    363         if ( $sub_forums = bbp_forum_has_sub_forums( $forum_id ) ) {
     413        if ( $sub_forums = bbp_forum_has_subforums( $forum_id ) ) {
    364414                // Total count (for separator)
    365415                $total_subs = count( $sub_forums );
    … …  
    373423
    374424                        // Show topic and reply counts
    375                         if ( !empty( $show_topic_count ) )
     425                        if ( !empty( $show_topic_count ) && !bbp_is_forum_category( $sub_forum->ID ) )
    376426                                $topic_count = ' (' . bbp_get_forum_topic_count( $sub_forum->ID ) . ')';
    377427
    378                         // @todo - Walk tree and update counts
    379                         //if ( !empty( $show_reply_count ) )
     428                        //if ( !empty( $show_reply_count ) && !bbp_is_forum_category( $sub_forum->ID ) )
    380429                        //      $reply_count = ' (' . bbp_get_forum_reply_count( $sub_forum->ID ) . ')';
    381430
    … …  
    391440
    392441/**
    393  * bbp_forum_last_topic_id ()
    394  *
    395  * Output the forums last topic id
    396  *
    397  * @package bbPress
    398  * @subpackage Template Tags
    399  * @since bbPress (r2464)
    400  *
    401  * @uses bbp_get_forum_last_active()
    402  * @param int $forum_id optional
    403  */
    404 function bbp_forum_last_topic_id ( $forum_id = 0 ) {
     442 * Output the forum's last topic id
     443 *
     444 * @since bbPress (r2464)
     445 *
     446 * @uses bbp_get_forum_last_active() To get the forum's last topic id
     447 * @param int $forum_id Optional. Forum id
     448 */
     449function bbp_forum_last_topic_id( $forum_id = 0 ) {
    405450        echo bbp_get_forum_last_topic_id( $forum_id );
    406451}
    407452        /**
    408          * bbp_get_forum_last_topic_id ()
    409          *
    410          * Return the forums last topic
    411          *
    412          * @package bbPress
    413          * @subpackage Template Tags
     453         * Return the forum's last topic id
     454         *
    414455         * @since bbPress (r2464)
    415456         *
    416          * @return string
    417          * @param int $forum_id optional
    418          */
    419         function bbp_get_forum_last_topic_id ( $forum_id = 0 ) {
     457         * @param int $forum_id Optional. Forum id
     458         * @uses bbp_get_forum_id() To get the forum id
     459         * @uses get_post_meta() To get the forum's last topic id
     460         * @uses apply_filters() Calls 'bbp_get_forum_last_topic_id' with the
     461         *                        forum and topic id
     462         * @return int Forum's last topic id
     463         */
     464        function bbp_get_forum_last_topic_id( $forum_id = 0 ) {
    420465                $forum_id = bbp_get_forum_id( $forum_id );
    421466                $topic_id = get_post_meta( $forum_id, '_bbp_forum_last_topic_id', true );
    422467
    423                 return apply_filters( 'bbp_get_forum_last_topic_id', $topic_id );
    424         }
    425 
    426 /**
    427  * bbp_forum_last_topic_title ()
    428  *
     468                return apply_filters( 'bbp_get_forum_last_topic_id', $topic_id, $forum_id );
     469        }
     470
     471/**
    429472 * Output the title of the last topic inside a forum
    430473 *
    431  * @package bbPress
    432  * @subpackage Template Tags
    433474 * @since bbPress (r2625)
    434475 *
    435  * @param int $forum_id
    436  */
    437 function bbp_forum_last_topic_title ( $forum_id = 0 ) {
     476 * @param int $forum_id Optional. Forum id
     477 * @uses bbp_get_forum_last_topic_title() To get the forum's last topic's title
     478 */
     479function bbp_forum_last_topic_title( $forum_id = 0 ) {
    438480        echo bbp_get_forum_last_topic_title( $forum_id );
    439481}
    440482        /**
    441          * bbp_get_forum_last_topic_title ()
    442          *
    443483         * Return the title of the last topic inside a forum
    444484         *
    445          * @package bbPress
    446          * @subpackage Template Tags
    447485         * @since bbPress (r2625)
    448486         *
    449          * @param int $forum_id
    450          * @return string
     487         * @param int $forum_id Optional. Forum id
     488         * @uses bbp_get_forum_id() To get the forum id
     489         * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
     490         * @uses bbp_get_topic_title() To get the topic's title
     491         * @uses apply_filters() Calls 'bbp_get_forum_last_topic_title' with the
     492         *                        topic title and forum id
     493         * @return string Forum's last topic's title
    451494         */
    452495        function bbp_get_forum_last_topic_title( $forum_id = 0 ) {
    453496                $forum_id = bbp_get_forum_id( $forum_id );
    454                 return apply_filters( 'bbp_get_forum_last_topic_title', bbp_get_topic_title( bbp_get_forum_last_topic_id( $forum_id ) ) );
    455         }
    456 
    457 /**
    458  * bbp_forum_last_topic_permalink ()
    459  *
     497                return apply_filters( 'bbp_get_forum_last_topic_title', bbp_get_topic_title( bbp_get_forum_last_topic_id( $forum_id ) ), $forum_id );
     498        }
     499
     500/**
    460501 * Output the link to the last topic in a forum
    461502 *
    462  * @package bbPress
    463  * @subpackage Template Tags
    464  * @since bbPress (r2464)
    465  *
    466  * @param int $forum_id optional
    467  * @uses bbp_get_forum_permalink()
    468  */
    469 function bbp_forum_last_topic_permalink ( $forum_id = 0 ) {
     503 * @since bbPress (r2464)
     504 *
     505 * @param int $forum_id Optional. Forum id
     506 * @uses bbp_get_forum_last_topic_permalink() To get the forum's last topic's
     507 *                                             permanent link
     508 */
     509function bbp_forum_last_topic_permalink( $forum_id = 0 ) {
    470510        echo bbp_get_forum_last_topic_permalink( $forum_id );
    471511}
    472512        /**
    473          * bbp_get_forum_last_topic_permalink ()
    474          *
    475513         * Return the link to the last topic in a forum
    476514         *
    477          * @package bbPress
    478          * @subpackage Template Tags
    479515         * @since bbPress (r2464)
    480516         *
    481          * @param int $forum_id optional
    482          * @uses apply_filters
    483          * @uses get_permalink
     517         * @param int $forum_id Optional. Forum id
     518         * @uses bbp_get_forum_id() To get the forum id
     519         * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
     520         * @uses bbp_get_topic_permalink() To get the topic's permalink
     521         * @uses apply_filters() Calls 'bbp_get_forum_last_topic_permalink' with
     522         *                        the topic link and forum id
    484523         * @return string Permanent link to topic
    485524         */
    486         function bbp_get_forum_last_topic_permalink ( $forum_id = 0 ) {
     525        function bbp_get_forum_last_topic_permalink( $forum_id = 0 ) {
    487526                $forum_id = bbp_get_forum_id( $forum_id );
    488                 return apply_filters( 'bbp_get_forum_last_topic_permalink', bbp_get_topic_permalink( bbp_get_forum_last_topic_id( $forum_id ) ) );
     527                return apply_filters( 'bbp_get_forum_last_topic_permalink', bbp_get_topic_permalink( bbp_get_forum_last_topic_id( $forum_id ) ), $forum_id );
     528        }
     529
     530/**
     531 * Return the author ID of the last topic of a forum
     532 *
     533 * @since bbPress (r2625)
     534 *
     535 * @param int $forum_id Optional. Forum id
     536 * @uses bbp_get_forum_id() To get the forum id
     537 * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
     538 * @uses bbp_get_topic_author_id() To get the topic's author id
     539 * @uses apply_filters() Calls 'bbp_get_forum_last_topic_author' with the author
     540 *                        id and forum id
     541 * @return int Forum's last topic's author id
     542 */
     543function bbp_get_forum_last_topic_author_id( $forum_id = 0 ) {
     544        $forum_id  = bbp_get_forum_id( $forum_id );
     545        $author_id = bbp_get_topic_author_id( bbp_get_forum_last_topic_id( $forum_id ) );
     546        return apply_filters( 'bbp_get_forum_last_topic_author_id', $author_id, $forum_id );
     547}
     548
     549/**
     550 * Output link to author of last topic of forum
     551 *
     552 * @since bbPress (r2625)
     553 *
     554 * @param int $forum_id Optional. Forum id
     555 * @uses bbp_get_forum_last_topic_author_link() To get the forum's last topic's
     556 *                                               author link
     557 */
     558function bbp_forum_last_topic_author_link( $forum_id = 0 ) {
     559        echo bbp_get_forum_last_topic_author_link( $forum_id );
     560}
     561        /**
     562         * Return link to author of last topic of forum
     563         *
     564         * @since bbPress (r2625)
     565         *
     566         * @param int $forum_id Optional. Forum id
     567         * @uses bbp_get_forum_id() To get the forum id
     568         * @uses bbp_get_forum_last_topic_author_id() To get the forum's last
     569         *                                             topic's author id
     570         * @uses bbp_get_user_profile_link() To get the author's profile link
     571         * @uses apply_filters() Calls 'bbp_get_forum_last_topic_author_link'
     572         *                        with the author link and forum id
     573         * @return string Forum's last topic's author link
     574         */
     575        function bbp_get_forum_last_topic_author_link( $forum_id = 0 ) {
     576                $forum_id    = bbp_get_forum_id( $forum_id );
     577                $author_id   = bbp_get_forum_last_topic_author_id( $forum_id );
     578                $author_link = bbp_get_user_profile_link( $author_id );
     579                return apply_filters( 'bbp_get_forum_last_topic_author_link', $author_link, $forum_id );
    489580        }
    490581
    … …  
    492583
    493584/**
    494  * bbp_forum_last_reply_id ()
    495  *
    496585 * Output the forums last reply id
    497586 *
    498  * @package bbPress
    499  * @subpackage Template Tags
    500  * @since bbPress (r2464)
    501  *
    502  * @uses bbp_get_forum_last_reply_id()
    503  * @param int $forum_id optional
    504  */
    505 function bbp_forum_last_reply_id ( $forum_id = 0 ) {
     587 * @since bbPress (r2464)
     588 *
     589 * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
     590 * @param int $forum_id Optional. Forum id
     591 */
     592function bbp_forum_last_reply_id( $forum_id = 0 ) {
    506593        echo bbp_get_forum_last_reply_id( $forum_id );
    507594}
    508595        /**
    509          * bbp_get_forum_last_reply_id ()
    510          *
    511596         * Return the forums last reply id
    512597         *
    513          * @package bbPress
    514          * @subpackage Template Tags
    515598         * @since bbPress (r2464)
    516599         *
    517          * @return string
    518          * @param int $forum_id optional
    519          */
    520         function bbp_get_forum_last_reply_id ( $forum_id = 0 ) {
     600         * @param int $forum_id Optional. Forum id
     601         * @uses bbp_get_forum_id() To get the forum id
     602         * @uses get_post_meta() To get the forum's last reply id
     603         * @uses bbp_update_forum_last_reply_id() To update and get the last
     604         *                                         reply id of the forum
     605         * @uses apply_filters() Calls 'bbp_get_forum_last_reply_id' with
     606         *                        the last reply id and forum id
     607         * @return int Forum's last reply id
     608         */
     609        function bbp_get_forum_last_reply_id( $forum_id = 0 ) {
    521610                $forum_id = bbp_get_forum_id( $forum_id );
    522611                $reply_id = get_post_meta( $forum_id, '_bbp_forum_last_reply_id', true );
    … …  
    525614                        $reply_id = bbp_update_forum_last_reply_id( $forum_id );
    526615
    527                 return apply_filters( 'bbp_get_forum_last_reply_id', $reply_id );
    528         }
    529 
    530 /**
    531  * bbp_forum_last_reply_title ()
    532  *
     616                return apply_filters( 'bbp_get_forum_last_reply_id', $reply_id, $forum_id );
     617        }
     618
     619/**
    533620 * Output the title of the last reply inside a forum
    534621 *
    535  * @param int $forum_id
    536  */
    537 function bbp_forum_last_reply_title ( $forum_id = 0 ) {
     622 * @param int $forum_id Optional. Forum id
     623 * @uses bbp_get_forum_last_reply_title() To get the forum's last reply's title
     624 */
     625function bbp_forum_last_reply_title( $forum_id = 0 ) {
    538626        echo bbp_get_forum_last_reply_title( $forum_id );
    539627}
    540628        /**
    541          * bbp_get_forum_last_reply_title ()
    542          *
    543629         * Return the title of the last reply inside a forum
    544630         *
    545          * @param int $forum_id
     631         * @param int $forum_id Optional. Forum id
     632         * @uses bbp_get_forum_id() To get the forum id
     633         * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
     634         * @uses bbp_get_reply_title() To get the reply title
     635         * @uses apply_filters() Calls 'bbp_get_forum_last_reply_title' with the
     636         *                        reply title and forum id
    546637         * @return string
    547638         */
    548639        function bbp_get_forum_last_reply_title( $forum_id = 0 ) {
    549640                $forum_id = bbp_get_forum_id( $forum_id );
    550                 return apply_filters( 'bbp_get_forum_last_topic_title', bbp_get_reply_title( bbp_get_forum_last_reply_id( $forum_id ) ) );
    551         }
    552 
    553 /**
    554  * bbp_forum_last_reply_permalink ()
    555  *
     641                return apply_filters( 'bbp_get_forum_last_reply_title', bbp_get_reply_title( bbp_get_forum_last_reply_id( $forum_id ) ), $forum_id );
     642        }
     643
     644/**
    556645 * Output the link to the last reply in a forum
    557646 *
    558  * @package bbPress
    559  * @subpackage Template Tags
    560  * @since bbPress (r2464)
    561  *
    562  * @param int $forum_id optional
    563  * @uses bbp_get_forum_permalink()
    564  */
    565 function bbp_forum_last_reply_permalink ( $forum_id = 0 ) {
     647 * @since bbPress (r2464)
     648 *
     649 * @param int $forum_id Optional. Forum id
     650 * @uses bbp_get_forum_last_reply_permalink() To get the forum last reply link
     651 */
     652function bbp_forum_last_reply_permalink( $forum_id = 0 ) {
    566653        echo bbp_get_forum_last_reply_permalink( $forum_id );
    567654}
    568655        /**
    569          * bbp_get_forum_last_reply_permalink ()
    570          *
    571656         * Return the link to the last reply in a forum
    572657         *
    573          * @package bbPress
    574          * @subpackage Template Tags
    575658         * @since bbPress (r2464)
    576659         *
    577          * @param int $forum_id optional
    578          * @uses apply_filters
    579          * @uses get_permalink
    580          * @return string Permanent link to topic
    581          */
    582         function bbp_get_forum_last_reply_permalink ( $forum_id = 0 ) {
     660         * @param int $forum_id Optional. Forum id
     661         * @uses bbp_get_forum_id() To get the forum id
     662         * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
     663         * @uses bbp_get_reply_permalink() To get the reply permalink
     664         * @uses apply_filters() Calls 'bbp_get_forum_last_reply_permalink' with
     665         *                        the reply link and forum id
     666         * @return string Permanent link to the forum's last reply
     667         */
     668        function bbp_get_forum_last_reply_permalink( $forum_id = 0 ) {
    583669                $forum_id = bbp_get_forum_id( $forum_id );
    584                 return apply_filters( 'bbp_get_forum_last_reply_permalink', bbp_get_reply_permalink( bbp_get_forum_last_reply_id( $forum_id ) ) );
    585         }
    586 
    587 /**
    588  * bbp_forum_last_reply_url ()
    589  *
    590  * Output the link to the last reply in a forum
    591  *
    592  * @package bbPress
    593  * @subpackage Template Tags
     670                return apply_filters( 'bbp_get_forum_last_reply_permalink', bbp_get_reply_permalink( bbp_get_forum_last_reply_id( $forum_id ) ), $forum_id );
     671        }
     672
     673/**
     674 * Output the url to the last reply in a forum
     675 *
    594676 * @since bbPress (r2683)
    595677 *
    596  * @param int $forum_id optional
    597  * @uses bbp_get_forum_url()
    598  */
    599 function bbp_forum_last_reply_url ( $forum_id = 0 ) {
     678 * @param int $forum_id Optional. Forum id
     679 * @uses bbp_get_forum_last_reply_url() To get the forum last reply url
     680 */
     681function bbp_forum_last_reply_url( $forum_id = 0 ) {
    600682        echo bbp_get_forum_last_reply_url( $forum_id );
    601683}
    602684        /**
    603          * bbp_get_forum_last_reply_url ()
    604          *
    605          * Return the link to the last reply in a forum
    606          *
    607          * @package bbPress
    608          * @subpackage Template Tags
     685         * Return the url to the last reply in a forum
     686         *
    609687         * @since bbPress (r2683)
    610688         *
    611          * @param int $forum_id optional
    612          * @uses apply_filters
    613          * @uses get_url
     689         * @param int $forum_id Optional. Forum id
     690         * @uses bbp_get_forum_id() To get the forum id
     691         * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
     692         * @uses bbp_get_reply_url() To get the reply url
     693         * @uses bbp_get_forum_last_topic_permalink() To get the forum's last
     694         *                                             topic's permalink
     695         * @uses apply_filters() Calls 'bbp_get_forum_last_reply_url' with the
     696         *                        reply url and forum id
    614697         * @return string Paginated URL to latest reply
    615698         */
    616         function bbp_get_forum_last_reply_url ( $forum_id = 0 ) {
    617                 $forum_id  = bbp_get_forum_id( $forum_id );
     699        function bbp_get_forum_last_reply_url( $forum_id = 0 ) {
     700                $forum_id = bbp_get_forum_id( $forum_id );
    618701
    619702                // If forum has replies, get the last reply and use its url
    620                 if ( $reply_id  = bbp_get_forum_last_reply_id( $forum_id ) ) {
     703                if ( $reply_id = bbp_get_forum_last_reply_id( $forum_id ) ) {
    621704                        $reply_url = bbp_get_reply_url( $reply_id );
    622705
    623706                // No replies, so look for topics and use last permalink
    624707                } else {
    625                         if ( $topic_id = bbp_get_forum_last_topic_id( $forum_id ) ) {
    626                                 $reply_url = bbp_get_topic_permalink( $topic_id );
    627 
    628                         // No topics either, so set $reply_url as empty
    629                         } else {
     708                        if ( !$reply_url = bbp_get_forum_last_topic_permalink( $forum_id ) ) {
     709                                // No topics either, so set $reply_url as empty
    630710                                $reply_url = '';
    631711                        }
    … …  
    633713
    634714                // Filter and return
    635                 return apply_filters( 'bbp_get_forum_last_reply_url', $reply_url );
    636         }
    637 
    638 /**
    639  * bbp_forum_freshness_link ()
    640  *
    641  * Output link to the most recent activity inside a forum, complete with
    642  * link attributes and content.
    643  *
    644  * @package bbPress
    645  * @subpackage Template Tags
     715                return apply_filters( 'bbp_get_forum_last_reply_url', $reply_url, $forum_id );
     716        }
     717
     718/**
     719 * Output author ID of last reply of forum
     720 *
    646721 * @since bbPress (r2625)
    647722 *
    648  * @param int $forum_id
    649  */
    650 function bbp_forum_freshness_link ( $forum_id = 0) {
    651         echo bbp_get_forum_freshness_link( $forum_id );
    652 }
    653         /**
    654          * bbp_get_forum_freshness_link ()
    655          *
    656          * Returns link to the most recent activity inside a forum, complete with
    657          * link attributes and content.
    658          *
    659          * @package bbPress
    660          * @subpackage Template Tags
     723 * @param int $forum_id Optional. Forum id
     724 * @uses bbp_get_forum_last_reply_author_id() To get the forum's last reply
     725 *                                             author id
     726 */
     727function bbp_forum_last_reply_author_id( $forum_id = 0 ) {
     728        echo bbp_get_forum_last_reply_author_id( $forum_id );
     729}
     730        /**
     731         * Return author ID of last reply of forum
     732         *
    661733         * @since bbPress (r2625)
    662734         *
    663          * @param int $forum_id
    664          */
    665         function bbp_get_forum_freshness_link ( $forum_id = 0 ) {
    666                 $forum_id   = bbp_get_forum_id( $forum_id );
    667                 $link_url   = bbp_get_forum_last_reply_url( $forum_id );
    668                 $title      = bbp_get_forum_last_reply_title( $forum_id );
    669                 $time_since = bbp_get_forum_last_active( $forum_id );
    670 
    671                 if ( !empty( $time_since ) )
    672                         $anchor = '<a href="' . $link_url . '" title="' . esc_attr( $title ) . '">' . $time_since . '</a>';
    673                 else
    674                         $anchor = __( 'No Topics', 'bbpress' );
    675 
    676                 return apply_filters( 'bbp_get_forum_freshness_link', $anchor );
    677         }
    678 
    679 /**
    680  * bbp_get_forum_last_topic_author_id ()
    681  *
    682  * Return the author ID of the last topic of a forum
    683  *
    684  * @package bbPress
    685  * @subpackage Template Tags
     735         * @param int $forum_id Optional. Forum id
     736         * @uses bbp_get_forum_id() To get the forum id
     737         * @uses bbp_get_forum_last_reply_author_id() To get the forum's last
     738         *                                             reply's author id
     739         * @uses bbp_get_reply_author_id() To get the reply's author id
     740         * @uses apply_filters() Calls 'bbp_get_forum_last_reply_author_id' with
     741         *                        the author id and forum id
     742         * @return int Forum's last reply author id
     743         */
     744        function bbp_get_forum_last_reply_author_id( $forum_id = 0 ) {
     745                $forum_id  = bbp_get_forum_id( $forum_id );
     746                $author_id = bbp_get_reply_author_id( bbp_get_forum_last_reply_id( $forum_id ) );
     747                return apply_filters( 'bbp_get_forum_last_reply_author_id', $author_id, $forum_id );
     748        }
     749
     750/**
     751 * Output link to author of last reply of forum
     752 *
    686753 * @since bbPress (r2625)
    687754 *
    688  * @param int $forum_id
    689  */
    690 function bbp_get_forum_last_topic_author_id ( $forum_id = 0 ) {
    691         $forum_id  = bbp_get_forum_id( $forum_id );
    692         $author_id = get_post_field( 'post_author', bbp_get_forum_last_topic_id( $forum_id ) );
    693         return apply_filters( 'bbp_get_forum_last_topic_author', $author_id );
    694 }
    695 
    696 /**
    697  * bbp_forum_last_topic_author_link ()
    698  *
    699  * Output link to author of last topic of forum
    700  *
    701  * @package bbPress
    702  * @subpackage Template Tags
    703  * @since bbPress (r2625)
    704  *
    705  * @param int $forum_id
    706  */
    707 function bbp_forum_last_topic_author_link ( $forum_id = 0 ) {
    708         echo bbp_get_forum_last_topic_author_link( $forum_id );
    709 }
    710         /**
    711          * bbp_get_forum_last_topic_author_link ()
    712          *
    713          * Return link to author of last topic of forum
    714          *
    715          * @package bbPress
    716          * @subpackage Template Tags
     755 * @param int $forum_id Optional. Forum id
     756 * @uses bbp_get_forum_last_reply_author_link() To get the forum's last reply's
     757 *                                               author link
     758 */
     759function bbp_forum_last_reply_author_link( $forum_id = 0 ) {
     760        echo bbp_get_forum_last_reply_author_link( $forum_id );
     761}
     762        /**
     763         * Return link to author of last reply of forum
     764         *
    717765         * @since bbPress (r2625)
    718766         *
    719          * @param int $forum_id
    720          * @return string
    721          */
    722         function bbp_get_forum_last_topic_author_link ( $forum_id = 0 ) {
    723                 $forum_id    = bbp_get_forum_id( $forum_id );
    724                 $author_id   = bbp_get_forum_last_topic_author_id( $forum_id );
    725                 $author_link = bbp_get_user_profile_link( $author_id );
    726                 return apply_filters( 'bbp_get_forum_last_topic_author_link', $author_link );
    727         }
    728 
    729 /**
    730  * bbp_forum_last_reply_author_id ()
    731  *
    732  * Output author ID of last reply of forum
    733  *
    734  * @package bbPress
    735  * @subpackage Template Tags
    736  * @since bbPress (r2625)
    737  *
    738  * @param int $forum_id
    739  */
    740 function bbp_forum_last_reply_author_id ( $forum_id = 0 ) {
    741         echo bbp_get_forum_last_reply_author_id( $forum_id );
    742 }
    743         /**
    744          * bbp_get_forum_last_reply_author_id ()
    745          *
    746          * Return author ID of last reply of forum
    747          *
    748          * @package bbPress
    749          * @subpackage Template Tags
    750          * @since bbPress (r2625)
    751          *
    752          * @param int $forum_id
    753          */
    754         function bbp_get_forum_last_reply_author_id ( $forum_id = 0 ) {
    755                 $forum_id  = bbp_get_forum_id( $forum_id );
    756                 $author_id = get_post_field( 'post_author', bbp_get_forum_last_reply_id( $forum_id ) );
    757                 return apply_filters( 'bbp_get_forum_last_reply_author', $author_id );
    758         }
    759 
    760 /**
    761  * bbp_forum_last_reply_author_link ()
    762  *
    763  * Output link to author of last reply of forum
    764  *
    765  * @package bbPress
    766  * @subpackage Template Tags
    767  * @since bbPress (r2625)
    768  *
    769  * @param int $forum_id
    770  */
    771 function bbp_forum_last_reply_author_link ( $forum_id = 0 ) {
    772         echo bbp_get_forum_last_reply_author_link( $forum_id );
    773 }
    774         /**
    775          * bbp_get_forum_last_reply_author_link ()
    776          *
    777          * Return link to author of last reply of forum
    778          *
    779          * @package bbPress
    780          * @subpackage Template Tags
    781          * @since bbPress (r2625)
    782          *
    783          * @param int $forum_id
    784          * @return string
    785          */
    786         function bbp_get_forum_last_reply_author_link ( $forum_id = 0 ) {
     767         * @param int $forum_id Optional. Forum id
     768         * @uses bbp_get_forum_id() To get the forum id
     769         * @uses bbp_get_forum_last_reply_author_id() To get the forum's last
     770         *                                             reply's author id
     771         * @uses bbp_get_user_profile_link() To get the reply's author's profile
     772         *                                    link
     773         * @uses apply_filters() Calls 'bbp_get_forum_last_reply_author_link'
     774         *                        with the author link and forum id
     775         * @return string Link to author of last reply of forum
     776         */
     777        function bbp_get_forum_last_reply_author_link( $forum_id = 0 ) {
    787778                $forum_id    = bbp_get_forum_id( $forum_id );
    788779                $author_id   = bbp_get_forum_last_reply_author_id( $forum_id );
    789780                $author_link = bbp_get_user_profile_link( $author_id );
    790                 return apply_filters( 'bbp_get_forum_last_reply_author_link', $author_link );
     781                return apply_filters( 'bbp_get_forum_last_reply_author_link', $author_link, $forum_id );
    791782        }
    792783
    … …  
    794785
    795786/**
    796  * bbp_forum_subforum_count ()
    797  *
    798787 * Output total sub-forum count of a forum
    799788 *
    800  * @package bbPress
    801  * @subpackage Template Tags
    802  * @since bbPress (r2464)
    803  *
    804  * @uses bbp_get_forum_subforum_count()
    805  * @param int $forum_id optional Forum ID to check
    806  */
    807 function bbp_forum_subforum_count ( $forum_id = 0 ) {
     789 * @since bbPress (r2464)
     790 *
     791 * @uses bbp_get_forum_subforum_count() To get the forum's subforum count
     792 * @param int $forum_id Optional. Forum id to check
     793 */
     794function bbp_forum_subforum_count( $forum_id = 0 ) {
    808795        echo bbp_get_forum_subforum_count( $forum_id );
    809796}
    810797        /**
    811          * bbp_get_forum_subforum_count ()
    812          *
    813          * Return total sub-forum count of a forum
    814          *
    815          * @package bbPress
    816          * @subpackage Template Tags
     798         * Return total subforum count of a forum
     799         *
    817800         * @since bbPress (r2464)
    818801         *
    819          * @uses bbp_get_forum_id
    820          * @uses get_pages
    821          * @uses apply_filters
    822          *
    823          * @param int $forum_id optional Forum ID to check
    824          */
    825         function bbp_get_forum_subforum_count ( $forum_id = 0 ) {
     802         * @param int $forum_id Optional. Forum id
     803         * @uses bbp_get_forum_id() To get the forum id
     804         * @uses get_post_meta() To get the subforum count
     805         * @uses bbp_update_forum_subforum_count() To update the forum's
     806         *                                          subforum count if needed
     807         * @uses apply_filters() Calls 'bbp_get_forum_subforum_count' with the
     808         *                        subforum count and forum id
     809         * @return int Forum's subforum count
     810         */
     811        function bbp_get_forum_subforum_count( $forum_id = 0 ) {
    826812                $forum_id    = bbp_get_forum_id( $forum_id );
    827813                $forum_count = get_post_meta( $forum_id, '_bbp_forum_subforum_count', true );
    … …  
    830816                        $forum_count = bbp_update_forum_subforum_count( $forum_id );
    831817
    832                 return apply_filters( 'bbp_get_forum_subforum_count', $forum_count );
    833         }
    834 
    835 /**
    836  * bbp_forum_topic_count ()
    837  *
     818                return apply_filters( 'bbp_get_forum_subforum_count', (int) $forum_count, $forum_id );
     819        }
     820
     821/**
    838822 * Output total topic count of a forum
    839823 *
    840  * @package bbPress
    841  * @subpackage Template Tags
    842  * @since bbPress (r2464)
    843  *
    844  * @uses bbp_get_forum_topic_count()
    845  * @param int $forum_id optional Forum ID to check
    846  */
    847 function bbp_forum_topic_count ( $forum_id = 0 ) {
     824 * @since bbPress (r2464)
     825 *
     826 * @param int $forum_id Optional. Forum id
     827 * @uses bbp_get_forum_topic_count() To get the forum topic count
     828 */
     829function bbp_forum_topic_count( $forum_id = 0 ) {
    848830        echo bbp_get_forum_topic_count( $forum_id );
    849831}
    850832        /**
    851          * bbp_get_forum_topic_count ()
    852          *
    853833         * Return total topic count of a forum
    854834         *
    855          * @package bbPress
    856          * @subpackage Template Tags
    857835         * @since bbPress (r2464)
    858836         *
    859          * @todo stash and cache (see commented out code)
    860          *
    861          * @uses bbp_get_forum_id
    862          * @uses get_pages
    863          * @uses apply_filters
    864          *
    865          * @param int $forum_id optional Forum ID to check
    866          */
    867         function bbp_get_forum_topic_count ( $forum_id = 0 ) {
     837         * @param int $forum_id Optional. Forum id
     838         * @uses bbp_get_forum_id() To get the forum id
     839         * @uses get_post_meta() To get the forum topic count
     840         * @uses bbp_update_forum_topic_count() To update the topic count if
     841         *                                       needed
     842         * @uses apply_filters() Calls 'bbp_get_forum_topic_count' with the
     843         *                        topic count and forum id
     844         * @return int Forum topic count
     845         */
     846        function bbp_get_forum_topic_count( $forum_id = 0 ) {
    868847                $forum_id = bbp_get_forum_id( $forum_id );
    869848                $topics   = get_post_meta( $forum_id, '_bbp_forum_topic_count', true );
    … …  
    876855
    877856/**
    878  * bbp_forum_reply_count ()
    879  *
    880857 * Output total reply count of a forum
    881858 *
    882  * @package bbPress
    883  * @subpackage Template Tags
    884  * @since bbPress (r2464)
    885  *
    886  * @uses bbp_get_forum_topic_reply_count()
    887  * @param int $forum_id optional
    888  */
    889 function bbp_forum_reply_count ( $forum_id = 0 ) {
     859 * @since bbPress (r2464)
     860 *
     861 * @param int $forum_id Optional. Forum id
     862 * @uses bbp_get_forum_reply_count() To get the forum reply count
     863 */
     864function bbp_forum_reply_count( $forum_id = 0 ) {
    890865        echo bbp_get_forum_reply_count( $forum_id );
    891866}
    892867        /**
    893          * bbp_forum_reply_count ()
    894          *
    895868         * Return total post count of a forum
    896869         *
    897          * @package bbPress
    898          * @subpackage Template Tags
    899870         * @since bbPress (r2464)
    900871         *
    901          * @todo stash and cache (see commented out code)
    902          *
    903          * @uses bbp_get_forum_id()
    904          * @uses get_pages
    905          * @uses apply_filters
    906          *
    907          * @param int $forum_id optional
    908          */
    909         function bbp_get_forum_reply_count ( $forum_id = 0 ) {
     872         * @param int $forum_id Optional. Forum id
     873         * @uses bbp_get_forum_id() To get the forum id
     874         * @uses get_post_meta() To get the forum reply count
     875         * @uses bbp_update_forum_reply_count() To update the reply count if
     876         *                                       needed
     877         * @uses apply_filters() Calls 'bbp_get_forum_reply_count' with the
     878         *                        reply count and forum id
     879         * @return int Forum reply count
     880         */
     881        function bbp_get_forum_reply_count( $forum_id = 0 ) {
    910882                $forum_id = bbp_get_forum_id( $forum_id );
    911883                $replies  = get_post_meta( $forum_id, '_bbp_forum_reply_count', true );
    … …  
    918890
    919891/**
    920  * bbp_forum_voice_count ()
    921  *
    922892 * Output total voice count of a forum
    923893 *
    924  * @package bbPress
    925  * @subpackage Template Tags
    926894 * @since bbPress (r2567)
    927895 *
    928  * @uses bbp_get_forum_voice_count()
    929  * @uses apply_filters
    930  *
    931  * @param int $forum_id
    932  */
    933 function bbp_forum_voice_count ( $forum_id = 0 ) {
     896 * @param int $forum_id Optional. Forum id
     897 * @uses bbp_get_forum_voice_count() To get the forum voice count
     898 */
     899function bbp_forum_voice_count( $forum_id = 0 ) {
    934900        echo bbp_get_forum_voice_count( $forum_id );
    935901}
    936902        /**
    937          * bbp_get_forum_voice_count ()
    938          *
    939903         * Return total voice count of a forum
    940904         *
    941          * @package bbPress
    942          * @subpackage Template Tags
    943905         * @since bbPress (r2567)
    944906         *
    945          * @uses bbp_get_forum_id()
    946          * @uses apply_filters
    947          *
    948          * @param int $forum_id
    949          *
    950          * @return int Voice count of the forum
    951          */
    952         function bbp_get_forum_voice_count ( $forum_id = 0 ) {
     907         * @param int $forum_id Optional. Forum id
     908         * @uses bbp_get_forum_id() To get the forum id
     909         * @uses get_post_meta() To get the forum voice count
     910         * @uses bbp_update_forum_voice_count() To update the voice count if
     911         *                                       needed
     912         * @uses apply_filters() Calls 'bbp_get_forum_voice_count' with the
     913         *                        voice count and forum id
     914         * @return int Forum voice count
     915         */
     916        function bbp_get_forum_voice_count( $forum_id = 0 ) {
    953917                $forum_id = bbp_get_forum_id( $forum_id );
    954918                $voices   = get_post_meta( $forum_id, '_bbp_forum_voice_count', true );
    … …  
    961925
    962926/**
    963  * bbp_forum_status ()
    964  *
    965  * Output the status of the forum in the loop
    966  *
    967  * @package bbPress
    968  * @subpackage Template Tags
     927 * Output the status of the forum
     928 *
    969929 * @since bbPress (r2667)
    970  * @param int $forum_id optional
    971  *
    972  * @uses bbp_get_forum_status()
    973  */
    974 function bbp_forum_status ( $forum_id = 0 ) {
     930 *
     931 * @param int $forum_id Optional. Forum id
     932 * @uses bbp_get_forum_status() To get the forum status
     933 */
     934function bbp_forum_status( $forum_id = 0 ) {
    975935        echo bbp_get_forum_status( $forum_id );
    976936}
    977937        /**
    978          * bbp_get_forum_status ()
    979          *
    980          * Return the status of the forum in the loop
    981          *
    982          * @package bbPress
    983          * @subpackage Template Tags
     938         * Return the status of the forum
     939         *
    984940         * @since bbPress (r2667)
    985941         *
    986          * @uses apply_filters
    987          * @uses get_post_status()
    988          * @param int $forum_id optional
    989          *
     942         * @param int $forum_id Optional. Forum id
     943         * @uses bbp_get_forum_id() To get the forum id
     944         * @uses get_post_status() To get the forum's status
     945         * @uses apply_filters() Calls 'bbp_get_forum_status' with the status
     946         *                        and forum id
    990947         * @return string Status of forum
    991948         */
    992         function bbp_get_forum_status ( $forum_id = 0 ) {
     949        function bbp_get_forum_status( $forum_id = 0 ) {
    993950                $forum_id = bbp_get_forum_id( $forum_id );
    994951
    … …  
    12081165
    12091166/**
    1210  * bbp_forum_class ()
    1211  *
    12121167 * Output the row class of a forum
    12131168 *
    1214  * @package bbPress
    1215  * @subpackage Template Tags
    12161169 * @since bbPress (r2667)
    1217  */
    1218 function bbp_forum_class ( $forum_id = 0 ) {
    1219         echo bbp_get_forum_class( $forum_id );
    1220 }
    1221         /**
    1222          * bbp_get_forum_class ()
    1223          *
     1170 *
     1171 * @uses bbp_get_forum_class() To get the row class of the forum
     1172 */
     1173function bbp_forum_class() {
     1174        echo bbp_get_forum_class();
     1175}
     1176        /**
    12241177         * Return the row class of a forum
    12251178         *
    1226          * @package bbPress
    1227          * @subpackage Template Tags
    12281179         * @since bbPress (r2667)
    12291180         *
    1230          * @global WP_Query $bbp->forum_query
    1231          * @param int $forum_id
    1232          * @return string
    1233          */
    1234         function bbp_get_forum_class ( $forum_id = 0 ) {
     1181         * @uses post_class() To get all the classes including ours
     1182         * @uses apply_filters() Calls 'bbp_get_forum_class' with the classes
     1183         * @return string Row class of the forum
     1184         */
     1185        function bbp_get_forum_class() {
    12351186                global $bbp;
    12361187
    1237                 $alternate = $bbp->forum_query->current_post % 2 ? 'even' : 'odd';
    1238                 $status    = 'status-'  . bbp_get_forum_status();
    1239                 $post      = post_class( array( $alternate, $status ) );
     1188                $classes   = array();
     1189                $classes[] = $bbp->forum_query->current_post % 2 ? 'even' : 'odd';
     1190                $classes[] = bbp_is_forum_category() ? 'status-category' : '';
     1191                $classes[] = bbp_is_forum_private()  ? 'status-private'  : '';
     1192                $classes   = array_filter( $classes );
     1193
     1194                $post      = post_class( $classes );
    12401195
    12411196                return apply_filters( 'bbp_get_forum_class', $post );
    … …  
    12451200
    12461201/**
    1247  * bbp_update_forum_last_topic_id ()
    1248  *
    12491202 * Update the forum last topic id
    12501203 *
    1251  * @package bbPress
    1252  * @subpackage Template Tags
    12531204 * @since bbPress (r2625)
    12541205 *
    1255  * @todo everything
    1256  * @param int $forum_id
    1257  */
    1258 function bbp_update_forum_last_topic_id ( $forum_id = 0, $topic_id = 0 ) {
     1206 * @param int $forum_id Optional. Forum id
     1207 * @param int $topic_id Optional. Topic id
     1208 * @uses bbp_get_forum_id() To get the forum id
     1209 * @uses bbp_get_topic_id() To get the topic id
     1210 * @uses update_post_meta() To update the forum's last topic id meta
     1211 * @return bool True on success, false on failure
     1212 */
     1213function bbp_update_forum_last_topic_id( $forum_id = 0, $topic_id = 0 ) {
    12591214        $forum_id = bbp_get_forum_id( $forum_id );
    12601215        $topic_id = bbp_get_topic_id( $topic_id );
    12611216
    1262         // Update the last reply ID
    1263         if ( !empty( $topic_id ) ) {
    1264                 update_post_meta( $forum_id, '_bbp_forum_last_topic_id', $topic_id );
    1265                 return true;
    1266         }
     1217        // Update the last topic ID
     1218        if ( !empty( $topic_id ) )
     1219                return update_post_meta( $forum_id, '_bbp_forum_last_topic_id', $topic_id );
    12671220
    12681221        return false;
    … …  
    12701223
    12711224/**
    1272  * bbp_update_forum_last_reply_id ()
    1273  *
    12741225 * Update the forum last reply id
    12751226 *
    1276  * @package bbPress
    1277  * @subpackage Template Tags
    12781227 * @since bbPress (r2625)
    12791228 *
    1280  * @todo everything
    1281  * @param int $forum_id
    1282  */
    1283 function bbp_update_forum_last_reply_id ( $forum_id = 0, $reply_id = 0 ) {
     1229 * @param int $forum_id Optional. Forum id
     1230 * @param int $reply_id Optional. Reply id
     1231 * @uses bbp_get_forum_id() To get the forum id
     1232 * @uses bbp_get_reply_id() To get the reply id
     1233 * @uses update_post_meta() To update the forum's last reply id meta
     1234 * @return bool True on success, false on failure
     1235 */
     1236function bbp_update_forum_last_reply_id( $forum_id = 0, $reply_id = 0 ) {
    12841237        $forum_id = bbp_get_forum_id( $forum_id );
    12851238        $reply_id = bbp_get_reply_id( $reply_id );
    12861239
    12871240        // Update the last reply ID
    1288         if ( !empty( $reply_id ) ) {
    1289                 update_post_meta( $forum_id, '_bbp_forum_last_reply_id', $reply_id );
    1290                 return true;
    1291         }
     1241        if ( !empty( $reply_id ) )
     1242                return update_post_meta( $forum_id, '_bbp_forum_last_reply_id', $reply_id );
    12921243
    12931244        return false;
    … …  
    12951246
    12961247/**
    1297  * bbp_update_forum_last_active ()
    1298  *
    12991248 * Update the forums last active date/time (aka freshness)
    13001249 *
    1301  * @package bbPress
    1302  * @subpackage Template Tags
    13031250 * @since bbPress (r2680)
    13041251 *
    1305  * @param int $forum_id optional
    1306  *
    1307  * @return string
    1308  */
    1309 function bbp_update_forum_last_active ( $forum_id = 0, $new_time = '' ) {
     1252 * @param int $forum_id Optional. Forum id
     1253 * @param string $new_time Optional. New time in mysql format
     1254 * @uses bbp_get_forum_id() To get the forum id
     1255 * @uses current_time() To get the current time
     1256 * @uses update_post_meta() To update the forum's last active meta
     1257 * @return bool True on success, false on failure
     1258 */
     1259function bbp_update_forum_last_active( $forum_id = 0, $new_time = '' ) {
    13101260        $forum_id = bbp_get_forum_id( $forum_id );
    13111261
    … …  
    13141264                $new_time = current_time( 'mysql' );
    13151265
    1316         // Update the last reply ID
    1317         if ( !empty( $forum_id ) ) {
    1318                 update_post_meta( $forum_id, '_bbp_forum_last_active', $new_time );
    1319                 return true;
    1320         }
     1266        // Update last active
     1267        if ( !empty( $forum_id ) )
     1268                return update_post_meta( $forum_id, '_bbp_forum_last_active', $new_time );
    13211269
    13221270        return false;
    … …  
    13241272
    13251273/**
    1326  * bbp_update_forum_subforum_count ()
    1327  *
    13281274 * Update the forum sub-forum count
    13291275 *
    13301276 * @todo Make this work.
    13311277 *
    1332  * @package bbPress
    1333  * @subpackage Template Tags
    13341278 * @since bbPress (r2625)
    13351279 *
    1336  * @todo everything
    1337  * @param int $forum_id
    1338  */
    1339 function bbp_update_forum_subforum_count ( $forum_id = 0 ) {
     1280 * @param int $forum_id Optional. Forum id
     1281 * @uses bbp_get_forum_id() To get the forum id
     1282 * @return bool True on success, false on failure
     1283 */
     1284function bbp_update_forum_subforum_count( $forum_id = 0 ) {
    13401285        $forum_id = bbp_get_forum_id( $forum_id );
    1341 }
    1342 
    1343 /**
    1344  * bbp_update_forum_topic_count ()
    1345  *
     1286
     1287        return false;
     1288}
     1289
     1290/**
    13461291 * Adjust the total topic count of a forum
    13471292 *
    1348  * @package bbPress
    1349  * @subpackage Template Tags
    1350  * @since bbPress (r2464)
    1351  *
    1352  * @param int $forum_id optional
    1353  * @return int
    1354  */
    1355 function bbp_update_forum_topic_count ( $forum_id = 0 ) {
     1293 * @since bbPress (r2464)
     1294 *
     1295 * @param int $forum_id Optional. Forum id or topic id. It is checked whether it
     1296 *                       is a topic or a forum. If it's a topic, its parent,
     1297 *                       i.e. the forum is automatically retrieved.
     1298 * @uses get_post_field() To check whether the supplied id is a topic
     1299 * @uses bbp_get_topic_forum_id() To get the topic's forum id
     1300 * @uses wpdb::prepare() To prepare the sql statement
     1301 * @uses wpdb::get_col() To execute the query and get the column back
     1302 * @uses update_post_meta() To update the forum's topic count meta
     1303 * @uses apply_filters() Calls 'bbp_update_forum_topic_count' with the topic
     1304 *                        count and forum id
     1305 * @return int Forum topic count
     1306 */
     1307function bbp_update_forum_topic_count( $forum_id = 0 ) {
    13561308        global $wpdb, $bbp;
    13571309
    … …  
    13721324
    13731325/**
    1374  * bbp_update_forum_reply_count ()
    1375  *
    1376  * Adjust the total post count of a forum
     1326 * Adjust the total reply count of a forum
    13771327 *
    13781328 * @todo Make this work
    13791329 *
    1380  * @package bbPress
    1381  * @subpackage Template Tags
    1382  * @since bbPress (r2464)
    1383  *
    1384  * @uses bbp_get_forum_id()
    1385  * @uses apply_filters
    1386  *
    1387  * @param int $forum_id optional
    1388  *
    1389  * @return int
    1390  */
    1391 function bbp_update_forum_reply_count ( $forum_id = 0 ) {
     1330 * @since bbPress (r2464)
     1331 *
     1332 * @param int $forum_id Optional. Forum id or reply id. It is checked whether it
     1333 *                       is a reply or a forum. If it's a reply, its forum is
     1334 *                       automatically retrieved.
     1335 * @uses get_post_field() To check whether the supplied id is a reply
     1336 * @uses bbp_get_reply_topic_id() To get the reply's topic id
     1337 * @uses bbp_get_topic_forum_id() To get the topic's forum id
     1338 * @uses wpdb::prepare() To prepare the sql statement
     1339 * @uses wpdb::get_col() To execute the query and get the column back
     1340 * @uses update_post_meta() To update the forum's reply count meta
     1341 * @uses apply_filters() Calls 'bbp_update_forum_reply_count' with the reply
     1342 *                        count and forum id
     1343 * @return int Forum reply count
     1344 */
     1345function bbp_update_forum_reply_count( $forum_id = 0 ) {
    13921346        global $wpdb, $bbp;
    13931347
    … …  
    14101364
    14111365/**
    1412  * bbp_update_forum_voice_count ()
    1413  *
    14141366 * Adjust the total voice count of a forum
    14151367 *
    1416  * @package bbPress
    1417  * @subpackage Template Tags
    14181368 * @since bbPress (r2567)
    14191369 *
    1420  * @uses bbp_get_forum_id()
    1421  * @uses wpdb
    1422  * @uses apply_filters
    1423  *
    1424  * @todo cache
    1425  *
    1426  * @param int $forum_id optional Topic ID to update
    1427  *
    1428  * @return bool false on failure, voice count on success
    1429  */
    1430 function bbp_update_forum_voice_count ( $forum_id = 0 ) {
     1370 * @param int $forum_id Optional. Forum, topic or reply id. The forum is
     1371 *                                 automatically retrieved based on the input.
     1372 * @uses get_post_field() To check whether the supplied id is a reply
     1373 * @uses bbp_get_reply_topic_id() To get the reply's topic id
     1374 * @uses bbp_get_topic_forum_id() To get the topic's forum id
     1375 * @uses wpdb::prepare() To prepare the sql statement
     1376 * @uses wpdb::get_col() To execute the query and get the column back
     1377 * @uses update_post_meta() To update the forum's voice count meta
     1378 * @uses apply_filters() Calls 'bbp_update_forum_voice_count' with the voice
     1379 *                        count and forum id
     1380 * @return int Forum voice count
     1381 */
     1382function bbp_update_forum_voice_count( $forum_id = 0 ) {
    14311383        global $wpdb, $bbp;
    14321384
    14331385        $forum_id = bbp_get_forum_id( $forum_id );
    14341386
    1435         // If it is not a forum or reply, then we don't need it
    1436         if ( !in_array( get_post_field( 'post_type', $forum_id ), array( $bbp->forum_id, $bbp->reply_id ) ) )
    1437                 return false;
    1438 
    1439         // If it's a reply, then get the parent (forum id)
     1387        // If it's a reply, then get the parent (topic id)
    14401388        if ( $bbp->reply_id == get_post_field( 'post_type', $forum_id ) )
     1389                $forum_id = bbp_get_reply_topic_id( $forum_id );
     1390
     1391        // If it's a topic, then get the parent (forum id)
     1392        if ( $bbp->topic_id == get_post_field( 'post_type', $forum_id ) )
    14411393                $forum_id = bbp_get_topic_forum_id( $forum_id );
    14421394
  • branches/plugin/bbp-includes/bbp-functions.php

    r2757 r2758  
    11<?php
     2
    23/**
    34 * bbPress General Functions
    … …  
    67 * @subpackage Functions
    78 */
     9
    810/**
    911 * A bbPress specific method of formatting numeric values
  • branches/plugin/bbp-includes/bbp-general-template.php

    r2757 r2758  
    11<?php
     2
    23/**
    34 * bbPress General Template Tags
    … …  
    67 * @subpackage TemplateTags
    78 */
     9
    810/** START - WordPress Add-on Actions ******************************************/
    911
  • branches/plugin/bbp-includes/bbp-hooks.php

    r2756 r2758  
    55 *
    66 * @package bbPress
    7  * @subpackage Filters
     7 * @subpackage Hooks
    88 *
    99 * This file contains the actions and filters that are used through-out bbPress.
    … …  
    1313 * There are a few common places that additional actions can currently be found
    1414 *
    15  * bbPress - In bbPress::_setup_actions() in bbpress.php
    16  * Component - In BBP_Component::_setup_actions() in bbp-includes/bbp-classes.php
    17  * Admin - More in BBP_Admin::_setup_actions() in bbp-admin/bbp-admin.php
     15 *  - bbPress: In {@link bbPress::_setup_actions()} in bbpress.php
     16 *  - Component: In {@link BBP_Component::_setup_actions()} in
     17 *                bbp-includes/bbp-classes.php
     18 *  - Admin: More in {@link BBP_Admin::_setup_actions()} in
     19 *            bbp-admin/bbp-admin.php
    1820 */
    1921
  • branches/plugin/bbp-includes/bbp-reply-template.php

    r2757 r2758  
    11<?php
     2
    23/**
    34 * bbPress Reply Template Tags
    … …  
    67 * @subpackage TemplateTags
    78 */
     9
    810/** START - Reply Loop Functions **********************************************/
    911
  • branches/plugin/bbp-includes/bbp-topic-template.php

    r2757 r2758  
    11<?php
     2
    23/**
    34 * bbPress Topic Template Tags
    … …  
    67 * @subpackage TemplateTags
    78 */
     9
    810/** START - Topic Loop Functions **********************************************/
    911
  • branches/plugin/bbp-includes/bbp-user-template.php

    r2734 r2758  
    11<?php
    22
     3/**
     4 * bbPress User Functions
     5 *
     6 * @package bbPress
     7 * @subpackage TemplateTags
     8 */
     9
    310/** START User Functions ******************************************************/
    411
    512/**
    6  * bbp_user_id ()
    7  *
    8  * Output a validated user_id
    9  *
    10  * @param int $user_id
    11  * @param bool $current_user_fallback
    12  */
    13 function bbp_user_id ( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
     13 * Output a validated user id
     14 *
     15 * @since bbPress (r2729)
     16 *
     17 * @param int $user_id Optional. User id
     18 * @param bool $displayed_user_fallback Fallback on displayed user?
     19 * @param bool $current_user_fallback Fallback on current user?
     20 * @uses bbp_get_user_id() To get the user id
     21 */
     22function bbp_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
    1423        echo bbp_get_user_id( $user_id, $displayed_user_fallback, $current_user_fallback );
    1524}
    1625        /**
    17          * bbp_get_user_id ()
    18          *
    19          * Return a validated user_id
    20          *
    21          * @global bbPress $bbp
    22          * @param int $user_id
    23          * @param bool $displayed_user_fallback
    24          * @param bool $current_user_fallback
    25          * @return int
    26          */
    27         function bbp_get_user_id ( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
     26         * Return a validated user id
     27         *
     28         * @since bbPress (r2729)
     29         *
     30         * @param int $user_id Optional. User id
     31         * @param bool $displayed_user_fallback Fallback on displayed user?
     32         * @param bool $current_user_fallback Fallback on current user?
     33         * @uses get_query_var() To get the 'bbp_user_id' query var
     34         * @uses apply_filters() Calls 'bbp_get_user_id' with the user id
     35         * @return int Validated user id
     36         */
     37        function bbp_get_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
    2838                global $bbp;
    2939
    … …  
    3141                if ( !empty( $user_id ) && is_numeric( $user_id ) )
    3242                        $bbp_user_id = $user_id;
    33        
     43
    3444                // Currently viewing or editing a user
    3545                elseif ( ( true == $displayed_user_fallback ) && !empty( $bbp->displayed_user->ID ) && isset( $bbp->displayed_user->ID ) )
    … …  
    5060
    5161/**
    52  * bbp_favorites_permalink ()
    53  *
    5462 * Output the link to the user's favorites page (profile page)
    5563 *
    56  * @package bbPress
    57  * @subpackage Template Tags
    5864 * @since bbPress (r2652)
    5965 *
    60  * @param int $user_id optional
    61  * @uses bbp_get_favorites_permalink()
    62  */
    63 function bbp_favorites_permalink ( $user_id = 0 ) {
     66 * @param int $user_id Optional. User id
     67 * @uses bbp_get_favorites_permalink() To get the favorites permalink
     68 */
     69function bbp_favorites_permalink( $user_id = 0 ) {
    6470        echo bbp_get_favorites_permalink( $user_id );
    6571}
    6672        /**
    67          * bbp_get_favorites_permalink ()
    68          *
    6973         * Return the link to the user's favorites page (profile page)
    7074         *
    71          * @package bbPress
    72          * @subpackage Template Tags
    7375         * @since bbPress (r2652)
    7476         *
    75          * @param int $user_id optional
    76          * @uses apply_filters
    77          * @uses bbp_get_user_profile_url
     77         * @param int $user_id Optional. User id
     78         * @uses bbp_get_user_profile_url() To get the user profile url
     79         * @uses apply_filters() Calls 'bbp_get_favorites_permalink' with the
     80         *                        user profile url and user id
    7881         * @return string Permanent link to user profile page
    7982         */
    80         function bbp_get_favorites_permalink ( $user_id = 0 ) {
    81                 return apply_filters( 'bbp_get_favorites_permalink', bbp_get_user_profile_url( $user_id ) );
    82         }
    83 
    84 /**
    85  * bbp_user_favorites_link ()
    86  *
     83        function bbp_get_favorites_permalink( $user_id = 0 ) {
     84                return apply_filters( 'bbp_get_favorites_permalink', bbp_get_user_profile_url( $user_id ), $user_id );
     85        }
     86
     87/**
    8788 * Output the link to make a topic favorite/remove a topic from favorites
    8889 *
    89  * @package bbPress
    90  * @subpackage Template Tags
    9190 * @since bbPress (r2652)
    9291 *
    93  * @param array $add optional
    94  * @param array $rem optional
    95  * @param int $user_id optional
    96  *
    97  * @uses bbp_get_user_favorites_link()
    98  */
    99 function bbp_user_favorites_link ( $add = array(), $rem = array(), $user_id = 0 ) {
     92 * @param array $add Optional. Add to favorites args
     93 * @param array $rem Optional. Remove from favorites args
     94 * @param int $user_id Optional. User id
     95 * @uses bbp_get_user_favorites_link() To get the user favorites link
     96 */
     97function bbp_user_favorites_link( $add = array(), $rem = array(), $user_id = 0 ) {
    10098        echo bbp_get_user_favorites_link( $add, $rem, $user_id );
    10199}
    102100        /**
    103          * bbp_get_user_favorites_link ()
    104          *
    105          * Return the link to make a topic favorite/remove a topic from favorites
    106          *
    107          * @package bbPress
    108          * @subpackage Template Tags
     101         * User favorites link
     102         *
     103         * Return the link to make a topic favorite/remove a topic from
     104         * favorites
     105         *
    109106         * @since bbPress (r2652)
    110107         *
    111          * @param array $add optional
    112          * @param array $rem optional
    113          * @param int $user_id optional
    114          *
    115          * @uses apply_filters
    116          * @return string Permanent link to topic
    117          */
    118         function bbp_get_user_favorites_link ( $add = array(), $rem = array(), $user_id = 0 ) {
     108         * @param array $add Optional. Add to favorites args
     109         * @param array $rem Optional. Remove from favorites args
     110         * @param int $user_id Optional. User id
     111         * @uses bbp_get_user_id() To get the user id
     112         * @uses current_user_can() If the current user can edit the user
     113         * @uses bbp_get_topic_id() To get the topic id
     114         * @uses bbp_is_user_favorite() To check if the topic is user's favorite
     115         * @uses bbp_get_favorites_permalink() To get the favorites permalink
     116         * @uses bbp_get_topic_permalink() To get the topic permalink
     117         * @uses bbp_is_favorites() Is it the favorites page?
     118         * @uses apply_filters() Calls 'bbp_get_user_favorites_link' with the
     119         *                        html, add args, remove args, user & topic id
     120         * @return string User favorites link
     121         */
     122        function bbp_get_user_favorites_link( $add = array(), $rem = array(), $user_id = 0 ) {
    119123                global $bbp;
    120124
    … …  
    174178
    175179/**
    176  * bbp_subscriptions_permalink ()
    177  *
    178180 * Output the link to the user's subscriptions page (profile page)
    179181 *
    180  * @package bbPress
    181  * @subpackage Template Tags
    182  * @since bbPress (r2688)
    183  *
    184  * @param int $user_id optional
    185  * @uses bbp_get_subscriptions_permalink()
    186  */
    187 function bbp_subscriptions_permalink ( $user_id = 0 ) {
     182 * @since bbPress (r2688)
     183 *
     184 * @param int $user_id Optional. User id
     185 * @uses bbp_get_subscriptions_permalink() To get the subscriptions link
     186 */
     187function bbp_subscriptions_permalink( $user_id = 0 ) {
    188188        echo bbp_get_subscriptions_permalink( $user_id );
    189189}
    190190        /**
    191          * bbp_get_subscriptions_permalink ()
    192          *
    193191         * Return the link to the user's subscriptions page (profile page)
    194192         *
    195          * @package bbPress
    196          * @subpackage Template Tags
    197193         * @since bbPress (r2688)
    198194         *
    199          * @param int $user_id optional
    200          * @uses apply_filters
    201          * @uses bbp_get_user_profile_url
    202          * @return string Permanent link to user profile page
    203          */
    204         function bbp_get_subscriptions_permalink ( $user_id = 0 ) {
    205                 return apply_filters( 'bbp_get_favorites_permalink', bbp_get_user_profile_url( $user_id ) );
    206         }
    207 
    208 /**
    209  * bbp_user_subscribe_link ()
    210  *
     195         * @param int $user_id Optional. User id
     196         * @uses bbp_get_user_profile_url() To get the user profile url
     197         * @uses apply_filters() Calls 'bbp_get_favorites_permalink' with the
     198         *                        user profile url and user id
     199         * @return string Permanent link to user subscriptions page
     200         */
     201        function bbp_get_subscriptions_permalink( $user_id = 0 ) {
     202                return apply_filters( 'bbp_get_favorites_permalink', bbp_get_user_profile_url( $user_id ), $user_id );
     203        }
     204
     205/**
    211206 * Output the link to subscribe/unsubscribe from a topic
    212207 *
    213  * @package bbPress
    214  * @subpackage Template Tags
    215208 * @since bbPress (r2668)
    216209 *
    217  * @param mixed $args
    218  *
    219  * @uses bbp_get_user_subscribe_link()
    220  */
    221 function bbp_user_subscribe_link ( $args = '' ) {
     210 * @param mixed $args See {@link bbp_get_user_subscribe_link()}
     211 * @uses bbp_get_user_subscribe_link() To get the subscribe link
     212 */
     213function bbp_user_subscribe_link( $args = '' ) {
    222214        echo bbp_get_user_subscribe_link( $args );
    223215}
    224216        /**
    225          * bbp_get_user_subscribe_link ()
    226          *
    227217         * Return the link to subscribe/unsubscribe from a topic
    228218         *
    229          * @package bbPress
    230          * @subpackage Template Tags
    231219         * @since bbPress (r2668)
    232220         *
    233          * @param mixed $args
    234          *
    235          * @uses apply_filters
     221         * @param mixed $args This function supports these arguments:
     222         *  - subscribe: Subscribe text
     223         *  - unsubscribe: Unsubscribe text
     224         *  - user_id: User id
     225         *  - topic_id: Topic id
     226         *  - before: Before the link
     227         *  - after: After the link
     228         * @param int $user_id Optional. User id
     229         * @uses bbp_get_user_id() To get the user id
     230         * @uses current_user_can() To check if the current user can edit user
     231         * @uses bbp_get_topic_id() To get the topic id
     232         * @uses bbp_is_user_subscribed() To check if the user is subscribed
     233         * @uses bbp_is_subscriptions() To check if it's the subscriptions page
     234         * @uses bbp_get_subscriptions_permalink() To get subscriptions link
     235         * @uses bbp_get_topic_permalink() To get topic link
     236         * @uses apply_filters() Calls 'bbp_get_user_subscribe_link' with the
     237         *                        link, args, user id & topic id
    236238         * @return string Permanent link to topic
    237239         */
    238         function bbp_get_user_subscribe_link ( $args = '', $user_id = 0 ) {
     240        function bbp_get_user_subscribe_link( $args = '', $user_id = 0 ) {
    239241                global $bbp;
    240242
    … …  
    257259                if ( !$user_id = bbp_get_user_id( $user_id, true, true ) )
    258260                        return false;
    259                
     261
    260262                // No link if you can't edit yourself
    261263                if ( !current_user_can( 'edit_user', (int) $user_id ) )
    … …  
    282284
    283285                // Return the link
    284                 return apply_filters( 'bbp_get_user_subscribe_link', $html, $subscribe, $unsubscribe, $user_id, $topic_id );
     286                return apply_filters( 'bbp_get_user_subscribe_link', $html, $args, $user_id, $topic_id );
    285287        }
    286288
    … …  
    288290
    289291/**
    290  * bbp_current_user_id ()
    291  *
    292292 * Output ID of current user
    293293 *
    294  * @uses bbp_get_current_user_id()
    295  */
    296 function bbp_current_user_id () {
     294 * @since bbPress (r2574)
     295 *
     296 * @uses bbp_get_current_user_id() To get the current user id
     297 */
     298function bbp_current_user_id() {
    297299        echo bbp_get_current_user_id();
    298300}
    299301        /**
    300          * bbp_get_current_user_id ()
    301          *
    302302         * Return ID of current user
    303303         *
    304          * @global object $current_user
    305          * @global string $user_identity
    306          * @return int
    307          */
    308         function bbp_get_current_user_id () {
    309                 global $bbp;
    310 
    311                 $retval = isset( $bbp->current_user ) ? $bbp->current_user->ID : 0;
    312 
    313                 return apply_filters( 'bbp_get_current_user_id', $retval );
    314         }
    315 
    316 /**
    317  * bbp_displayed_user_id ()
    318  *
     304         * @since bbPress (r2574)
     305         *
     306         * @uses bbp_get_user_id() To get the current user id
     307         * @uses apply_filters() Calls 'bbp_get_current_user_id' with the id
     308         * @return int Current user id
     309         */
     310        function bbp_get_current_user_id() {
     311                return apply_filters( 'bbp_get_current_user_id', bbp_get_user_id( 0, false, true ) );
     312        }
     313
     314/**
    319315 * Output ID of displayed user
    320316 *
    321  * @uses bbp_get_displayed_user_id()
    322  */
    323 function bbp_displayed_user_id () {
     317 * @since bbPress (r2688)
     318 *
     319 * @uses bbp_get_displayed_user_id() To get the displayed user id
     320 */
     321function bbp_displayed_user_id() {
    324322        echo bbp_get_displayed_user_id();
    325323}
    326324        /**
    327          * bbp_get_displayed_user_id ()
    328          *
    329325         * Return ID of displayed user
    330326         *
    331          * @global object $displayed_user
    332          * @global string $user_identity
    333          * @return int
    334          */
    335         function bbp_get_displayed_user_id () {
    336                 global $bbp;
    337 
    338                 $retval = isset( $bbp->displayed_user ) ? $bbp->displayed_user->ID : 0;
    339 
    340                 return apply_filters( 'bbp_get_displayed_user_id', $retval );
    341         }
    342 
    343 /**
    344  * bbp_get_displayed_user_field ()
    345  *
     327         * @since bbPress (r2688)
     328         *
     329         * @uses bbp_get_user_id() To get the displayed user id
     330         * @uses apply_filters() Calls 'bbp_get_displayed_user_id' with the id
     331         * @return int Displayed user id
     332         */
     333        function bbp_get_displayed_user_id() {
     334                return apply_filters( 'bbp_get_displayed_user_id', bbp_get_user_id( 0, true, false ) );
     335        }
     336
     337/**
    346338 * Return a sanitized user field value
    347339 *
    348  * @global bbPress $bbp
    349  * @param string $field
    350  * @return string
    351  */
    352 function bbp_get_displayed_user_field ( $field = '' ) {
     340 * @since bbPress (r2688)
     341 *
     342 * @param string $field Field to get
     343 * @uses sanitize_text_field() To sanitize the field
     344 * @uses esc_attr() To sanitize the field
     345 * @return string|bool Value of the field if it exists, else false
     346 */
     347function bbp_get_displayed_user_field( $field = '' ) {
    353348        global $bbp;
    354349
    355350        // Return field if exists
    356351        if ( isset( $bbp->displayed_user->$field ) )
    357                 return esc_attr( sanitize_text_field ( $bbp->displayed_user->$field ) );
     352                return esc_attr( sanitize_text_field( $bbp->displayed_user->$field ) );
    358353
    359354        // Return empty
    … …  
    362357
    363358/**
    364  * bbp_current_user_name ()
    365  *
    366359 * Output name of current user
    367360 *
    368  * @uses bbp_get_current_user_name()
    369  */
    370 function bbp_current_user_name () {
     361 * @since bbPress (r2574)
     362 *
     363 * @uses bbp_get_current_user_name() To get the current user name
     364 */
     365function bbp_current_user_name() {
    371366        echo bbp_get_current_user_name();
    372367}
    373368        /**
    374          * bbp_get_current_user_name ()
    375          *
    376369         * Return name of current user
    377370         *
    378          * @global object $current_user
    379          * @global string $user_identity
     371         * @since bbPress (r2574)
     372         *
     373         * @uses apply_filters() Calls 'bbp_get_current_user_name' with the
     374         *                        current user name
    380375         * @return string
    381376         */
    382         function bbp_get_current_user_name () {
    383                 global $current_user, $user_identity;
     377        function bbp_get_current_user_name() {
     378                global $user_identity;
    384379
    385380                if ( is_user_logged_in() )
    … …  
    392387
    393388/**
    394  * bbp_current_user_avatar ()
    395  *
    396389 * Output avatar of current user
    397390 *
    398  * @uses bbp_get_current_user_avatar()
    399  */
    400 function bbp_current_user_avatar ( $size = 40 ) {
     391 * @since bbPress (r2574)
     392 *
     393 * @param int $size Size of the avatar. Defaults to 40
     394 * @uses bbp_get_current_user_avatar() To get the current user avatar
     395 */
     396function bbp_current_user_avatar( $size = 40 ) {
    401397        echo bbp_get_current_user_avatar( $size );
    402398}
    403399
    404400        /**
    405          * bbp_get_current_user_avatar ( $size = 40 )
    406          *
    407401         * Return avatar of current user
    408402         *
    409          * @global object $current_user
    410          * @param int $size
    411          * @return string
    412          */
    413         function bbp_get_current_user_avatar ( $size = 40 ) {
    414                 global $current_user;
    415 
    416                 return apply_filters( 'bbp_get_current_user_avatar', get_avatar( bbp_get_current_user_id(), $size ) );
    417         }
    418 
    419 /**
    420  * bbp_user_profile_link ()
    421  *
     403         * @since bbPress (r2574)
     404         *
     405         * @param int $size Size of the avatar. Defaults to 40
     406         * @uses bbp_get_current_user_id() To get the current user id
     407         * @uses get_avatar() To get the avatar
     408         * @uses apply_filters() Calls 'bbp_get_current_user_avatar' with the
     409         *                        avatar and size
     410         * @return string Current user avatar
     411         */
     412        function bbp_get_current_user_avatar( $size = 40 ) {
     413                return apply_filters( 'bbp_get_current_user_avatar', get_avatar( bbp_get_current_user_id(), $size ), $size );
     414        }
     415
     416/**
    422417 * Output link to the profile page of a user
    423418 *
    424  * @package bbPress
    425  * @subpackage Template Tags
    426  * @since bbPress (r2688)
    427  *
    428  * @uses bbp_get_user_profile_link ()
    429  *
    430  * @param int $user_id
    431  */
    432 function bbp_user_profile_link ( $user_id = 0 ) {
     419 * @since bbPress (r2688)
     420 *
     421 * @param int $user_id Optional. User id
     422 * @uses bbp_get_user_profile_link() To get user profile link
     423 */
     424function bbp_user_profile_link( $user_id = 0 ) {
    433425        echo bbp_get_user_profile_link( $user_id );
    434426}
    435427        /**
    436          * bbp_get_user_profile_link ()
    437          *
    438428         * Return link to the profile page of a user
    439429         *
    440          * @package bbPress
    441          * @subpackage Template Tags
    442430         * @since bbPress (r2688)
    443431         *
    444          * @uses bbp_get_user_profile_url ()
    445          *
    446          * @param int $user_id
    447          * @return string
    448          */
    449         function bbp_get_user_profile_link ( $user_id = 0 ) {
     432         * @param int $user_id Optional. User id
     433         * @uses bbp_get_user_id() To get user id
     434         * @uses get_userdata() To get user data
     435         * @uses bbp_get_user_profile_url() To get user profile url
     436         * @uses apply_filters() Calls 'bbp_get_user_profile_link' with the user
     437         *                        profile link and user id
     438         * @return string User profile link
     439         */
     440        function bbp_get_user_profile_link( $user_id = 0 ) {
    450441                if ( !$user_id = bbp_get_user_id( $user_id ) )
    451442                        return false;
    … …  
    459450
    460451/**
    461  * bbp_user_profile_url ()
    462  *
    463452 * Output URL to the profile page of a user
    464453 *
    465  * @package bbPress
    466  * @subpackage Template Tags
    467  * @since bbPress (r2688)
    468  *
    469  * @uses bbp_get_user_profile_url ()
    470  *
    471  * @param int $user_id
    472  */
    473 function bbp_user_profile_url ( $user_id = 0, $user_nicename = '' ) {
     454 * @since bbPress (r2688)
     455 *
     456 * @param int $user_id Optional. User id
     457 * @param string $user_nicename Optional. User nicename
     458 * @uses bbp_get_user_profile_url() To get user profile url
     459 */
     460function bbp_user_profile_url( $user_id = 0, $user_nicename = '' ) {
    474461        echo bbp_get_user_profile_url( $user_id );
    475462}
    476463        /**
    477          * bbp_get_user_profile_url ()
    478          *
    479464         * Return URL to the profile page of a user
    480465         *
    481          * @package bbPress
    482          * @subpackage Template Tags
    483466         * @since bbPress (r2688)
    484467         *
    485          * @param int $user_id
    486          * @param string $user_nicename
    487          *
    488          * @return string
    489          */
    490         function bbp_get_user_profile_url ( $user_id = 0, $user_nicename = '' ) {
     468         * @param int $user_id Optional. User id
     469         * @param string $user_nicename Optional. User nicename
     470         * @uses bbp_get_user_id() To get user id
     471         * @uses add_query_arg() To add custom args to the url
     472         * @uses home_url() To get blog home url
     473         * @uses apply_filters() Calls 'bbp_get_user_profile_url' with the user
     474         *                        profile url, user id and user nicename
     475         * @return string User profile url
     476         */
     477        function bbp_get_user_profile_url( $user_id = 0, $user_nicename = '' ) {
    491478                global $wp_rewrite, $bbp;
    492479
    … …  
    494481                if ( !$user_id = bbp_get_user_id( $user_id ) )
    495482                        return false;
    496                
    497                 // URL for pretty permalinks
    498                 $url = !empty( $wp_rewrite->permalink_structure ) ? $wp_rewrite->front . $bbp->user_slug . '/%bbp_user%' : '';
    499483
    500484                // No pretty permalinks
    501                 if ( empty( $url ) ) {
    502                         $file = home_url( '/' );
    503                         $url  = $file . '?bbp_user=' . $user_id;
     485                if ( empty( $wp_rewrite->permalink_structure ) ) {
     486                        $url = add_query_arg( array( 'bbp_user' => $user_id ), home_url( '/' ) );
    504487
    505488                // Get URL safe user slug
    506489                } else {
     490                        $url = $wp_rewrite->front . $bbp->user_slug . '/%bbp_user%';
     491
    507492                        if ( empty( $user_nicename ) ) {
    508493                                $user = get_userdata( $user_id );
    … …  
    510495                                        $user_nicename = $user->user_nicename;
    511496                        }
     497
    512498                        $url = str_replace( '%bbp_user%', $user_nicename, $url );
    513499                        $url = home_url( user_trailingslashit( $url ) );
    … …  
    519505
    520506/**
    521  * bbp_user_profile_edit_link ()
    522  *
    523507 * Output link to the profile edit page of a user
    524508 *
    525  * @package bbPress
    526  * @subpackage Template Tags
    527  * @since bbPress (r2688)
    528  *
    529  * @uses bbp_get_user_profile_edit_link ()
    530  *
    531  * @param int $user_id
    532  */
    533 function bbp_user_profile_edit_link ( $user_id = 0 ) {
     509 * @since bbPress (r2688)
     510 *
     511 * @param int $user_id Optional. User id
     512 * @uses bbp_get_user_profile_edit_link() To get user profile edit link
     513 */
     514function bbp_user_profile_edit_link( $user_id = 0 ) {
    534515        echo bbp_get_user_profile_edit_link( $user_id );
    535516}
    536517        /**
    537          * bbp_get_user_profile_edit_link ()
    538          *
    539518         * Return link to the profile edit page of a user
    540519         *
    541          * @package bbPress
    542          * @subpackage Template Tags
    543520         * @since bbPress (r2688)
    544521         *
    545          * @uses bbp_get_user_profile_edit_url ()
    546          *
    547          * @param int $user_id
    548          * @return string
    549          */
    550         function bbp_get_user_profile_edit_link ( $user_id = 0 ) {
     522         * @param int $user_id Optional. User id
     523         * @uses bbp_get_user_id() To get user id
     524         * @uses get_userdata() To get user data
     525         * @uses bbp_get_user_profile_edit_url() To get user profile edit url
     526         * @uses apply_filters() Calls 'bbp_get_user_profile_link' with the edit
     527         *                        link and user id
     528         * @return string User profile edit link
     529         */
     530        function bbp_get_user_profile_edit_link( $user_id = 0 ) {
    551531                if ( !$user_id = bbp_get_user_id( $user_id ) )
    552532                        return false;
    … …  
    559539
    560540/**
    561  * bbp_user_profile_edit_url ()
    562  *
    563541 * Output URL to the profile edit page of a user
    564542 *
    565  * @package bbPress
    566  * @subpackage Template Tags
    567  * @since bbPress (r2688)
    568  *
    569  * @uses bbp_get_user_edit_profile_url ()
    570  *
    571  * @param int $user_id
    572  */
    573 function bbp_user_profile_edit_url ( $user_id = 0, $user_nicename = '' ) {
     543 * @since bbPress (r2688)
     544 *
     545 * @param int $user_id Optional. User id
     546 * @param string $user_nicename Optional. User nicename
     547 * @uses bbp_get_user_profile_edit_url() To get user profile edit url
     548 */
     549function bbp_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
    574550        echo bbp_get_user_profile_edit_url( $user_id );
    575551}
    576552        /**
    577          * bbp_get_user_profile_edit_url ()
    578          *
    579553         * Return URL to the profile edit page of a user
    580554         *
    581          * @package bbPress
    582          * @subpackage Template Tags
    583555         * @since bbPress (r2688)
    584556         *
    585          * @param int $user_id
    586          * @param string $user_nicename
    587          *
     557         * @param int $user_id Optional. User id
     558         * @param string $user_nicename Optional. User nicename
     559         * @uses bbp_get_user_id() To get user id
     560         * @uses add_query_arg() To add custom args to the url
     561         * @uses home_url() To get blog home url
     562         * @uses apply_filters() Calls 'bbp_get_user_edit_profile_url' with the
     563         *                        edit profile url, user id and user nicename
    588564         * @return string
    589565         */
    590         function bbp_get_user_profile_edit_url ( $user_id = 0, $user_nicename = '' ) {
     566        function bbp_get_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
    591567                global $wp_rewrite, $bbp;
    592568
    … …  
    594570                        return;
    595571
    596                 $url = !empty( $wp_rewrite->permalink_structure ) ? $wp_rewrite->front . $bbp->user_slug . '/%bbp_user%/edit' : '';
    597 
    598                 if ( empty( $url ) ) {
    599                         $url  = add_query_arg( array( 'bbp_user' => $user_id, 'bbp_edit_profile' => '1' ), home_url( '/' ) );
     572                if ( empty( $wp_rewrite->permalink_structure ) ) {
     573                        $url = add_query_arg( array( 'bbp_user' => $user_id, 'edit' => '1' ), home_url( '/' ) );
    600574                } else {
     575                        $url = $wp_rewrite->front . $bbp->user_slug . '/%bbp_user%/edit';
     576
    601577                        if ( empty( $user_nicename ) ) {
    602578                                $user = get_userdata( $user_id );
    … …  
    604580                                        $user_nicename = $user->user_nicename;
    605581                        }
     582
    606583                        $url = str_replace( '%bbp_user%', $user_nicename, $url );
    607584                        $url = home_url( user_trailingslashit( $url ) );
    … …  
    615592
    616593/**
    617  * bbp_edit_user_success ()
    618  */
    619 function bbp_notice_edit_user_success () {
     594 * Edit profile success message
     595 *
     596 * @since bbPress (r2688)
     597 *
     598 * @uses bbp_is_user_profile_page() To check if it's the profile page
     599 * @uses bbp_is_user_profile_edit() To check if it's the profile edit page
     600 */
     601function bbp_notice_edit_user_success() {
    620602        if ( isset( $_GET['updated'] ) && ( bbp_is_user_profile_page() || bbp_is_user_profile_edit() ) ) : ?>
    621603
    … …  
    626608        <?php endif;
    627609}
    628 add_action( 'bbp_template_notices', 'bbp_notice_edit_user_success' );
    629 
    630 function bbp_notice_edit_user_is_super_admin () {
     610
     611/**
     612 * Super admin privileges notice
     613 *
     614 * @since bbPress (r2688)
     615 *
     616 * @uses is_multisite() To check if the blog is multisite
     617 * @uses bbp_is_user_profile_page() To check if it's the profile page
     618 * @uses bbp_is_user_profile_edit() To check if it's the profile edit page
     619 * @uses current_user_can() To check if the current user can manage network
     620 *                           options
     621 * @uses bbp_get_displayed_user_id() To get the displayed user id
     622 * @uses is_super_admin() To check if the user is super admin
     623 * @uses bbp_is_user_home() To check if it's the user home
     624 */
     625function bbp_notice_edit_user_is_super_admin() {
    631626        if ( is_multisite() && ( bbp_is_user_profile_page() || bbp_is_user_profile_edit() ) && current_user_can( 'manage_network_options' ) && is_super_admin( bbp_get_displayed_user_id() ) ) : ?>
    632627
    … …  
    637632<?php endif;
    638633}
    639 add_action( 'bbp_template_notices', 'bbp_notice_edit_user_is_super_admin', 2 );
    640 
    641 /**
    642  * bbp_edit_user_display_name()
    643  *
     634
     635/**
    644636 * Drop down for selecting the user's display name
    645637 *
    646  * @global bbPress $bbp
    647  */
    648 function bbp_edit_user_display_name () {
     638 * @since bbPress (r2688)
     639 */
     640function bbp_edit_user_display_name() {
    649641        global $bbp;
    650642
    … …  
    684676
    685677/**
    686  * bbp_edit_user_role ()
    687  *
    688678 * Output role selector (for user edit)
    689679 *
    690  * @package bbPress
    691  * @subpackage Template
    692  *
    693  * @param string $default slug for the role that should be already selected
    694  */
    695 function bbp_edit_user_role () {
     680 * @since bbPress (r2688)
     681 */
     682function bbp_edit_user_role() {
    696683        global $bbp;
    697684
    … …  
    722709}
    723710
    724 function bbp_edit_user_contact_methods( $user_id = 0 ) {
     711/**
     712 * Return user contact methods Selectbox
     713 *
     714 * @since bbPress (r2688)
     715 *
     716 * @return string user contact methods
     717 */
     718function bbp_edit_user_contact_methods() {
    725719        global $bbp;
    726720
  • branches/plugin/bbp-includes/bbp-users.php

    r2734 r2758  
    11<?php
    2 
    3 /**
    4  * bbp_is_anonymous ()
    5  *
    6  * Return true if anonymous is allowed and user is not logged in.
    7  * Return false if anonymous is not allowed or user is logged in
    8  *
    9  * @return bool
    10  */
    11 function bbp_is_anonymous () {
     2/**
     3 * bbPress User Functions
     4 *
     5 * @package bbPress
     6 * @subpackage Functions
     7 */
     8
     9/**
     10 * Is an anonymous topic/reply being made?
     11 *
     12 * @since bbPres (r2688)
     13 *
     14 * @uses is_user_logged_in() Is the user logged in?
     15 * @uses bbp_allow_anonymous() Is anonymous posting allowed?
     16 * @uses apply_filters() Calls 'bbp_is_anonymous' with the return value
     17 * @return bool True if anonymous is allowed and user is not logged in, false if
     18 *               anonymous is not allowed or user is logged in
     19 */
     20function bbp_is_anonymous() {
    1221        if ( !is_user_logged_in() && bbp_allow_anonymous() )
    1322                $is_anonymous = true;
    … …  
    1928
    2029/**
    21  * bbp_allow_anonymous ()
    22  *
    23  * Returns true|false if anonymous topic creation and replies are allowed
    24  *
    25  * @since bbPress (r2596)
    26  * @return bool
    27  */
    28 function bbp_allow_anonymous () {
     30 * Is the anonymous posting allowed?
     31 *
     32 * @since bbPress (r2659)
     33 *
     34 * @uses get_option() To get the allow anonymous option
     35 * @return bool Is anonymous posting allowed?
     36 */
     37function bbp_allow_anonymous() {
    2938        return apply_filters( 'bbp_allow_anonymous', get_option( '_bbp_allow_anonymous', false ) );
    3039}
    3140
    3241/**
    33  * bbp_current_anonymous_user_data ()
    34  *
    35  * Echoes the values for current poster (uses WP comment cookies).
     42 * Echoes the values for current poster (uses WP comment cookies)
    3643 *
    3744 * @since bbPress (r2734)
    3845 *
    39  * @uses bbp_get_current_anonymous_user_data() To get the current poster data
    40  *
    4146 * @param string $key Which value to echo?
    42  */
    43 function bbp_current_anonymous_user_data ( $key = '' ) {
     47 * @uses bbp_get_current_anonymous_user_data() To get the current anonymous user
     48 *                                              data
     49 */
     50function bbp_current_anonymous_user_data( $key = '' ) {
    4451        echo bbp_get_current_anonymous_user_data( $key );
    4552}
    4653
    4754        /**
    48          * bbp_get_current_anonymous_user_data ()
    49          *
    5055         * Get the cookies for current poster (uses WP comment cookies).
    5156         *
    5257         * @since bbPress (r2734)
    5358         *
     59         * @param string $key Optional. Which value to get? If not given, then
     60         *                     an array is returned.
    5461         * @uses sanitize_comment_cookies() To sanitize the current poster data
    55          * @uses wp_get_current_commenter() To get the current poster data
    56          *
    57          * @param string $key Optional. Which value to get? If not given, then an array is returned.
    58          *
    59          * @return string|array
     62         * @uses wp_get_current_commenter() To get the current poster data       *
     63         * @return string|array Cookie(s) for current poster
    6064         */
    61         function bbp_get_current_anonymous_user_data ( $key = '' ) {
     65        function bbp_get_current_anonymous_user_data( $key = '' ) {
    6266                $cookie_names = array(
    6367                        'name'    => 'comment_author',
    … …  
    8286
    8387/**
    84  * bbp_set_current_anonymous_user_data ()
    85  *
    8688 * Set the cookies for current poster (uses WP comment cookies)
    8789 *
    8890 * @since bbPress (r2734)
    8991 *
    90  * @uses apply_filters() 'comment_cookie_lifetime' for cookie lifetime. Defaults to 30000000.
    91  * @uses setcookie()     To set the cookies.
    92  *
    93  * @param array $anonymous_data With keys 'bbp_anonymous_name', 'bbp_anonymous_email', 'bbp_anonymous_website'. Should be sanitized (see bbp_filter_anonymous_post_data() for sanitization)
    94  */
    95 function bbp_set_current_anonymous_user_data ( $anonymous_data = array() ) {
     92 * @param array $anonymous_data With keys 'bbp_anonymous_name',
     93 *                               'bbp_anonymous_email', 'bbp_anonymous_website'.
     94 *                               Should be sanitized (see
     95 *                               {@link bbp_filter_anonymous_post_data()} for
     96 *                               sanitization)
     97 * @uses apply_filters() Calls 'comment_cookie_lifetime' for cookie lifetime.
     98 *                        Defaults to 30000000.
     99 */
     100function bbp_set_current_anonymous_user_data( $anonymous_data = array() ) {
    96101        if ( empty( $anonymous_data ) || !is_array( $anonymous_data ) )
    97102                return;
    … …  
    107112
    108113/**
    109  * bbp_get_topic_favoriters ()
    110  *
    111114 * Get the users who have made the topic favorite
    112115 *
    113  * @package bbPress
    114  * @subpackage Users
    115116 * @since bbPress (r2658)
    116117 *
    117  * @param int $topic_id Topic ID
     118 * @param int $topic_id Optional. Topic id
     119 * @uses wpdb::get_col() To execute our query and get the column back
     120 * @uses apply_filters() Calls 'bbp_get_topic_favoriters' with the users and
     121 *                        topic id
    118122 * @return array|bool Results if the topic has any favoriters, otherwise false
    119123 */
    120 function bbp_get_topic_favoriters ( $topic_id = 0 ) {
     124function bbp_get_topic_favoriters( $topic_id = 0 ) {
    121125        if ( empty( $topic_id ) )
    122126                return;
    … …  
    135139
    136140/**
    137  * bbp_get_user_favorites ()
    138  *
    139141 * Get a user's favorite topics
    140142 *
    141  * @package bbPress
    142  * @subpackage Users
    143143 * @since bbPress (r2652)
    144144 *
    145  * @uses bbp_get_user_favorites_topic_ids ()
    146  *
    147  * @param int $user_id User ID
     145 * @param int $user_id Optional. User id
     146 * @uses bbp_get_user_favorites_topic_ids() To get the user's favorites
     147 * @uses bbp_has_topics() To get the topics
     148 * @uses apply_filters() Calls 'bbp_get_user_favorites' with the topic query and
     149 *                        user id
    148150 * @return array|bool Results if user has favorites, otherwise false
    149151 */
    150 function bbp_get_user_favorites ( $user_id = 0 ) {
     152function bbp_get_user_favorites( $user_id = 0 ) {
    151153        if ( !$user_id = bbp_get_user_id( $user_id ) )
    152154                return false;
    … …  
    162164
    163165        /**
    164          * bbp_get_user_favorites_topic_ids ()
     166         * Get a user's favorite topics' ids
    165167         *
    166          * Get a user's favorite topics' IDs
    167          *
    168          * @package bbPress
    169          * @subpackage Users
    170168         * @since bbPress (r2652)
    171169         *
    172          * @param int $user_id User ID
     170         * @param int $user_id Optional. User id
     171         * @uses bbp_get_user_id() To get the user id
     172         * @uses get_user_meta() To get the user favorites
     173         * @uses apply_filters() Calls 'bbp_get_user_favorites_topic_ids' with
     174         *                        the favorites and user id
    173175         * @return array|bool Results if user has favorites, otherwise false
    174176         */
    175         function bbp_get_user_favorites_topic_ids ( $user_id = 0 ) {
     177        function bbp_get_user_favorites_topic_ids( $user_id = 0 ) {
    176178                if ( !$user_id = bbp_get_user_id( $user_id ) )
    177179                        return false;
    … …  
    185187
    186188/**
    187  * bbp_is_user_favorite ()
    188  *
    189189 * Check if a topic is in user's favorites or not
    190190 *
    191  * @package bbPress
    192  * @subpackage Users
    193191 * @since bbPress (r2652)
    194192 *
    195  * @param int $user_id User ID
    196  * @param int $topic_id Topic ID
     193 * @param int $user_id Optional. User id
     194 * @param int $topic_id Optional. Topic id
     195 * @uses bbp_get_user_id() To get the user id
     196 * @uses bbp_get_user_favorites_topic_ids() To get the user favorites
     197 * @uses get_post() To get the topic
     198 * @uses bbp_get_topic_id() To get the topic id
     199 * @uses apply_filters() Calls 'bbp_is_user_favorite' with the bool, user id,
     200 *                        topic id and favorites
    197201 * @return bool True if the topic is in user's favorites, otherwise false
    198202 */
    199 function bbp_is_user_favorite ( $user_id = 0, $topic_id = 0 ) {
     203function bbp_is_user_favorite( $user_id = 0, $topic_id = 0 ) {
    200204        global $post, $bbp;
    201205
    … …  
    225229
    226230/**
    227  * bbp_add_user_favorite ()
    228  *
    229231 * Add a topic to user's favorites
    230232 *
    231  * @package bbPress
    232  * @subpackage Users
    233233 * @since bbPress (r2652)
    234234 *
    235  * @param int $user_id User ID
    236  * @param int $topic_id Topic ID
    237  * @return bool True
    238  */
    239 function bbp_add_user_favorite ( $user_id = 0, $topic_id = 0 ) {
     235 * @param int $user_id Optional. User id
     236 * @param int $topic_id Optional. Topic id
     237 * @uses bbp_get_user_favorites_topic_ids() To get the user favorites
     238 * @uses update_user_meta() To update the user favorites
     239 * @uses do_action() Calls 'bbp_add_user_favorite' with the user id and topic id
     240 * @return bool Always true
     241 */
     242function bbp_add_user_favorite( $user_id = 0, $topic_id = 0 ) {
    240243        if ( empty( $user_id ) || empty( $topic_id ) )
    241244                return false;
    … …  
    259262
    260263/**
    261  * bbp_remove_user_favorite ()
    262  *
    263264 * Remove a topic from user's favorites
    264265 *
    265  * @package bbPress
    266  * @subpackage Users
    267266 * @since bbPress (r2652)
    268267 *
    269  * @param int $user_id User ID
    270  * @param int $topic_id Topic ID
    271  * @return bool True if the topic was removed from user's favorites, otherwise false
    272  */
    273 function bbp_remove_user_favorite ( $user_id, $topic_id ) {
     268 * @param int $user_id Optional. User id
     269 * @param int $topic_id Optional. Topic id
     270 * @uses bbp_get_user_favorites_topic_ids() To get the user favorites
     271 * @uses update_user_meta() To update the user favorites
     272 * @uses delete_user_meta() To delete the user favorites meta
     273 * @uses do_action() Calls 'bbp_remove_user_favorite' with the user & topic id
     274 * @return bool True if the topic was removed from user's favorites, otherwise
     275 *               false
     276 */
     277function bbp_remove_user_favorite( $user_id, $topic_id ) {
    274278        if ( empty( $user_id ) || empty( $topic_id ) )
    275279                return false;
    … …  
    300304
    301305/**
    302  * bbp_get_topic_subscribers ()
    303  *
    304306 * Get the users who have subscribed to the topic
    305307 *
    306  * @package bbPress
    307  * @subpackage Users
    308308 * @since bbPress (r2668)
    309309 *
    310  * @param int $topic_id Topic ID
     310 * @param int $topic_id Optional. Topic id
     311 * @uses wpdb::get_col() To execute our query and get the column back
     312 * @uses apply_filters() Calls 'bbp_get_topic_subscribers' with the subscribers
    311313 * @return array|bool Results if the topic has any subscribers, otherwise false
    312314 */
    313 function bbp_get_topic_subscribers ( $topic_id = 0 ) {
     315function bbp_get_topic_subscribers( $topic_id = 0 ) {
    314316        if ( empty( $topic_id ) )
    315317                return;
    … …  
    328330
    329331/**
    330  * bbp_get_user_subscriptions ()
    331  *
    332332 * Get a user's subscribed topics
    333333 *
    334  * @package bbPress
    335  * @subpackage Users
    336334 * @since bbPress (r2668)
    337335 *
    338  * @uses bbp_get_user_subscribed_topic_ids ()
    339  *
    340  * @param int $user_id User ID
     336 * @param int $user_id Optional. User id
     337 * @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
     338 * @uses bbp_has_topics() To get the topics
     339 * @uses apply_filters() Calls 'bbp_get_user_subscriptions' with the topic query
     340 *                        and user id
    341341 * @return array|bool Results if user has subscriptions, otherwise false
    342342 */
    343 function bbp_get_user_subscriptions ( $user_id = 0 ) {
     343function bbp_get_user_subscriptions( $user_id = 0 ) {
    344344
    345345        // Default to the displayed user
    … …  
    357357
    358358        /**
    359          * bbp_get_user_subscribed_topic_ids ()
     359         * Get a user's subscribed topics' ids
    360360         *
    361          * Get a user's subscribed topics' IDs
    362          *
    363          * @package bbPress
    364          * @subpackage Users
    365361         * @since bbPress (r2668)
    366362         *
    367          * @param int $user_id User ID
     363         * @param int $user_id Optional. User id
     364         * @uses bbp_get_user_id() To get the user id
     365         * @uses get_user_meta() To get the user's subscriptions
     366         * @uses apply_filters() Calls 'bbp_get_user_subscribed_topic_ids' with
     367         *                        the subscriptions and user id
    368368         * @return array|bool Results if user has subscriptions, otherwise false
    369369         */
    370         function bbp_get_user_subscribed_topic_ids ( $user_id = 0 ) {
     370        function bbp_get_user_subscribed_topic_ids( $user_id = 0 ) {
    371371                if ( !$user_id = bbp_get_user_id( $user_id ) )
    372372                        return false;
    … …  
    376376                $subscriptions = array_filter( $subscriptions );
    377377
    378                 return apply_filters( 'bbp_get_user_subscribed_topic_ids', $subscriptions );
    379         }
    380 
    381 /**
    382  * bbp_is_user_subscribed ()
    383  *
     378                return apply_filters( 'bbp_get_user_subscribed_topic_ids', $subscriptions, $user_id );
     379        }
     380
     381/**
    384382 * Check if a topic is in user's subscription list or not
    385383 *
    386  * @package bbPress
    387  * @subpackage Users
    388384 * @since bbPress (r2668)
    389385 *
    390  * @param int $user_id User ID
    391  * @param int $topic_id Topic ID
     386 * @param int $user_id Optional. User id
     387 * @param int $topic_id Optional. Topic id
     388 * @uses bbp_get_user_id() To get the user id
     389 * @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
     390 * @uses get_post() To get the topic
     391 * @uses bbp_get_topic_id() To get the topic id
     392 * @uses apply_filters() Calls 'bbp_is_user_subscribed' with the bool, user id,
     393 *                        topic id and subsriptions
    392394 * @return bool True if the topic is in user's subscriptions, otherwise false
    393395 */
    394 function bbp_is_user_subscribed ( $user_id = 0, $topic_id = 0 ) {
     396function bbp_is_user_subscribed( $user_id = 0, $topic_id = 0 ) {
    395397        global $bbp, $post;
    396398
    … …  
    420422
    421423/**
    422  * bbp_add_user_subscription ()
    423  *
    424424 * Add a topic to user's subscriptions
    425425 *
    426  * @package bbPress
    427  * @subpackage Users
    428426 * @since bbPress (r2668)
    429427 *
    430  * @param int $user_id User ID
    431  * @param int $topic_id Topic ID
    432  * @return bool True
    433  */
    434 function bbp_add_user_subscription ( $user_id = 0, $topic_id = 0 ) {
     428 * @param int $user_id Optional. User id
     429 * @param int $topic_id Optional. Topic id
     430 * @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
     431 * @uses get_post() To get the topic
     432 * @uses update_user_meta() To update the user's subscriptions
     433 * @uses do_action() Calls 'bbp_add_user_subscription' with the user & topic id
     434 * @return bool Always true
     435 */
     436function bbp_add_user_subscription( $user_id = 0, $topic_id = 0 ) {
    435437        if ( empty( $user_id ) || empty( $topic_id ) )
    436438                return false;
    … …  
    454456
    455457/**
    456  * bbp_remove_user_subscription ()
    457  *
    458458 * Remove a topic from user's subscriptions
    459459 *
    460  * @package bbPress
    461  * @subpackage Users
    462460 * @since bbPress (r2668)
    463461 *
    464  * @param int $user_id User ID
    465  * @param int $topic_id Topic ID
    466  * @return bool True if the topic was removed from user's subscriptions, otherwise false
    467  */
    468 function bbp_remove_user_subscription ( $user_id, $topic_id ) {
     462 * @param int $user_id Optional. User id
     463 * @param int $topic_id Optional. Topic id
     464 * @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
     465 * @uses update_user_meta() To update the user's subscriptions
     466 * @uses delete_user_meta() To delete the user's subscriptions meta
     467 * @uses do_action() Calls 'bbp_remove_user_subscription' with the user id and
     468 *                    topic id
     469 * @return bool True if the topic was removed from user's subscriptions,
     470 *               otherwise false
     471 */
     472function bbp_remove_user_subscription( $user_id, $topic_id ) {
    469473        if ( empty( $user_id ) || empty( $topic_id ) )
    470474                return false;
    … …  
    495499
    496500/**
    497  * bbp_get_user_topics_started ()
    498  *
    499501 * Get the topics that a user created
    500502 *
    501  * @package bbPress
    502  * @subpackage Users
    503503 * @since bbPress (r2660)
    504504 *
    505  * @param int $user_id User ID
    506  * @return array|bool Results if user has favorites, otherwise false
    507  */
    508 function bbp_get_user_topics_started ( $user_id = 0 ) {
     505 * @param int $user_id Optional. User id
     506 * @uses bbp_get_user_id() To get the topic id
     507 * @uses bbp_has_topics() To get the topics created by the user
     508 * @return array|bool Results if the user has created topics, otherwise false
     509 */
     510function bbp_get_user_topics_started( $user_id = 0 ) {
    509511        if ( !$user_id = bbp_get_user_id( $user_id ) )
    510512                return false;
  • branches/plugin/bbp-themes/bbp-twentyten/css/bbpress.css

    r2754 r2758  
    66 */
    77
    8 /* bbPress Style
    9 -------------------------------------------------------------- */
    10 
    11 hr { margin: 0 0 24px 0 !important; }
     8/* =bbPress Style
     9-------------------------------------------------------------- */
     10
     11hr {
     12        margin: 0 0 24px 0 !important;
     13}
    1214#entry-author-info {
    1315        margin: 10px 0 0 0;
    … …  
    1517}
    1618
    17 /* tables */
     19/* =Tables
     20-------------------------------------------------------------- */
     21
    1822#content table tbody tr.even td {
    1923        background-color: #fff;
    … …  
    5660table.bbp-forums tfoot td, table.bbp-topics tfoot td,
    5761table.bbp-topic tfoot td, table.bbp-replies tfoot td,
    58 table.bbp-replies tr.bbp-reply-header td, table.bbp-topic tr.bbp-topic-header td {
     62table.bbp-replies tr.bbp-reply-header td,
     63table.bbp-topic tr.bbp-topic-header td {
    5964        background-color: #fafafa;
    6065        color: #888;
    … …  
    6469}
    6570
    66 .bbp-forum-topic-count, .bbp-forum-reply-count,
    67 .bbp-topic-reply-count, .bbp-topic-voice-count, .bbp-topic-action {
     71.bbp-forum-topic-count,
     72.bbp-forum-reply-count,
     73.bbp-topic-reply-count,
     74.bbp-topic-voice-count,
     75.bbp-topic-action {
    6876        width: 10%;
    6977        text-align: center;
    7078}
    71 .bbp-topic-freshness, .bbp-forum-freshness {
     79.bbp-topic-freshness,
     80.bbp-forum-freshness {
    7281        text-align: center;
    7382        width: 20%;
    7483}
    75 .bbp-topic-author, .bbp-reply-author {
     84.bbp-topic-author,
     85.bbp-reply-author {
    7686        width: 90px;
    7787        text-align: center;
    … …  
    7989}
    8090
    81 .bbp-topic-content, .bbp-reply-content {
     91.bbp-topic-content,
     92.bbp-reply-content {
    8293        vertical-align: top;
    8394}
    … …  
    154165}
    155166
    156 /* forums */
     167/* =Forums
     168-------------------------------------------------------------- */
     169
    157170#content table tbody tr .bbp-forum-description p {
    158171        margin-bottom: 0;
    … …  
    171184}
    172185
    173 /* pagination */
     186/* =Pagination
     187-------------------------------------------------------------- */
     188
    174189.bbp-pagination-count {
    175190        float: left;
    … …  
    184199}
    185200
    186 /* forms */
    187 .bbp-topic-form, .bbp-reply-form {
     201/* =Forms
     202-------------------------------------------------------------- */
     203
     204.bbp-topic-form,
     205.bbp-reply-form {
    188206        clear: left;
    189207}
    … …  
    193211}
    194212
    195 /* edit user */
     213/* =Edit User
     214-------------------------------------------------------------- */
     215
    196216div.bbp-edit-user fieldset {
    197217        margin-top: 20px;
    … …  
    253273        }
    254274
    255 /* notices */
     275/* =Notices
     276-------------------------------------------------------------- */
     277
    256278div.bbp-template-notice {
    257279        border-width: 1px;
    … …  
    286308        }
    287309
    288 /* stickies */
     310/* =Stickies
     311-------------------------------------------------------------- */
     312
    289313tr.super-sticky td,
    290314tr.sticky td {
  • branches/plugin/bbp-themes/bbp-twentyten/form-bbp_merge.php

    r2756 r2758  
    11<?php
     2
    23/**
    34 * Merge topic form
    … …  
    67 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/form-bbp_split.php

    r2756 r2758  
    11<?php
     2
    23/**
    34 * Split topic form
    … …  
    67 * @subpackage Themes
    78 */
     9
    810?>
    911<?php if ( is_user_logged_in() && current_user_can( 'edit_topic', bbp_get_topic_id() ) ) : ?>
  • branches/plugin/bbp-themes/bbp-twentyten/functions.php

    r2740 r2758  
    22
    33/**
    4  * bbp_twentyten_enqueue_styles ()
    5  *
     4 * bbPress Theme Functions
     5 *
     6 * @package bbPress
     7 * @subpackage Theme
     8 */
     9
     10/**
    611 * Load the theme CSS
     12 *
     13 * @uses is_admin() To check if it's the admin section
     14 * @uses wp_enqueue_style() To enqueue the styles
    715 */
    816function bbp_twentyten_enqueue_styles () {
    … …  
    1624        wp_enqueue_style( 'bbp-twentyten-bbpress', get_stylesheet_directory_uri() . '/css/bbpress.css', 'bbp-twentyten-default', 20100312, 'screen' );
    1725}
    18 add_action( 'init', 'bbp_twentyten_enqueue_styles' );
    19 
    20 /**
    21  * bbp_twentyten_dim_favorite ()
    22  *
     26
     27/**
    2328 * Add or remove a topic from a user's favorites
    2429 *
    25  * @package bbPress
    26  * @subpackage bbPress TwentyTen
    27  * @since bbPress (r2652)
    28  *
    29  * @return void
     30 * @since bbPress (r2652)
     31 *
     32 * @uses bbp_get_current_user_id() To get the current user id
     33 * @uses current_user_can() To check if the current user can edit the user
     34 * @uses get_post() To get the topic
     35 * @uses check_ajax_referer() To verify the nonce & check the referer
     36 * @uses bbp_is_user_favorite() To check if the topic is user's favorite
     37 * @uses bbp_remove_user_favorite() To remove the topic from user's favorites
     38 * @uses bbp_add_user_favorite() To add the topic from user's favorites
    3039 */
    3140function bbp_twentyten_dim_favorite () {
    32         global $current_user;
    33 
    34         $current_user = wp_get_current_user();
    35         $user_id      = $current_user->ID;
    36         $id           = intval( $_POST['id'] );
     41        $user_id = bbp_get_current_user_id();
     42        $id      = intval( $_POST['id'] );
    3743
    3844        if ( !current_user_can( 'edit_user', $user_id ) )
    … …  
    5460        die( '0' );
    5561}
    56 add_action( 'wp_ajax_dim-favorite', 'bbp_twentyten_dim_favorite' );
    57 
    58 /**
    59  * bbp_twentyten_dim_subscription ()
    60  *
     62
     63/**
    6164 * Subscribe/Unsubscribe a user from a topic
    6265 *
    63  * @package bbPress
    64  * @subpackage bbPress TwentyTen
    6566 * @since bbPress (r2668)
    6667 *
    67  * @return void
     68 * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
     69 * @uses bbp_get_current_user_id() To get the current user id
     70 * @uses current_user_can() To check if the current user can edit the user
     71 * @uses get_post() To get the topic
     72 * @uses check_ajax_referer() To verify the nonce & check the referer
     73 * @uses bbp_is_user_subscribed() To check if the topic is in user's
     74 *                                 subscriptions
     75 * @uses bbp_remove_user_subscriptions() To remove the topic from user's
     76 *                                        subscriptions
     77 * @uses bbp_add_user_subscriptions() To add the topic from user's subscriptions
    6878 */
    6979function bbp_twentyten_dim_subscription () {
    70         global $current_user;
    71 
    7280        if ( !bbp_is_subscriptions_active() )
    7381                return;
    7482
    75         $current_user = wp_get_current_user();
    76         $user_id      = $current_user->ID;
    77         $id           = intval( $_POST['id'] );
     83        $user_id = bbp_get_current_user_id();
     84        $id      = intval( $_POST['id'] );
    7885
    7986        if ( !current_user_can( 'edit_user', $user_id ) )
    … …  
    95102        die( '0' );
    96103}
    97 add_action( 'wp_ajax_dim-subscription', 'bbp_twentyten_dim_subscription' );
    98 
    99 /**
    100  * bbp_twentyten_enqueue_scripts ()
    101  *
     104
     105/**
    102106 * Enqueue the required Javascript files
    103107 *
    104  * @package bbPress
    105  * @subpackage bbPress TwentyTen
    106  * @since bbPress (r2652)
    107  *
    108  * @return void
     108 * @since bbPress (r2652)
     109 *
     110 * @uses bbp_is_topic() To check if it's the topic page
     111 * @uses get_stylesheet_directory_uri() To get the stylesheet directory uri
     112 * @uses bbp_is_user_profile_edit() To check if it's the profile edit page
     113 * @uses wp_enqueue_script() To enqueue the scripts
    109114 */
    110115function bbp_twentyten_enqueue_scripts () {
    … …  
    115120                wp_enqueue_script( 'user-profile' );
    116121}
    117 add_action( 'wp_enqueue_scripts', 'bbp_twentyten_enqueue_scripts' );
    118 
    119 /**
    120  * bbp_twentyten_scripts ()
    121  *
     122
     123/**
    122124 * Put some scripts in the header, like AJAX url for wp-lists
    123125 *
    124  * @package bbPress
    125  * @subpackage bbPress TwentyTen
    126  * @since bbPress (r2652)
    127  *
    128  * @return void
     126 * @since bbPress (r2652)
     127 *
     128 * @uses bbp_is_topic() To check if it's the topic page
     129 * @uses admin_url() To get the admin url
     130 * @uses bbp_is_user_profile_edit() To check if it's the profile edit page
    129131 */
    130132function bbp_twentyten_scripts () {
    … …  
    148150        endif;
    149151}
    150 add_filter( 'wp_head', 'bbp_twentyten_scripts', -1 );
    151 
    152 /**
    153  * bbp_twentyten_topic_script_localization ()
    154  *
     152
     153/**
    155154 * Load localizations for topic script.
    156155 *
    157156 * These localizations require information that may not be loaded even by init.
    158157 *
    159  * @package bbPress
    160  * @subpackage bbPress TwentyTen
    161  * @since bbPress (r2652)
    162  *
    163  * @return void
     158 * @since bbPress (r2652)
     159 *
     160 * @uses bbp_is_topic() To check if it's the topic page
     161 * @uses bbp_get_current_user_id() To get the current user id
     162 * @uses bbp_get_topic_id() To get the topic id
     163 * @uses bbp_get_favorites_permalink() To get the favorites permalink
     164 * @uses bbp_is_user_favorite() To check if the topic is in user's favorites
     165 * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
     166 * @uses bbp_is_user_subscribed() To check if the user is subscribed to topic
     167 * @uses bbp_get_topic_permalink() To get the topic permalink
     168 * @uses wp_localize_script() To localize the script
    164169 */
    165170function bbp_twentyten_topic_script_localization () {
    … …  
    167172                return;
    168173
    169         global $current_user;
    170 
    171         $current_user = wp_get_current_user();
    172         $user_id      = $current_user->ID;
     174        $user_id = bbp_get_current_user_id();
    173175
    174176        $localizations = array(
    … …  
    197199        wp_localize_script( 'bbp_topic', 'bbpTopicJS', $localizations );
    198200}
    199 add_filter( 'wp_enqueue_scripts', 'bbp_twentyten_topic_script_localization' );
     201
     202/* Actions */
     203add_action( 'init',                     'bbp_twentyten_enqueue_styles'               );
     204add_action( 'wp_ajax_dim-favorite',     'bbp_twentyten_dim_favorite'                 );
     205add_action( 'wp_ajax_dim-subscription', 'bbp_twentyten_dim_subscription'             );
     206add_action( 'wp_enqueue_scripts',       'bbp_twentyten_enqueue_scripts'              );
     207add_filter( 'wp_head',                  'bbp_twentyten_scripts',                  -1 );
     208add_filter( 'wp_enqueue_scripts',       'bbp_twentyten_topic_script_localization'    );
    200209
    201210?>
  • branches/plugin/bbp-themes/bbp-twentyten/loop-bbp_forums.php

    r2746 r2758  
    11<?php
     2
    23/**
    34 * The loop that displays bbPress forums.
    45 *
    56 * @package bbPress
    6  * @subpackage Twenty Ten
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/loop-bbp_replies.php

    r2720 r2758  
    11<?php
     2
    23/**
    34 * The loop that displays bbPress replies.
    45 *
    56 * @package bbPress
    6  * @subpackage Twenty Ten
     7 * @subpackage Themes
    78 *
    89 * @todo - Not use table rows
    910 */
     11
    1012?>
    1113
  • branches/plugin/bbp-themes/bbp-twentyten/loop-bbp_topics.php

    r2746 r2758  
    11<?php
     2
    23/**
    34 * The loop that displays bbPress topics.
    45 *
    56 * @package bbPress
    6  * @subpackage Twenty Ten
     7 * @subpackage Themes
    78 */
    89
  • branches/plugin/bbp-themes/bbp-twentyten/page-bbp_form.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * Template Name: bbPress - Create Topic
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Theme
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/page-bbp_front.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * Template Name: bbPress - Forum Index
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Theme
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/page-bbp_no_replies.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * Template Name: bbPress - Topics (No Replies)
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Theme
    78 */
     9
    810?>
    911
    … …  
    2830
    2931                                                                <?php get_template_part( 'loop', 'bbp_topics' ); ?>
    30                                                        
     32
    3133                                                        <?php else : ?>
    3234
  • branches/plugin/bbp-themes/bbp-twentyten/page-bbp_split-merge.php

    r2756 r2758  
    11<?php
     2
    23/**
    34 * Split/merge topic page
    … …  
    67 * @subpackage Themes
    78 */
     9
    810?>
    911<?php get_header(); ?>
  • branches/plugin/bbp-themes/bbp-twentyten/page-bbp_topics.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * Template Name: bbPress - Topic Index
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/pagination-bbp_replies.php

    r2679 r2758  
    11<?php
     2
    23/**
    34 * Pagination for pages of replies (when viewing a topic)
    45 *
    56 * @package bbPress
    6  * @subpackage Twenty Ten
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/pagination-bbp_topics.php

    r2679 r2758  
    11<?php
     2
    23/**
    34 * Pagination for pages of topics (when viewing a forum)
    45 *
    56 * @package bbPress
    6  * @subpackage Twenty Ten
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/single-bbp_forum.php

    r2747 r2758  
    11<?php
     2
    23/**
    34 * bbPress Single Forum
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/single-bbp_reply.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * bbPress Single Reply
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/single-bbp_topic.php

    r2748 r2758  
    11<?php
     2
    23/**
    34 * bbPress Single Topic
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/taxonomy-bbp_topic_tag.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * bbPress Topic Tag
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810
    911$term = get_term_by( 'slug', get_query_var( 'term' ), get_query_var( 'taxonomy' ) );
  • branches/plugin/bbp-themes/bbp-twentyten/user-bbp_details.php

    r2702 r2758  
     1<?php
    12
     3/**
     4 * User details
     5 *
     6 * @package bbPress
     7 * @subpackage Themes
     8 */
     9
     10?>
    211                                <span class="page-title author">
    312                                        <?php printf( __( 'Profile: %s', 'bbpress' ), "<span class='vcard'><a class='url fn n' href='" . bbp_get_user_profile_url() . "' title='" . esc_attr( bbp_get_displayed_user_field( 'display_name' ) ) . "' rel='me'>" . bbp_get_displayed_user_field( 'display_name' ) . "</a></span>" ); ?>
  • branches/plugin/bbp-themes/bbp-twentyten/user-bbp_favorites.php

    r2702 r2758  
     1<?php
    12
     3/**
     4 * User favorites loop
     5 *
     6 * @package bbPress
     7 * @subpackage Themes
     8 */
     9
     10?>
    211                                <?php bbp_set_query_name( 'bbp_user_profile_favorites' ); ?>
    312
  • branches/plugin/bbp-themes/bbp-twentyten/user-bbp_subscriptions.php

    r2702 r2758  
     1<?php
    12
     3/**
     4 * User subscriptions loop
     5 *
     6 * @package bbPress
     7 * @subpackage Themes
     8 */
     9
     10?>
    211                        <?php if ( bbp_is_subscriptions_active() ) : ?>
    312
  • branches/plugin/bbp-themes/bbp-twentyten/user-bbp_topics_created.php

    r2702 r2758  
     1<?php
    12
     3/**
     4 * User topics created loop
     5 *
     6 * @package bbPress
     7 * @subpackage Themes
     8 */
     9
     10?>
    211                                <?php bbp_set_query_name( 'bbp_user_profile_topics_created' ); ?>
    312
  • branches/plugin/bbp-themes/bbp-twentyten/user-edit.php

    r2734 r2758  
    11<?php
     2
    23/**
    3  * bbPress user profile edit
     4 * bbPress user profile edit page
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/bbp-themes/bbp-twentyten/user-posts.php

    r2702 r2758  
     1<?php
    12
     3/**
     4 * User blog posts loop
     5 *
     6 * @package bbPress
     7 * @subpackage Themes
     8 */
     9
     10?>
    211                                <div id="bbp-author-blog-posts" class="bbp-author-blog-posts">
    312                                        <hr />
  • branches/plugin/bbp-themes/bbp-twentyten/user.php

    r2734 r2758  
    11<?php
     2
    23/**
    34 * bbPress user profile
    45 *
    56 * @package bbPress
    6  * @subpackage Template
     7 * @subpackage Themes
    78 */
     9
    810?>
    911
  • branches/plugin/readme.txt

    r2679 r2758  
    11=== bbPress ===
    22Contributors: matt, mdawaffe, johnjamesjacoby, petemall
    3 Tags: bbpress, forums, discussion, post type, content type, theme
     3Tags: bbpress, forums, discussion, post type, theme
    44Requires at least: 3.0
    5 Tested up to: 3.0.1
     5Tested up to: 3.1
    66
    77bbPress is forum software with a twist from the creators of WordPress.
    … …  
    1616
    17171. Place 'bbpress' folder in your plugins directory.
    18 1. Activate bbPress.
    19 1. Visit your Forums settings and configure your forums.
    20 1. Activate a bbPress compatible theme
    21 
     182. Activate bbPress.
     193. Visit your Forums settings and configure your forums.
     204. Activate a bbPress compatible theme
    2221
    2322== Changelog ==
Note: See TracChangeset for help on using the changeset viewer.