Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/23/2016 06:31:58 AM (8 years ago)
Author:
tw2113
Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:
1 edited

Legend:

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

    r10879 r10899  
    219219         * Filter the portion of the URI that is the displayed user's slug.
    220220         *
    221          * eg. example.com/ADMIN (when root profiles is enabled)
     221         * Eg. example.com/ADMIN (when root profiles is enabled)
    222222         *     example.com/members/ADMIN (when root profiles isn't enabled)
    223223         *
     
    554554 *
    555555 * @param string $member_slug The current member slug.
     556 * @return string $member_slug The current member slug.
    556557 */
    557558function bp_core_members_shortlink_redirector( $member_slug ) {
     559
    558560    /**
    559561     * Shortlink slug to redirect to logged-in user.
    560562     *
    561      * x.com/members/me/* will redirect to x.com/members/{LOGGED_IN_USER_SLUG}/*
     563     * The x.com/members/me/* url will redirect to x.com/members/{LOGGED_IN_USER_SLUG}/*
    562564     *
    563565     * @since 2.6.0
    564566     *
    565      * @var string $slug Defaults to 'me'.
     567     * @param string $slug Defaults to 'me'.
    566568     */
    567569    $me_slug = apply_filters( 'bp_core_members_shortlink_slug', 'me' );
     
    636638
    637639    $defaults = array(
    638         'mode'     => 2,                    // 1 = $root, 2 = wp-login.php
    639         'redirect' => $redirect_url,        // the URL you get redirected to when a user successfully logs in
    640         'root'     => bp_get_root_domain(), // the landing page you get redirected to when a user doesn't have access
     640        'mode'     => 2,                    // 1 = $root, 2 = wp-login.php.
     641        'redirect' => $redirect_url,        // the URL you get redirected to when a user successfully logs in.
     642        'root'     => bp_get_root_domain(), // the landing page you get redirected to when a user doesn't have access.
    641643        'message'  => __( 'You must log in to access the page you requested.', 'buddypress' )
    642644    );
     
    655657
    656658    /*
    657      * @ignore Ignore these filters and use 'bp_core_no_access' above
     659     * @ignore Ignore these filters and use 'bp_core_no_access' above.
    658660     */
    659661    $mode     = apply_filters( 'bp_no_access_mode',     $mode,     $root,     $redirect, $message );
     
    665667    switch ( $mode ) {
    666668
    667         // Option to redirect to wp-login.php
     669        // Option to redirect to wp-login.php.
    668670        // Error message is displayed with bp_core_no_access_wp_login_error().
    669671        case 2 :
     
    676678            break;
    677679
    678         // Redirect to root with "redirect_to" parameter
     680        // Redirect to root with "redirect_to" parameter.
    679681        // Error message is displayed with bp_core_add_message().
    680682        case 1 :
     
    940942 *
    941943 * @since 1.6.0
    942  *
    943944 */
    944945function _bp_maybe_remove_redirect_canonical() {
Note: See TracChangeset for help on using the changeset viewer.