Skip to:
Content

BuddyPress.org

Changeset 6259


Ignore:
Timestamp:
08/18/2012 10:15:09 AM (12 years ago)
Author:
djpaul
Message:

Update @since phpdoc on functions to use our formatted version of the tag, e.g. "@since BuddyPress (1.6)". Fixes #4445, props fanquake

Location:
trunk
Files:
37 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-activity/admin/js/admin.dev.js

    r5996 r6259  
    44 * Activity reply object for the activity index screen
    55 *
    6  * @since 1.6
     6 * @since BuddyPress (1.6)
    77 */
    88var activityReply = {
     
    1111     * Attach event handler functions to the relevant elements.
    1212     *
    13      * @since 1.6
     13     * @since BuddyPress (1.6)
    1414     */
    1515    init : function() {
     
    2929     * Reveals the entire row when "reply" is pressed.
    3030     *
    31      * @since 1.6
     31     * @since BuddyPress (1.6)
    3232     */
    3333    open : function( e ) {
     
    4646     * Hide and reset the entire row when "cancel", or escape, are pressed.
    4747     *
    48      * @since 1.6
     48     * @since BuddyPress (1.6)
    4949     */
    5050    close : function( e ) {
     
    6666     * Submits "form" via AJAX back to WordPress.
    6767     *
    68      * @since 1.6
     68     * @since BuddyPress (1.6)
    6969     */
    7070    send : function( e ) {
     
    100100     * send() error message handler
    101101     *
    102      * @since 1.6
     102     * @since BuddyPress (1.6)
    103103     */
    104104    error : function( r ) {
     
    118118     * send() success handler
    119119     *
    120      * @since 1.6
     120     * @since BuddyPress (1.6)
    121121     */
    122122    show : function ( xml ) {
  • trunk/bp-activity/bp-activity-actions.php

    r6093 r6259  
    176176 * @param int $activity_id Activity id to be deleted. Defaults to 0.
    177177 * @return bool False on failure
    178  * @since 1.6
     178 * @since BuddyPress (1.6)
    179179 */
    180180function bp_activity_action_spam_activity( $activity_id = 0 ) {
     
    578578 *
    579579 * @global object $bp BuddyPress global settings
    580  * @since 1.6
     580 * @since BuddyPress (1.6)
    581581 */
    582582function bp_activity_setup_akismet() {
  • trunk/bp-activity/bp-activity-admin.php

    r6193 r6259  
    77 *
    88 * @package BuddyPress
    9  * @since 1.6
     9 * @since BuddyPress (1.6)
    1010 * @subpackage Activity
    1111 */
     
    2424 * Registers the Activity component admin screen
    2525 *
    26  * @since 1.6
     26 * @since BuddyPress (1.6)
    2727 */
    2828function bp_activity_add_admin_menu() {
     
    4343 * comment, and returns HTML for a new table row.
    4444 *
    45  * @since 1.6
     45 * @since BuddyPress (1.6)
    4646 */
    4747function bp_activity_admin_reply() {
     
    117117 * @param string $new_value Screen option form value
    118118 * @return string Option value. False to abandon update.
    119  * @since 1.6
     119 * @since BuddyPress (1.6)
    120120 */
    121121function bp_activity_admin_screen_options( $value, $option, $new_value ) {
     
    136136 * @param WP_Screen $screen Screen identifier
    137137 * @return array Hidden Meta Boxes
    138  * @since 1.0
     138 * @since BuddyPress (1.0)
    139139 */
    140140function bp_activity_admin_edit_hidden_metaboxes( $hidden, $screen ) {
     
    154154 * @global object $bp BuddyPress global settings
    155155 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
    156  * @since 1.6
     156 * @since BuddyPress (1.6)
    157157 */
    158158function bp_activity_admin_load() {
     
    504504 * Outputs the Activity component admin screens
    505505 *
    506  * @since 1.6
     506 * @since BuddyPress (1.6)
    507507 */
    508508function bp_activity_admin() {
     
    523523 *
    524524 * @global int $screen_layout_columns Number of columns shown on this admin page
    525  * @since 1.6
     525 * @since BuddyPress (1.6)
    526526 */
    527527function bp_activity_admin_edit() {
     
    617617 *
    618618 * @param object $item Activity item
    619  * @since 1.6
     619 * @since BuddyPress (1.6)
    620620 */
    621621function bp_activity_admin_edit_metabox_status( $item ) {
     
    672672 *
    673673 * @param object $item Activity item
    674  * @since 1.6
     674 * @since BuddyPress (1.6)
    675675 */
    676676function bp_activity_admin_edit_metabox_link( $item ) {
     
    688688 *
    689689 * @param object $item Activity item
    690  * @since 1.6
     690 * @since BuddyPress (1.6)
    691691 */
    692692function bp_activity_admin_edit_metabox_userid( $item ) {
     
    704704 * @global object $bp BuddyPress global settings
    705705 * @param object $item Activity item
    706  * @since 1.6
     706 * @since BuddyPress (1.6)
    707707 */
    708708function bp_activity_admin_edit_metabox_type( $item ) {
     
    740740 *
    741741 * @param object $item Activity item
    742  * @since 1.6
     742 * @since BuddyPress (1.6)
    743743 */
    744744function bp_activity_admin_edit_metabox_itemids( $item ) {
     
    762762 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
    763763 * @global string $plugin_page
    764  * @since 1.6
     764 * @since BuddyPress (1.6)
    765765 */
    766766function bp_activity_admin_index() {
     
    887887 * List table class for the Activity component admin page.
    888888 *
    889  * @since 1.6
     889 * @since BuddyPress (1.6)
    890890 */
    891891class BP_Activity_List_Table extends WP_List_Table {
     
    893893     * What type of view is being displayed? e.g. "All", "Pending", "Approved", "Spam"...
    894894     *
    895      * @since 1.6
     895     * @since BuddyPress (1.6)
    896896    */
    897897    public $view = 'all';
     
    900900     * How many activity items have been marked as spam.
    901901     *
    902      * @since 1.6
     902     * @since BuddyPress (1.6)
    903903     */
    904904    public $spam_count = 0;
     
    907907     * Store activity-to-user-ID mappings for use in the In Response To column.
    908908     *
    909      * @since 1.6
     909     * @since BuddyPress (1.6)
    910910     */
    911911    protected $activity_user_id = array();
     
    914914     * Constructor
    915915     *
    916      * @since 1.6
     916     * @since BuddyPress (1.6)
    917917     */
    918918    public function __construct() {
     
    929929     * Handle filtering of data, sorting, pagination, and any other data-manipulation required prior to rendering.
    930930     *
    931      * @since 1.6
     931     * @since BuddyPress (1.6)
    932932     */
    933933    function prepare_items() {
     
    10311031     *
    10321032     * @return array
    1033      * @since 1.6
     1033     * @since BuddyPress (1.6)
    10341034     */
    10351035    function get_column_info() {
     
    10461046     * Displays a message on screen when no items are found (e.g. no search matches)
    10471047     *
    1048      * @since 1.6
     1048     * @since BuddyPress (1.6)
    10491049     */
    10501050    function no_items() {
     
    10551055     * Outputs the Activity data table
    10561056     *
    1057      * @since 1.6
     1057     * @since BuddyPress (1.6)
    10581058    */
    10591059    function display() {
     
    10891089     *
    10901090     * @param object $item The current item
    1091      * @since 1.6
     1091     * @since BuddyPress (1.6)
    10921092     */
    10931093    function single_row( $item ) {
     
    11031103     * Get the list of views available on this table (e.g. "all", "spam").
    11041104     *
    1105      * @since 1.6
     1105     * @since BuddyPress (1.6)
    11061106     */
    11071107    function get_views() {
     
    11211121     *
    11221122     * @return array Key/value pairs for the bulk actions dropdown
    1123      * @since 1.6
     1123     * @since BuddyPress (1.6)
    11241124     */
    11251125    function get_bulk_actions() {
     
    11371137     * @see WP_List_Table::single_row_columns()
    11381138     * @return array
    1139      * @since 1.6
     1139     * @since BuddyPress (1.6)
    11401140     */
    11411141    function get_columns() {
     
    11521152     *
    11531153     * @return array
    1154      * @since 1.6
     1154     * @since BuddyPress (1.6)
    11551155     * @todo For this to work, BP_Activity_Activity::get() needs updating to supporting ordering by specific fields
    11561156     */
     
    11681168     * @global object $bp BuddyPress global settings
    11691169     * @param string $which 'top' or 'bottom'
    1170      * @since 1.6
     1170     * @since BuddyPress (1.6)
    11711171     */
    11721172    function extra_tablenav( $which ) {
     
    12171217     * @param array $item A singular item (one full row)
    12181218     * @see WP_List_Table::single_row_columns()
    1219      * @since 1.6
     1219     * @since BuddyPress (1.6)
    12201220     */
    12211221    function column_cb( $item ) {
     
    12281228     * @param array $item A singular item (one full row)
    12291229     * @see WP_List_Table::single_row_columns()
    1230      * @since 1.6
     1230     * @since BuddyPress (1.6)
    12311231     */
    12321232    function column_author( $item ) {
     
    12411241     * @param array $item A singular item (one full row)
    12421242     * @see WP_List_Table::single_row_columns()
    1243      * @since 1.6
     1243     * @since BuddyPress (1.6)
    12441244     */
    12451245    function column_comment( $item ) {
     
    13121312     * @param array $item A singular item (one full row)
    13131313     * @see WP_List_Table::single_row_columns()
    1314      * @since 1.6
     1314     * @since BuddyPress (1.6)
    13151315     */
    13161316    function column_response( $item ) {
     
    13401340     *
    13411341     * @param int $activity_id Activity ID to retrieve User ID for
    1342      * @since 1.6
     1342     * @since BuddyPress (1.6)
    13431343     */
    13441344    protected function get_activity_user_id( $activity_id ) {
     
    13741374     * @param array $tree Source array
    13751375     * @return array Flattened array
    1376      * @since 1.6
     1376     * @since BuddyPress (1.6)
    13771377     */
    13781378    public static function flatten_activity_array( $tree ){
  • trunk/bp-activity/bp-activity-akismet.php

    r6184 r6259  
    44 *
    55 * @package BuddyPress
    6  * @since 1.6
     6 * @since BuddyPress (1.6)
    77 * @subpackage Activity
    88 */
     
    1717     * @access protected
    1818     * @var BP_Activity_Activity
    19      * @since 1.6
     19     * @since BuddyPress (1.6)
    2020     */
    2121    protected $last_activity = null;
     
    2424     * Constructor
    2525     *
    26      * @since 1.6
     26     * @since BuddyPress (1.6)
    2727     */
    2828    public function __construct() {
     
    3333     * Hook Akismet into the activity stream
    3434     *
    35      * @since 1.6
     35     * @since BuddyPress (1.6)
    3636     */
    3737    protected function setup_actions() {
     
    6868     * @param array $activity The activity for the current row being processed
    6969     * @return array The hover links
    70      * @since 1.6
     70     * @since BuddyPress (1.6)
    7171     */
    7272    function comment_row_action( $actions, $activity ) {
     
    115115     *
    116116     * @see http://plugins.trac.wordpress.org/ticket/1232
    117      * @since 1.6
     117     * @since BuddyPress (1.6)
    118118     */
    119119    public function add_activity_stream_nonce() {
     
    139139     * @param int $activity_id Activity ID
    140140     * @see bp_dtheme_post_update()
    141      * @since 1.6
     141     * @since BuddyPress (1.6)
    142142     */
    143143    public function check_member_activity_update( $content, $user_id, $activity_id ) {
     
    159159     * This function is intended to be used inside the activity stream loop.
    160160     *
    161      * @since 1.6
     161     * @since BuddyPress (1.6)
    162162     */
    163163    public function add_activity_spam_button() {
     
    187187     * This function is intended to be used inside the activity stream loop.
    188188     *
    189      * @since 1.6
     189     * @since BuddyPress (1.6)
    190190     */
    191191    public function add_activity_comment_spam_button() {
     
    215215     *
    216216     * @return array List of activity types
    217      * @since 1.6
     217     * @since BuddyPress (1.6)
    218218     * @static
    219219     */
     
    227227     * @param BP_Activity_Activity $activity
    228228     * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as spam) or "by_akismet" (automatically spammed).
    229      * @since 1.6
     229     * @since BuddyPress (1.6)
    230230     */
    231231    public function mark_as_spam( $activity, $source ) {
     
    241241     * @param BP_Activity_Activity $activity
    242242     * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as ham) or "by_akismet" (automatically hammed).
    243      * @since 1.6
     243     * @since BuddyPress (1.6)
    244244     */
    245245    public function mark_as_ham( $activity, $source ) {
     
    256256     * @param BP_Activity_Activity $activity
    257257     * @see http://akismet.com/development/api/#comment-check
    258      * @since 1.6
     258     * @since BuddyPress (1.6)
    259259     * @static
    260260     */
     
    295295     * @param BP_Activity_Activity $activity The activity item to check
    296296     * @see http://akismet.com/development/api/
    297      * @since 1.6
     297     * @since BuddyPress (1.6)
    298298     * @todo Spam counter?
    299299     * @todo Auto-delete old spam?
     
    336336     *
    337337     * @param BP_Activity_Activity $activity The activity to check
    338      * @since 1.6
     338     * @since BuddyPress (1.6)
    339339     */
    340340    public function update_activity_spam_meta( $activity ) {
     
    352352     *
    353353     * @param BP_Activity_Activity $activity The activity to check
    354      * @since 1.6
     354     * @since BuddyPress (1.6)
    355355     */
    356356    public function update_activity_ham_meta( $activity ) {
     
    368368     *
    369369     * @param BP_Activity_Activity $activity The activity to check
    370      * @since 1.6
     370     * @since BuddyPress (1.6)
    371371     */
    372372    public function update_activity_akismet_meta( $activity ) {
     
    409409     * @param string $check "check" or "submit"
    410410     * @param string $spam "spam" or "ham"
    411      * @since 1.6
     411     * @since BuddyPress (1.6)
    412412     */
    413413    public function send_akismet_request( $activity_data, $check = 'check', $spam = 'spam' ) {
     
    481481     *
    482482     * @param string $user_agent
    483      * @since 1.6
     483     * @since BuddyPress (1.6)
    484484     */
    485485    public function buddypress_ua( $user_agent ) {
     
    492492     *
    493493     * @param string $screen_action The type of screen that has been requested
    494      * @since 1.6
     494     * @since BuddyPress (1.6)
    495495     */
    496496    function add_history_metabox( $screen_action ) {
     
    507507     *
    508508     * @param object $item Activity item
    509      * @since 1.6
     509     * @since BuddyPress (1.6)
    510510     * @todo Update activity meta to allow >1 record with the same key (iterate through $history).
    511511     * @see http://buddypress.trac.wordpress.org/ticket/3907
     
    528528     * @param string $message Human-readable description of what's changed
    529529     * @param string $event The type of check we were carrying out
    530      * @since 1.6
     530     * @since BuddyPress (1.6)
    531531     */
    532532    public function update_activity_history( $activity_id = 0, $message = '', $event = '' ) {
     
    547547     * @param int $activity_id Activity item ID
    548548     * @return array The activity item's Akismet history
    549      * @since 1.6
     549     * @since BuddyPress (1.6)
    550550     */
    551551    public function get_activity_history( $activity_id = 0 ) {
     
    566566 * @global object $bp BuddyPress global settings
    567567 * @global wpdb $wpdb WordPress database object
    568  * @since 1.6
     568 * @since BuddyPress (1.6)
    569569 */
    570570function bp_activity_akismet_delete_old_metadata() {
  • trunk/bp-activity/bp-activity-cache.php

    r6093 r6259  
    44 * Functions related to the BuddyPress Activity component and the WP Cache
    55 *
    6  * @since 1.6
     6 * @since BuddyPress (1.6)
    77 */
    88
  • trunk/bp-activity/bp-activity-classes.php

    r6167 r6259  
    298298     * @param bool $display_comments Retrieve an activity item's associated comments or not. (Optional; default is false)
    299299     * @return array
    300      * @since 1.2
     300     * @since BuddyPress (1.2)
    301301     */
    302302    function get_specific( $activity_ids, $max = false, $page = 1, $per_page = 25, $sort = 'DESC', $display_comments = false ) {
     
    446446     * @param bool $spam Optional; 'ham_only' (default), 'spam_only' or 'all'.
    447447     * @return array The updated activities with nested comments
    448      * @since 1.2
     448     * @since BuddyPress (1.2)
    449449     */
    450450    function append_comments( $activities, $spam = 'ham_only' ) {
     
    477477     * @param bool $spam Optional; 'ham_only' (default), 'spam_only' or 'all'.
    478478     * @return array The updated activities with nested comments
    479      * @since 1.2
     479     * @since BuddyPress (1.2)
    480480     */
    481481    function get_activity_comments( $activity_id, $left, $right, $spam = 'ham_only' ) {
  • trunk/bp-activity/bp-activity-functions.php

    r6093 r6259  
    660660 * @global object $bp BuddyPress global settings
    661661 * @param int $user_id
    662  * @since 1.6
     662 * @since BuddyPress (1.6)
    663663 */
    664664function bp_activity_spam_all_user_data( $user_id = 0 ) {
     
    711711 * @global object $bp BuddyPress global settings
    712712 * @param int $user_id
    713  * @since 1.6
     713 * @since BuddyPress (1.6)
    714714 */
    715715function bp_activity_ham_all_user_data( $user_id = 0 ) {
     
    760760 *
    761761 * @global object $bp BuddyPress global settings
    762  * @since 1.6
     762 * @since BuddyPress (1.6)
    763763 */
    764764function bp_activity_register_activity_actions() {
     
    14731473 *
    14741474 * @return bool True if user is allowed to mark activity items as spam
    1475  * @since 1.6
     1475 * @since BuddyPress (1.6)
    14761476 * @static
    14771477 */
     
    14861486 * @param BP_Activity_Activity $activity
    14871487 * @param string $source Optional; default is "by_a_person" (e.g. a person has manually marked the activity as spam).
    1488  * @since 1.6
     1488 * @since BuddyPress (1.6)
    14891489 */
    14901490function bp_activity_mark_as_spam( &$activity, $source = 'by_a_person' ) {
     
    15221522 * @param BP_Activity_Activity $activity
    15231523 * @param string $source Optional; default is "by_a_person" (e.g. a person has manually marked the activity as spam).
    1524  * @since 1.6
     1524 * @since BuddyPress (1.6)
    15251525 */
    15261526function bp_activity_mark_as_ham( &$activity, $source = 'by_a_person' ) {
  • trunk/bp-activity/bp-activity-loader.php

    r6093 r6259  
    324324     * Setup the actions
    325325     *
    326      * @since 1.6
     326     * @since BuddyPress (1.6)
    327327     */
    328328     function setup_actions() {
  • trunk/bp-blogs/bp-blogs-filters.php

    r6093 r6259  
    66 * @package BuddyPress
    77 * @subpackage Blogs
    8  * @since 1.6
     8 * @since BuddyPress (1.6)
    99 */
    1010
     
    1212 * Ensures that the 'Create a new site' link at wp-admin/my-sites.php points to the BP blog signup
    1313 *
    14  * @since 1.6
     14 * @since BuddyPress (1.6)
    1515 * @uses apply_filters() Filter bp_blogs_creation_location to alter the returned value
    1616 *
  • trunk/bp-blogs/bp-blogs-functions.php

    r6093 r6259  
    354354 * that the Blogs component is loaded first. See http://buddypress.trac.wordpress.org/ticket/3916
    355355 *
    356  * @since 1.6
     356 * @since BuddyPress (1.6)
    357357 */
    358358function bp_blogs_maybe_add_user_to_blog() {
     
    441441 * @param string $old_status Previous comment status.
    442442 * @param object $comment Comment data.
    443  * @since 1.6
     443 * @since BuddyPress (1.6)
    444444 */
    445445function bp_blogs_transition_activity_status( $new_status, $old_status, $comment ) {
  • trunk/bp-blogs/bp-blogs-template.php

    r6080 r6259  
    512512 * Echo the value of bp_blogs_get_subdomain_base()
    513513 *
    514  * @since 1.6
     514 * @since BuddyPress (1.6)
    515515 */
    516516function bp_blogs_subdomain_base() {
     
    521521     * a subdomain installation of WordPress MS
    522522     *
    523      * @since 1.6
     523     * @since BuddyPress (1.6)
    524524     * @return str The base URL - eg, 'example.com' for site_url() example.com or www.example.com
    525525     */
  • trunk/bp-core/admin/bp-core-functions.php

    r6137 r6259  
    3333 * @global array $_registered_pages
    3434 * @global array $submenu
    35  * @since 1.6
     35 * @since BuddyPress (1.6)
    3636 */
    3737function bp_core_admin_backpat_menu() {
     
    6666 * Tweak the Settings subnav menu to show only one BuddyPress menu item (Settings > BuddyPress).
    6767 *
    68  * @since 1.6
     68 * @since BuddyPress (1.6)
    6969 */
    7070function bp_core_modify_admin_menu() {
     
    8686 * @global string $plugin_page
    8787 * @global array $submenu
    88  * @since 1.6
     88 * @since BuddyPress (1.6)
    8989 */
    9090function bp_core_modify_admin_menu_highlight() {
     
    102102 *
    103103 * @see bp_core_admin_backpat_menu()
    104  * @since 1.6
     104 * @since BuddyPress (1.6)
    105105 * @todo Add convenience links into the markup once new positions are finalised.
    106106 */
  • trunk/bp-core/admin/bp-core-update.php

    r6239 r6259  
    658658     * When upgrading to BP 1.6, prompt the admin to switch to WordPress' Toolbar.
    659659     *
    660      * @since 1.6
     660     * @since BuddyPress (1.6)
    661661     */
    662662    function step_admin_bar() {
     
    944944     * If they choose not to, record that preference in the options table.
    945945     *
    946      * @since 1.6
     946     * @since BuddyPress (1.6)
    947947     */
    948948    function step_admin_bar_save() {
  • trunk/bp-core/bp-core-cache.php

    r6181 r6259  
    6161 * Update the metadata cache for the specified objects.
    6262 *
    63  * @since 1.6
     63 * @since BuddyPress (1.6)
    6464 * @global $wpdb WordPress database object for queries.
    6565 * @param array $args See $defaults definition for more details
  • trunk/bp-core/bp-core-catchuri.php

    r6253 r6259  
    524524 * example.com/groups/mygroup/home/
    525525 *
    526  * @since 1.6
     526 * @since BuddyPress (1.6)
    527527 * @see BP_Members_Component::setup_globals() where $bp->canonical_stack['base_url'] and
    528528 *   ['component'] may be set
     
    577577 * Output rel=canonical header tag for BuddyPress content
    578578 *
    579  * @since 1.6
     579 * @since BuddyPress (1.6)
    580580 */
    581581function bp_rel_canonical() {
     
    703703 * (and plugin authors!) should ignore it.
    704704 *
    705  * @since 1.6.1
     705 * @since BuddyPress (1.6.1)
    706706 *
    707707 * @link http://buddypress.trac.wordpress.org/ticket/4329
     
    723723 * notice in future versions of BuddyPress.
    724724 *
    725  * @since 1.6
     725 * @since BuddyPress (1.6)
    726726 */
    727727function _bp_maybe_remove_rel_canonical() {
  • trunk/bp-core/bp-core-classes.php

    r6121 r6259  
    874874 *
    875875 * @package BuddyPress Core
    876  * @since 1.2.6
     876 * @since BuddyPress (1.2.6)
    877877 */
    878878class BP_Button {
  • trunk/bp-core/bp-core-cssjs.php

    r6003 r6259  
    130130 * Adds AJAX target URL so themes can access the WordPress AJAX functionality.
    131131 *
    132  * @since 1.1
     132 * @since BuddyPress (1.1)
    133133 */
    134134function bp_core_add_ajax_url_js() {
  • trunk/bp-core/bp-core-functions.php

    r6209 r6259  
    255255 *
    256256 * @package BuddyPress Core
    257  * @since 1.2.6
     257 * @since BuddyPress (1.2.6)
    258258 */
    259259function bp_core_current_time( $gmt = true ) {
  • trunk/bp-core/bp-core-moderation.php

    r6093 r6259  
    55 * @package BuddyPress
    66 * @subpackage Core
    7  * @since 1.6
     7 * @since BuddyPress (1.6)
    88 */
    99
     
    2121 * @param int $user_id User id to check for flood
    2222 * @return bool True if there is no flooding, true if there is
    23  * @since 1.6
     23 * @since BuddyPress (1.6)
    2424 * @uses current_user_can() To check if the current user can throttle
    2525 * @uses bp_get_option() To get the throttle time
     
    5151 * @param string $content The content being posted
    5252 * @return bool True if test is passed, false if fail
    53  * @since 1.6
     53 * @since BuddyPress (1.6)
    5454 * @uses bp_current_author_ip() To get current user IP address
    5555 * @uses bp_current_author_ua() To get current user agent
     
    160160 * @uses bp_current_author_ua() To get current user agent
    161161 * @uses bp_current_user_can() Allow super admins to bypass blacklist
    162  * @since 1.6
     162 * @since BuddyPress (1.6)
    163163 */
    164164function bp_core_check_for_blacklist( $user_id = 0, $title = '', $content = '' ) {
     
    242242 *
    243243 * @return string
    244  * @since 1.6
     244 * @since BuddyPress (1.6)
    245245 */
    246246function bp_core_current_user_ip() {
     
    254254 *
    255255 * @return string
    256  * @since 1.6
     256 * @since BuddyPress (1.6)
    257257 */
    258258function bp_core_current_user_ua() {
  • trunk/bp-core/bp-core-template.php

    r6249 r6259  
    162162     * Returns the name of the BP site. Used in RSS headers
    163163     *
    164      * @since 1.6
     164     * @since BuddyPress (1.6)
    165165     */
    166166    function bp_get_site_name() {
     
    248248 *
    249249 * @return string HTML <select> element
    250  * @since 1.0
     250 * @since BuddyPress (1.0)
    251251 */
    252252function bp_search_form_type_select() {
  • trunk/bp-core/deprecated/1.5.php

    r6125 r6259  
    4444 * @param int $blog_id optional blog id to test (default current blog)
    4545 * @return bool True if not multisite or $blog_id is main site
    46  * @since 1.2.6
     46 * @since BuddyPress (1.2.6)
    4747 */
    4848function bp_core_is_main_site( $blog_id = '' ) {
     
    7474 * @deprecated 1.5
    7575 * @deprecated Use add_menu_page().
    76  * @since 1.1
     76 * @since BuddyPress (1.1)
    7777 */
    7878function bp_core_add_admin_menu_page( $args = '' ) {
     
    252252 * @deprecated 1.5
    253253 * @deprecated Use wp_title()
    254  * @since 1.0
     254 * @since BuddyPress (1.0)
    255255 */
    256256function bp_page_title() {
     
    263263     * @deprecated 1.5
    264264     * @deprecated Use wp_title()
    265      * @since 1.0
     265     * @since BuddyPress (1.0)
    266266     */
    267267    function bp_get_page_title() {
     
    280280 * @deprecated 1.5
    281281 * @deprecated Use wp_logout_url()
    282  * @since 1.0
     282 * @since BuddyPress (1.0)
    283283 */
    284284function bp_log_out_link() {
     
    441441     * @return string
    442442     * @see wp_dropdown_pages()
    443      * @since 1.2
     443     * @since BuddyPress (1.2)
    444444     */
    445445    function bp_dtheme_wp_pages_filter( $page_html ) {
     
    459459     * @param $string $oldvalue New value of get_option( 'page_on_front' )
    460460     * @return string
    461      * @since 1.2
     461     * @since BuddyPress (1.2)
    462462     */
    463463    function bp_dtheme_page_on_front_update( $oldvalue, $newvalue ) {
     
    479479     * @param string $template Absolute path to the page template
    480480     * @return string
    481      * @since 1.2
     481     * @since BuddyPress (1.2)
    482482     */
    483483    function bp_dtheme_page_on_front_template( $template ) {
     
    494494     * @deprecated 1.5
    495495     * @deprecated No longer required.
    496      * @since 1.2
     496     * @since BuddyPress (1.2)
    497497     */
    498498    function bp_dtheme_fix_get_posts_on_activity_front() {
     
    510510     * @param array $posts Posts as retrieved by WP_Query
    511511     * @return array
    512      * @since 1.2.5
     512     * @since BuddyPress (1.2.5)
    513513     */
    514514    function bp_dtheme_fix_the_posts_on_activity_front( $posts ) {
     
    525525     * @deprecated 1.5
    526526     * @deprecated Enqueue the comment-reply script in your theme's header.php.
    527      * @since 1.2
     527     * @since BuddyPress (1.2)
    528528     */
    529529    function bp_dtheme_add_blog_comments_js() {
  • trunk/bp-forums/bp-forums-functions.php

    r6108 r6259  
    346346 * Prevents dupes.
    347347 *
    348  * @since 1.6
     348 * @since BuddyPress (1.6)
    349349 *
    350350 * @param str $text The text of the comment
  • trunk/bp-friends/bp-friends-functions.php

    r6101 r6259  
    231231 * user is not a group admin.
    232232 *
    233  * @since 1.0
     233 * @since BuddyPress (1.0)
    234234 * @param int $user_id User ID whose friends to see can be invited
    235235 * @param int $group_id Group to check possible invitations against
  • trunk/bp-groups/bp-groups-classes.php

    r6241 r6259  
    10981098     * @param int $user_id
    10991099     * @param int $group_id
    1100      * @since 1.2.6
     1100     * @since BuddyPress (1.2.6)
    11011101     */
    11021102    function check_is_creator( $user_id, $group_id ) {
     
    12171217     * @global wpdb $wpdb WordPress database object
    12181218     * @param int $user_id
    1219      * @since 1.0
     1219     * @since BuddyPress (1.0)
    12201220     * @uses BP_Groups_Member
    12211221     */
     
    12491249 * @package BuddyPress
    12501250 * @subpackage Groups
    1251  * @since 1.1
     1251 * @since BuddyPress (1.1)
    12521252 */
    12531253class BP_Group_Extension {
  • trunk/bp-groups/bp-groups-forums.php

    r6240 r6259  
    2424 * @param string $group_description The group description
    2525 *
    26  * @since 1.0
     26 * @since BuddyPress (1.0)
    2727 */
    2828function groups_new_group_forum( $group_id = 0, $group_name = '', $group_desc = '' ) {
     
    5353 * @param int $group_id Group id, passed from groups_details_updated
    5454 *
    55  * @since 1.1
     55 * @since BuddyPress (1.1)
    5656 */
    5757function groups_update_group_forum( $group_id ) {
     
    9090 * @return mixed The new forum post ID on success. Boolean false on failure.
    9191 *
    92  * @since 1.0
     92 * @since BuddyPress (1.0)
    9393 */
    9494function groups_new_group_forum_post( $post_text, $topic_id, $page = false ) {
     
    138138 * @return mixed The new topic object on success. Boolean false on failure.
    139139 *
    140  * @since 1.0
     140 * @since BuddyPress (1.0)
    141141 */
    142142function groups_new_group_forum_topic( $topic_title, $topic_text, $topic_tags, $forum_id ) {
     
    184184 * @return mixed The topic object on success. Boolean false on failure.
    185185 *
    186  * @since 1.1
     186 * @since BuddyPress (1.1)
    187187 */
    188188function groups_update_group_forum_topic( $topic_id, $topic_title, $topic_text, $topic_tags = false ) {
     
    239239 * @return mixed The forum post ID on success. Boolean false on failure.
    240240 *
    241  * @since 1.1
     241 * @since BuddyPress (1.1)
    242242 */
    243243function groups_update_group_forum_post( $post_id, $post_text, $topic_id, $page = false ) {
     
    303303 * @return bool True if the delete routine went through properly
    304304 *
    305  * @since 1.1
     305 * @since BuddyPress (1.1)
    306306 */
    307307function groups_delete_group_forum_topic( $topic_id ) {
     
    355355 * @return bool True on success.
    356356 *
    357  * @since 1.1
     357 * @since BuddyPress (1.1)
    358358 */
    359359function groups_delete_group_forum_post( $post_id, $topic_id = false ) {
     
    384384 *
    385385 * @package BuddyPress
    386  * @since 1.5
     386 * @since BuddyPress (1.5)
    387387 *
    388388 * @param string $type Either 'newest', 'popular', 'unreplied', 'tags'.  Defaults to 'newest'.
     
    397397 *
    398398 * @package BuddyPress
    399  * @since 1.5
     399 * @since BuddyPress (1.5)
    400400 *
    401401 * @param str $status 'public', 'private', 'hidden', 'all' Which group types to count
  • trunk/bp-groups/bp-groups-functions.php

    r6150 r6259  
    196196 * @global object $bp BuddyPress global settings
    197197 * @param int $group_id
    198  * @since 1.0
     198 * @since BuddyPress (1.0)
    199199 */
    200200function groups_delete_group( $group_id ) {
     
    266266 * Get a group ID by its slug
    267267 *
    268  * @since 1.6
     268 * @since BuddyPress (1.6)
    269269 *
    270270 * @param string $group_slug The group's slug
     
    502502 * @param int $user_id
    503503 * @param int $group_id
    504  * @since 1.2.6
     504 * @since BuddyPress (1.2.6)
    505505 * @uses BP_Groups_Member
    506506 */
  • trunk/bp-groups/bp-groups-template.php

    r6005 r6259  
    10061006 * @deprecated 1.5
    10071007 * @deprecated No longer used.
    1008  * @since 1.0
     1008 * @since BuddyPress (1.0)
    10091009 * @todo Remove in 1.4
    10101010 */
     
    16131613 * @global BP_Groups_Template $groups_template Groups template object
    16141614 * @param object $group Group to get status message for. Optional; defaults to current group.
    1615  * @since 1.0
     1615 * @since BuddyPress (1.0)
    16161616 */
    16171617function bp_group_status_message( $group = null ) {
     
    21952195 * Echoes the current group creation step
    21962196 *
    2197  * @since 1.6
     2197 * @since BuddyPress (1.6)
    21982198 */
    21992199function bp_groups_current_create_step() {
     
    22032203     * Returns the current group creation step. If none is found, returns an empty string
    22042204     *
    2205      * @since 1.6
     2205     * @since BuddyPress (1.6)
    22062206     *
    22072207     * @uses apply_filters() Filter bp_get_groups_current_create_step to modify
     
    23612361 * Echoes the current group admin tab slug
    23622362 *
    2363  * @since 1.6
     2363 * @since BuddyPress (1.6)
    23642364 */
    23652365function bp_group_current_admin_tab() {
     
    23692369     * Returns the current group admin tab slug
    23702370     *
    2371      * @since 1.6
     2371     * @since BuddyPress (1.6)
    23722372     *
    23732373     * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value
  • trunk/bp-members/bp-members-functions.php

    r6208 r6259  
    850850 * @return obj If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.
    851851 *
    852  * @since 1.1.2
     852 * @since BuddyPress (1.1.2)
    853853 */
    854854function bp_core_boot_spammer( $user ) {
     
    12831283 * @return obj If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.
    12841284 *
    1285  * @since 1.2.2
     1285 * @since BuddyPress (1.2.2)
    12861286 */
    12871287function bp_core_signup_disable_inactive( $user ) {
  • trunk/bp-messages/bp-messages-template.php

    r6052 r6259  
    636636 *
    637637 * @uses bp_get_send_message_button()
    638  * @since 1.2.6
     638 * @since BuddyPress (1.2.6)
    639639 */
    640640function bp_send_private_message_button() {
  • trunk/bp-themes/bp-default/_inc/ajax.php

    r6021 r6259  
    1010 *
    1111 * @package BuddyPress
    12  * @since 1.2
     12 * @since BuddyPress (1.2)
    1313 * @subpackage BP-Default
    1414 */
  • trunk/bp-themes/bp-default/functions.php

    r6089 r6259  
    2525 * @package BuddyPress
    2626 * @subpackage BP-Default
    27  * @since 1.2
     27 * @since BuddyPress (1.2)
    2828 */
    2929
     
    227227 * Referenced via add_custom_image_header() in bp_dtheme_setup().
    228228 *
    229  * @since 1.2
     229 * @since BuddyPress (1.2)
    230230 */
    231231function bp_dtheme_admin_header_style() {
     
    335335 *
    336336 * @global WP_Query $post The current WP_Query object for the current post or page
    337  * @since 1.2
     337 * @since BuddyPress (1.2)
    338338 */
    339339function bp_dtheme_header_style() {
     
    454454 * @param int $depth Comment nesting level
    455455 * @see wp_list_comments()
    456  * @since 1.2
     456 * @since BuddyPress (1.2)
    457457 */
    458458function bp_dtheme_blog_comments( $comment, $args, $depth ) {
     
    521521 *
    522522 * @return false|int ID of page set as the home page
    523  * @since 1.2
     523 * @since BuddyPress (1.2)
    524524 */
    525525function bp_dtheme_page_on_front() {
     
    539539 * @package BuddyPress Theme
    540540 * @return string
    541  * @since 1.2.6
     541 * @since BuddyPress (1.2.6)
    542542 */
    543543function bp_dtheme_activity_secondary_avatars( $action, $activity ) {
     
    563563 * Show a notice when the theme is activated - workaround by Ozh (http://old.nabble.com/Activation-hook-exist-for-themes--td25211004.html)
    564564 *
    565  * @since 1.2
     565 * @since BuddyPress (1.2)
    566566 */
    567567function bp_dtheme_show_notice() {
  • trunk/bp-xprofile/bp-xprofile-caps.php

    r6093 r6259  
    55 *
    66 * @package BuddyPress
    7  * @since 1.6
     7 * @since BuddyPress (1.6)
    88 */
    99
     
    1414 * Maps XProfile caps to built in WordPress caps
    1515 *
    16  * @since 1.6
     16 * @since BuddyPress (1.6)
    1717 *
    1818 * @param array $caps Capabilities for meta capability
  • trunk/bp-xprofile/bp-xprofile-classes.php

    r6223 r6259  
    288288     * Fetch the field visibility level for the fields returned by the query
    289289     *
    290      * @since 1.6
     290     * @since BuddyPress (1.6)
    291291     *
    292292     * @param int $user_id The profile owner's user_id
     
    324324     * Fetch the admin-set preferences for all fields
    325325     *
    326      * @since 1.6
     326     * @since BuddyPress (1.6)
    327327     *
    328328     * @return array $default_visibility_levels An array, keyed by field_id, of default
  • trunk/bp-xprofile/bp-xprofile-cssjs.php

    r5751 r6259  
    3030 * Enqueue the jQuery libraries for handling drag/drop/sort
    3131 *
    32  * @since BuddyPres (1.5)
     32 * @since BuddyPress (1.5)
    3333 */
    3434function xprofile_add_admin_js() {
  • trunk/bp-xprofile/bp-xprofile-functions.php

    r6070 r6259  
    461461 * Syncs the standard built in WordPress profile data to XProfile.
    462462 *
    463  * @since 1.2.4
     463 * @since BuddyPress (1.2.4)
    464464 * @package BuddyPress Core
    465465 */
     
    649649 * be excluded from the profile loop.
    650650 *
    651  * @since 1.6
     651 * @since BuddyPress (1.6)
    652652 * @see BP_XProfile_Group::get()
    653653 * @uses apply_filters() Filter bp_xprofile_get_hidden_fields_for_user to modify visibility levels,
     
    701701 * Fetch an array of the xprofile fields that a given user has marked with certain visibility levels
    702702 *
    703  * @since 1.6
     703 * @since BuddyPress (1.6)
    704704 * @see bp_xprofile_get_hidden_fields_for_user()
    705705 *
  • trunk/bp-xprofile/bp-xprofile-loader.php

    r6093 r6259  
    2727     *
    2828     * @see bp_xprofile_get_visibility_levels()
    29      * @since 1.6
     29     * @since BuddyPress (1.6)
    3030     */
    3131    var $visibility_levels = array();
  • trunk/bp-xprofile/bp-xprofile-template.php

    r6236 r6259  
    399399 *
    400400 * @package BuddyPress Xprofile
    401  * @since 1.1
     401 * @since BuddyPress (1.1)
    402402 *
    403403 * @uses bp_get_the_profile_field_options()
     
    415415     *
    416416     * @package BuddyPress Xprofile
    417      * @since 1.1
     417     * @since BuddyPress (1.1)
    418418     *
    419419     * @uses BP_XProfile_Field::get_children()
Note: See TracChangeset for help on using the changeset viewer.