Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
11/11/2013 02:24:01 AM (10 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-groups component. See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-groups/bp-groups-activity.php

    r7077 r7561  
    1414if ( !defined( 'ABSPATH' ) ) exit;
    1515
     16/**
     17 * Register activity actions for the Groups component.
     18 */
    1619function groups_register_activity_actions() {
    1720    global $bp;
     
    3639add_action( 'bp_register_activity_actions', 'groups_register_activity_actions' );
    3740
     41/**
     42 * Record an activity item related to the Groups component.
     43 *
     44 * A wrapper for {@link bp_activity_add()} that provides some Groups-specific
     45 * defaults.
     46 *
     47 * @see bp_activity_add() for more detailed description of parameters and
     48 *      return values.
     49 *
     50 * @param array $args {
     51 *     An array of arguments for the new activity item. Accepts all parameters
     52 *     of {@link bp_activity_add()}. However, this wrapper provides some
     53 *     additional defaults, as described below:
     54 *     @type string $component Default: the id of your Groups component
     55 *           (usually 'groups').
     56 *     @type bool $hide_sitewide Default: True if the current group is not
     57 *           public, otherwise false.
     58 * }
     59 * @return bool See {@link bp_activity_add()}.
     60 */
    3861function groups_record_activity( $args = '' ) {
    3962    global $bp;
     
    7699}
    77100
     101/**
     102 * Update the last_activity meta value for a given group.
     103 *
     104 * @param int $group_id Optional. The ID of the group whose last_activity is
     105 *        being updated. Default: the current group's ID.
     106 */
    78107function groups_update_last_activity( $group_id = 0 ) {
    79108    global $bp;
Note: See TracChangeset for help on using the changeset viewer.