Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
04/28/2018 01:32:52 AM (8 years ago)
Author:
tw2113
Message:

add/touchup documentation to a lot of Nouveau actions and filters

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-templates/bp-nouveau/includes/members/template-tags.php

    r11985 r12008  
    1919     * Fires at the begining of the templates BP injected content.
    2020     *
    21      * @since 2.3.0 (BuddyPress)
     21     * @since 2.3.0
    2222     */
    2323    do_action( 'bp_before_directory_members_page' );
    … …  
    2626     * Fires before the display of the members.
    2727     *
    28      * @since 1.1.0 (BuddyPress)
     28     * @since 1.1.0
    2929     */
    3030    do_action( 'bp_before_directory_members' );
    … …  
    3333     * Fires before the display of the members content.
    3434     *
    35      * @since 1.1.0 (BuddyPress)
     35     * @since 1.1.0
    3636     */
    3737    do_action( 'bp_before_directory_members_content' );
    … …  
    4040     * Fires before the display of the members list tabs.
    4141     *
    42      * @since 1.8.0 (BuddyPress)
     42     * @since 1.8.0
    4343     */
    4444    do_action( 'bp_before_directory_members_tabs' );
    … …  
    5555     * Fires and displays the members content.
    5656     *
    57      * @since 1.1.0 (BuddyPress)
     57     * @since 1.1.0
    5858     */
    5959    do_action( 'bp_directory_members_content' );
    … …  
    6262     * Fires after the display of the members content.
    6363     *
    64      * @since 1.1.0 (BuddyPress)
     64     * @since 1.1.0
    6565     */
    6666    do_action( 'bp_after_directory_members_content' );
    … …  
    6969     * Fires after the display of the members.
    7070     *
    71      * @since 1.1.0 (BuddyPress)
     71     * @since 1.1.0
    7272     */
    7373    do_action( 'bp_after_directory_members' );
    … …  
    7676     * Fires at the bottom of the members directory template file.
    7777     *
    78      * @since 1.5.0 (BuddyPress)
     78     * @since 1.5.0
    7979     */
    8080    do_action( 'bp_after_directory_members_page' );
    … …  
    150150     * Fires in the member header actions section.
    151151     *
    152      * @since 1.2.6 (BuddyPress)
     152     * @since 1.2.6
    153153     */
    154154    do_action( 'bp_member_header_actions' );
    … …  
    200200     * Fires inside the members action HTML markup to display actions.
    201201     *
    202      * @since 1.1.0 (BuddyPress)
     202     * @since 1.1.0
    203203     */
    204204    do_action( $action );
    … …  
    603603     * Fires before the display of member body content.
    604604     *
    605      * @since 1.2.0 (BuddyPress)
     605     * @since 1.2.0
    606606     */
    607607    do_action( 'bp_before_member_body' );
    … …  
    637637     * Fires after the display of member body content.
    638638     *
    639      * @since 1.2.0 (BuddyPress)
     639     * @since 1.2.0
    640640     */
    641641    do_action( 'bp_after_member_body' );
    … …  
    659659     * Fires before the display of a member's header.
    660660     *
    661      * @since 1.2.0 (BuddyPress)
     661     * @since 1.2.0
    662662     */
    663663    do_action( 'bp_before_member_header' );
    … …  
    669669     * Fires after the display of a member's header.
    670670     *
    671      * @since 1.2.0 (BuddyPress)
     671     * @since 1.2.0
    672672     */
    673673    do_action( 'bp_after_member_header' );
    … …  
    926926    function bp_nouveau_get_wp_profile_field_id() {
    927927        $field = bp_nouveau()->members->wp_profile_current;
     928
     929        /**
     930         * Filters the WP profile field ID used for BuddyPress Nouveau.
     931         *
     932         * @since 3.0.0
     933         *
     934         * @param string $id Field ID.
     935         */
    928936        return apply_filters( 'bp_nouveau_get_wp_profile_field_id', $field->id );
    929937    }
    … …  
    947955    function bp_nouveau_get_wp_profile_field_label() {
    948956        $field = bp_nouveau()->members->wp_profile_current;
     957
     958        /**
     959         * Filters the WP profile field label used for BuddyPress Nouveau.
     960         *
     961         * @since 3.0.0
     962         *
     963         * @param string $label Field label.
     964         */
    949965        return apply_filters( 'bp_nouveau_get_wp_profile_field_label', $field->label );
    950966    }
    … …  
    963979         * Filters a WP profile field value.
    964980         *
    965          * @param string $data The profile field value.
     981         * @since 3.0.0
     982         *
     983         * @param string $data The profile field data value.
    966984         */
    967985        apply_filters( 'bp_nouveau_get_wp_profile_field_data', $data ),
Note: See TracChangeset for help on using the changeset viewer.