Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
12/06/2014 09:19:03 PM (11 years ago)
Author:
tw2113
Message:

Add hook documentation for the Settings component.

Fixes #5947

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-settings/bp-settings-screens.php

    r7228 r9215  
    1414 * Show the general settings template
    1515 *
    16  * @since BuddyPress (1.5)
     16 * @since BuddyPress (1.5.0)
    1717 */
    1818function bp_settings_screen_general() {
    … …  
    2323    }
    2424
     25    /**
     26     * Filters the template file path to use for the general settings screen.
     27     *
     28     * @since BuddyPress (1.6.0)
     29     *
     30     * @param string $value Directory path to look in for the template file.
     31     */
    2532    bp_core_load_template( apply_filters( 'bp_settings_screen_general_settings', 'members/single/settings/general' ) );
    2633}
    … …  
    2936 * Show the notifications settings template
    3037 *
    31  * @since BuddyPress (1.5)
     38 * @since BuddyPress (1.5.0)
    3239 */
    3340function bp_settings_screen_notification() {
    … …  
    3845    }
    3946
     47    /**
     48     * Filters the template file path to use for the notification settings screen.
     49     *
     50     * @since BuddyPress (1.6.0)
     51     *
     52     * @param string $value Directory path to look in for the template file.
     53     */
    4054    bp_core_load_template( apply_filters( 'bp_settings_screen_notification_settings', 'members/single/settings/notifications' ) );
    4155}
    … …  
    4458 * Show the delete-account settings template
    4559 *
    46  * @since BuddyPress (1.5)
     60 * @since BuddyPress (1.5.0)
    4761 */
    4862function bp_settings_screen_delete_account() {
    … …  
    5367    }
    5468
    55     // Load the template
     69    /**
     70     * Filters the template file path to use for the delete-account settings screen.
     71     *
     72     * @since BuddyPress (1.6.0)
     73     *
     74     * @param string $value Directory path to look in for the template file.
     75     */
    5676    bp_core_load_template( apply_filters( 'bp_settings_screen_delete_account', 'members/single/settings/delete-account' ) );
    5777}
    … …  
    6080 * Show the capabilities settings template
    6181 *
    62  * @since BuddyPress (1.6)
     82 * @since BuddyPress (1.6.0)
    6383 */
    6484function bp_settings_screen_capabilities() {
    … …  
    6989    }
    7090
    71     // Load the template
     91    /**
     92     * Filters the template file path to use for the capabilities settings screen.
     93     *
     94     * @since BuddyPress (1.6.0)
     95     *
     96     * @param string $value Directory path to look in for the template file.
     97     */
    7298    bp_core_load_template( apply_filters( 'bp_settings_screen_capabilities', 'members/single/settings/capabilities' ) );
    7399}
Note: See TracChangeset for help on using the changeset viewer.