Skip to:
Content

BuddyPress.org

Changeset 9545


Ignore:
Timestamp:
02/24/2015 03:09:27 AM (11 years ago)
Author:
tw2113
Message:

Adds hooks documentation for bp-core-admin-functions.php.

See #5940.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-core/admin/bp-core-admin-functions.php

    r9517 r9545  
    3333 * @global array $_registered_pages
    3434 * @global array $submenu
    35  * @since BuddyPress (1.6)
     35 * @since BuddyPress (1.6.0)
    3636 */
    3737function bp_core_admin_backpat_menu() {
    … …  
    7272 * @global string $plugin_page
    7373 * @global array $submenu
    74  * @since BuddyPress (1.6)
     74 * @since BuddyPress (1.6.0)
    7575 */
    7676function bp_core_modify_admin_menu_highlight() {
    … …  
    9494 *
    9595 * @see bp_core_admin_backpat_menu()
    96  * @since BuddyPress (1.6)
     96 * @since BuddyPress (1.6.0)
    9797 * @todo Add convenience links into the markup once new positions are finalised.
    9898 */
    … …  
    120120 * boxes.
    121121 *
    122  * @since BuddyPress (1.5)
     122 * @since BuddyPress (1.5.0)
    123123 *
    124124 * @uses bp_current_user_can() to check current user permissions before showing the notices
    … …  
    165165 * loaded in time.
    166166 *
    167  * @since BuddyPress (1.5)
     167 * @since BuddyPress (1.5.0)
    168168 *
    169169 * @param string $notice The notice you are adding to the queue.
    … …  
    200200 * @global WPDB $wpdb WordPress DB object
    201201 * @global WP_Rewrite $wp_rewrite
    202  * @since BuddyPress (1.2)
     202 * @since BuddyPress (1.2.0)
    203203 */
    204204function bp_core_activation_notice() {
    … …  
    330330 * Redirect user to BuddyPress's What's New page on activation
    331331 *
    332  * @since BuddyPress (1.7)
     332 * @since BuddyPress (1.7.0)
    333333 *
    334334 * @internal Used internally to redirect BuddyPress to the about page on activation
    … …  
    371371 * Output the tabs in the admin area
    372372 *
    373  * @since BuddyPress (1.5)
     373 * @since BuddyPress (1.5.0)
    374374 * @param string $active_tab Name of the tab that is active. Optional.
    375375 */
    … …  
    378378    $idle_class   = 'nav-tab';
    379379    $active_class = 'nav-tab nav-tab-active';
     380
     381    /**
     382     * Filters the admin tabs to be displayed.
     383     *
     384     * @since BuddyPress (1.9.0)
     385     *
     386     * @param array $value Array of tabs to output to the admin area.
     387     */
    380388    $tabs         = apply_filters( 'bp_core_admin_tabs', bp_core_get_admin_tabs( $active_tab ) );
    381389
    … …  
    388396
    389397    echo $tabs_html;
     398
     399    /**
     400     * Fires after the output of tabs for the admin area.
     401     *
     402     * @since BuddyPress (1.5.0)
     403     */
    390404    do_action( 'bp_admin_tabs' );
    391405}
    … …  
    429443     * Filters the tab data used in our wp-admin screens.
    430444     *
     445     * @since BuddyPress (2.2.0)
     446     *
    431447     * @param array $tabs Tab data.
    432      * @since BuddyPress (2.2.0)
    433448     */
    434449    return apply_filters( 'bp_core_get_admin_tabs', $tabs );
    … …  
    440455 * adds contextual help to BuddyPress admin pages
    441456 *
    442  * @since BuddyPress (1.7)
     457 * @since BuddyPress (1.7.0)
    443458 * @todo Make this part of the BP_Component class and split into each component
    444459 */
    … …  
    530545 * renders contextual help content to contextual help tabs
    531546 *
    532  * @since BuddyPress (1.7)
     547 * @since BuddyPress (1.7.0)
    533548 */
    534549function bp_core_add_contextual_help_content( $tab = '' ) {
    … …  
    569584 * Add a separator to the WordPress admin menus
    570585 *
    571  * @since BuddyPress (1.7)
     586 * @since BuddyPress (1.7.0)
    572587 *
    573588 * @uses bp_current_user_can() To check users capability on root blog
    … …  
    604619 * Tell WordPress we have a custom menu order
    605620 *
    606  * @since BuddyPress (1.7)
     621 * @since BuddyPress (1.7.0)
    607622 *
    608623 * @param bool $menu_order Menu order
    … …  
    623638 * Move our custom separator above our custom post types
    624639 *
    625  * @since BuddyPress (1.7)
     640 * @since BuddyPress (1.7.0)
    626641 *
    627642 * @param array $menu_order Menu Order
    … …  
    642657    $last_sep     = is_network_admin() ? 'separator1' : 'separator2';
    643658
    644     // Filter the custom admin menus
     659    /**
     660     * Filters the custom admin menus.
     661     *
     662     * @since BuddyPress (1.7.0)
     663     *
     664     * @param array $value Empty array.
     665     */
    645666    $custom_menus = (array) apply_filters( 'bp_admin_menu_order', array() );
    646667
    … …  
    688709 * reconciles the two values and returns a single action being performed.
    689710 *
    690  * @since BuddyPress (1.7)
     711 * @since BuddyPress (1.7.0)
    691712 * @return string
    692713 */
Note: See TracChangeset for help on using the changeset viewer.