Skip to:
Content

BuddyPress.org

Changeset 9544


Ignore:
Timestamp:
02/24/2015 03:04:40 AM (7 years ago)
Author:
tw2113
Message:

Adds hook documentation to bp-core-admin-components.php.

See #5940.

File:
1 edited

Legend:

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

    r9517 r9544  
    1515 *
    1616 * @package BuddyPress
    17  * @since BuddyPress (1.6)
     17 * @since BuddyPress (1.6.0)
    1818 * @uses bp_core_admin_component_options()
    1919 */
     
    4545 *
    4646 * @package BuddyPress
    47  * @since BuddyPress (1.6)
     47 * @since BuddyPress (1.6.0)
    4848 * @todo Use settings API
    4949 */
     
    5252    // Declare local variables
    5353    $deactivated_components = array();
     54
     55    /**
     56     * Filters the array of available components.
     57     *
     58     * @since BuddyPress (1.5.0)
     59     *
     60     * @param mixed $value Active components.
     61     */
    5462    $active_components      = apply_filters( 'bp_active_components', bp_get_option( 'bp-active-components' ) );
    5563
     
    228236 * Handle saving the Component settings
    229237 *
    230  * @since BuddyPress (1.6)
     238 * @since BuddyPress (1.6.0)
    231239 * @todo Use settings API when it supports saving network settings
    232240 */
     
    287295 *   ones.
    288296 *
    289  * @since (BuddyPress) 1.7
     297 * @since BuddyPress (1.7.0)
    290298 *
    291299 * @param array This is the array of component settings coming from the POST
     
    332340 * well as to do some processing on settings data submitted from those screens.
    333341 *
    334  * @since (BuddyPress) 1.7
     342 * @since BuddyPress (1.7.0)
    335343 *
    336344 * @param string $type 'all', 'optional', 'retired', 'required'
     
    422430    }
    423431
     432    /**
     433     * Filters the list of component information.
     434     *
     435     * @since BuddyPress (2.0.0)
     436     *
     437     * @param array  $components Array of component information.
     438     * @param string $type       Type of component list requested.
     439     *                           Possible values include 'all', 'optional',
     440     *                           'retired', 'required'.
     441     */
    424442    return apply_filters( 'bp_core_admin_get_components', $components, $type );
    425443}
Note: See TracChangeset for help on using the changeset viewer.