Changeset 10899 for trunk/src/bp-core/bp-core-catchuri.php

Timestamp:

06/23/2016 06:31:58 AM (9 years ago)

Author:

tw2113

Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:

• trunk/src/bp-core/bp-core-catchuri.php (modified) (7 diffs)

trunk/src/bp-core/bp-core-catchuri.php

@@ -219 +219 @@
          * Filter the portion of the URI that is the displayed user's slug.
          *
-         * eg. example.com/ADMIN (when root profiles is enabled)
+         * Eg. example.com/ADMIN (when root profiles is enabled)
          *     example.com/members/ADMIN (when root profiles isn't enabled)
          *
@@ -554 +554 @@
  *
  * @param string $member_slug The current member slug.
+ * @return string $member_slug The current member slug.
  */
 function bp_core_members_shortlink_redirector( $member_slug ) {
+
     /**
      * Shortlink slug to redirect to logged-in user.
      *
-     * x.com/members/me/* will redirect to x.com/members/{LOGGED_IN_USER_SLUG}/*
+     * The x.com/members/me/* url will redirect to x.com/members/{LOGGED_IN_USER_SLUG}/*
      *
      * @since 2.6.0
      *
-     * @var string $slug Defaults to 'me'.
+     * @param string $slug Defaults to 'me'.
      */
     $me_slug = apply_filters( 'bp_core_members_shortlink_slug', 'me' );
@@ -636 +638 @@
 
     $defaults = array(
-        'mode'     => 2,                    // 1 = $root, 2 = wp-login.php
-        'redirect' => $redirect_url,        // the URL you get redirected to when a user successfully logs in
-        'root'     => bp_get_root_domain(), // the landing page you get redirected to when a user doesn't have access
+        'mode'     => 2,                    // 1 = $root, 2 = wp-login.php.
+        'redirect' => $redirect_url,        // the URL you get redirected to when a user successfully logs in.
+        'root'     => bp_get_root_domain(), // the landing page you get redirected to when a user doesn't have access.
         'message'  => __( 'You must log in to access the page you requested.', 'buddypress' )
     );
@@ -655 +657 @@
 
     /*
-     * @ignore Ignore these filters and use 'bp_core_no_access' above
+     * @ignore Ignore these filters and use 'bp_core_no_access' above.
      */
     $mode     = apply_filters( 'bp_no_access_mode',     $mode,     $root,     $redirect, $message );
@@ -665 +667 @@
     switch ( $mode ) {
 
-        // Option to redirect to wp-login.php
+        // Option to redirect to wp-login.php.
         // Error message is displayed with bp_core_no_access_wp_login_error().
         case 2 :
@@ -676 +678 @@
             break;
 
-        // Redirect to root with "redirect_to" parameter
+        // Redirect to root with "redirect_to" parameter.
         // Error message is displayed with bp_core_add_message().
         case 1 :
@@ -940 +942 @@
  *
  * @since 1.6.0
- *
  */
 function _bp_maybe_remove_redirect_canonical() {