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

Timestamp:

03/31/2015 04:19:19 AM (12 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-filters.php and bp-core-catchuri.php, fixes version number.

See #5940.

File:

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

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

@@ -56 +56 @@
                 $path = esc_url( $_SERVER['REQUEST_URI'] );
 
-        // Filter the path
+        /**
+         * Filters the BuddyPress global URI path.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $path Path to set.
+         */
         $path = apply_filters( 'bp_uri', $path );
 
@@ -328 +334 @@
                 $retval = true;
 
+        /**
+         * Filters whether or not root profiles are enabled and allowed.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param bool $retval Whether or not root profiles are available.
+         */
         return apply_filters( 'bp_core_enable_root_profiles', $retval );
 }
@@ -371 +384 @@
         }
 
-        // Filter the template locations so that plugins can alter where they are located
+        /**
+         * Filters the template locations.
+         *
+         * Allows plugins to alter where the template files are located.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param string $template           Located template path.
+         * @param array  $filtered_templates Array of templates to attempt to load.
+         */
         $located_template = apply_filters( 'bp_located_template', $template, $filtered_templates );
         if ( !empty( $located_template ) ) {
@@ -380 +402 @@
                 $wp_query->is_404      = false;
 
+                /**
+                 * Fires before the loading of a located template file.
+                 *
+                 * @since BuddyPress (1.6.0)
+                 *
+                 * @param string $located_template Template found to be loaded.
+                 */
                 do_action( 'bp_core_pre_load_template', $located_template );
 
+                /**
+                 * Filters the selected template right before loading.
+                 *
+                 * @since BuddyPress (1.1.0)
+                 *
+                 * @param string $located_template Template found to be loaded.
+                 */
                 load_template( apply_filters( 'bp_load_template', $located_template ) );
 
+                /**
+                 * Fires after the loading of a located template file.
+                 *
+                 * @since BuddyPress (1.6.0)
+                 *
+                 * @param string $located_template Template found that was loaded.
+                 */
                 do_action( 'bp_core_post_load_template', $located_template );
 
@@ -402 +445 @@
                 }
 
+                /**
+                 * Fires if there are no found templates to load and theme compat is needed.
+                 *
+                 * @since BuddyPress (1.7.0)
+                 */
                 do_action( 'bp_setup_theme_compat' );
         }
@@ -411 +459 @@
 function bp_core_catch_profile_uri() {
         if ( !bp_is_active( 'xprofile' ) ) {
+
+                /**
+                 * Filters the path to redirect users to if XProfile is not enabled.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param string $value Path to redirect users to.
+                 */
                 bp_core_load_template( apply_filters( 'bp_core_template_display_profile', 'members/single/home' ) );
         }
@@ -473 +529 @@
 
         $r = wp_parse_args( $args, $defaults );
+
+        /**
+         * Filters the arguments used for user redirecting when visiting access controlled areas.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $r Array of parsed arguments for redirect determination.
+         */
         $r = apply_filters( 'bp_core_no_access', $r );
         extract( $r, EXTR_SKIP );
@@ -529 +593 @@
         global $error;
 
+        /**
+         * Filters the error message for wp-login.php when needing to log in before accessing.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string $value Error message to display.
+         * @param string $value URL to redirect user to after successful login.
+         */
         $error = apply_filters( 'bp_wp_login_error', __( 'You must log in to access the page you requested.', 'buddypress' ), $_REQUEST['redirect_to'] );
 
@@ -555 +627 @@
 function bp_redirect_canonical() {
 
+        /**
+         * Filters whether or not to do canonical redirects on BuddyPress URLs.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param bool $value Whether or not to do canonical redirects. Default true.
+         */
         if ( !bp_is_blog_page() && apply_filters( 'bp_do_redirect_canonical', true ) ) {
                 // If this is a POST request, don't do a canonical redirect.
@@ -655 +734 @@
                 // the members directory to avoid redirect loops
                 } elseif ( bp_is_register_page() && 'register' == $front_page_component && is_user_logged_in() ) {
+
+                        /**
+                         * Filters the logged in register page redirect URL.
+                         *
+                         * @since BuddyPress (1.5.1)
+                         *
+                         * @param string $value URL to redirect logged in members to.
+                         */
                         $bp->canonical_stack['canonical_url'] = apply_filters( 'bp_loggedin_register_page_redirect_to', bp_get_members_directory_permalink() );
                 }
@@ -696 +783 @@
         }
 
+        /**
+         * Filters the canonical url of the current page.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param string $canonical_url Canonical URL of the current page.
+         * @param array  $args          Array of arguments to help determine canonical URL.
+         */
         return apply_filters( 'bp_get_canonical_url', $canonical_url, $args );
 }
@@ -714 +809 @@
         }
 
+        /**
+         * Filters the URL as requested on the current page load by the user agent.
+         *
+         * @since BuddyPress (1.7.0)
+         *
+         * @param string $value Requested URL string.
+         */
         return apply_filters( 'bp_get_requested_url', $bp->canonical_stack['requested_url'] );
 }