Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/12/2015 12:49:36 AM (5 years ago)
Author:
tw2113
Message:

First pass at BP-Core docs cleanup.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/admin/bp-core-admin-components.php

    r9819 r10012  
    22
    33/**
    4  * BuddyPress Admin Component Functions
     4 * BuddyPress Admin Component Functions.
    55 *
    66 * @package BuddyPress
     
    236236
    237237/**
    238  * Handle saving the Component settings
     238 * Handle saving the Component settings.
    239239 *
    240240 * @since BuddyPress (1.6.0)
     
    278278
    279279/**
    280  * Calculates the components that should be active after save, based on submitted settings
     280 * Calculates the components that should be active after save, based on submitted settings.
    281281 *
    282282 * The way that active components must be set after saving your settings must
     
    299299 * @since BuddyPress (1.7.0)
    300300 *
    301  * @param array This is the array of component settings coming from the POST
    302  *   global. You should stripslashes_deep() before passing to this function
     301 * @param array $submitted This is the array of component settings coming from the POST
     302 *                         global. You should stripslashes_deep() before passing to this function.
     303 *
    303304 * @return array The calculated list of component settings
    304305 */
     
    337338
    338339/**
    339  * Return a list of component information, optionally filtered by type
     340 * Return a list of component information, optionally filtered by type.
    340341 *
    341342 * We use this information both to build the markup for the admin screens, as
     
    344345 * @since BuddyPress (1.7.0)
    345346 *
    346  * @param string $type 'all', 'optional', 'retired', 'required'
     347 * @param string $type 'all', 'optional', 'retired', 'required'.
     348 *
    347349 * @return array An array of requested component data
    348350 */
Note: See TracChangeset for help on using the changeset viewer.