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

Timestamp:

09/13/2015 02:02:56 AM (10 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the Core component.

See #6576.

File:

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

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

@@ -1 +1 @@
 <?php
-
 /**
  * BuddyPress URI catcher.
@@ -11 +10 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -31 +30 @@
  *    - $bp->action_variables: array ['group', 5]
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  */
 function bp_core_set_uri_globals() {
@@ -59 +58 @@
      * Filters the BuddyPress global URI path.
      *
-     * @since BuddyPress (1.0.0)
+     * @since 1.0.0
      *
      * @param string $path Path to set.
@@ -340 +339 @@
  * Are root profiles enabled and allowed?
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @return bool True if yes, false if no.
@@ -354 +353 @@
      * Filters whether or not root profiles are enabled and allowed.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param bool $retval Whether or not root profiles are available.
@@ -407 +406 @@
      * Allows plugins to alter where the template files are located.
      *
-     * @since BuddyPress (1.1.0)
+     * @since 1.1.0
      *
      * @param string $template           Located template path.
@@ -423 +422 @@
          * Fires before the loading of a located template file.
          *
-         * @since BuddyPress (1.6.0)
+         * @since 1.6.0
          *
          * @param string $located_template Template found to be loaded.
@@ -432 +431 @@
          * Filters the selected template right before loading.
          *
-         * @since BuddyPress (1.1.0)
+         * @since 1.1.0
          *
          * @param string $located_template Template found to be loaded.
@@ -441 +440 @@
          * Fires after the loading of a located template file.
          *
-         * @since BuddyPress (1.6.0)
+         * @since 1.6.0
          *
          * @param string $located_template Template found that was loaded.
@@ -466 +465 @@
          * Fires if there are no found templates to load and theme compat is needed.
          *
-         * @since BuddyPress (1.7.0)
+         * @since 1.7.0
          */
         do_action( 'bp_setup_theme_compat' );
@@ -481 +480 @@
          * Filters the path to redirect users to if XProfile is not enabled.
          *
-         * @since BuddyPress (1.0.0)
+         * @since 1.0.0
          *
          * @param string $value Path to redirect users to.
@@ -492 +491 @@
  * Catch unauthorized access to certain BuddyPress pages and redirect accordingly.
  *
- * @since BuddyPress (1.5.0)
+ * @since 1.5.0
  */
 function bp_core_catch_no_access() {
@@ -517 +516 @@
  * If authenticated, redirects user back to requested content by default.
  *
- * @since BuddyPress (1.5.0)
+ * @since 1.5.0
  *
  * @param array|string $args {
@@ -550 +549 @@
      * Filters the arguments used for user redirecting when visiting access controlled areas.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param array $r Array of parsed arguments for redirect determination.
@@ -604 +603 @@
  * Hooks into the "bpnoaccess" action defined in bp_core_no_access().
  *
- * @since BuddyPress (1.5.0)
+ * @since 1.5.0
  *
  * @global string $error Error message to pass to wp-login.php.
@@ -614 +613 @@
      * Filters the error message for wp-login.php when needing to log in before accessing.
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param string $value Error message to display.
@@ -635 +634 @@
  * example.com/groups/mygroup/home/.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @see BP_Members_Component::setup_globals() where
@@ -648 +647 @@
      * Filters whether or not to do canonical redirects on BuddyPress URLs.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param bool $value Whether or not to do canonical redirects. Default true.
@@ -697 +696 @@
  * Output rel=canonical header tag for BuddyPress content.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  */
 function bp_rel_canonical() {
@@ -709 +708 @@
  * Get the canonical URL of the current page.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @uses apply_filters() Filter bp_get_canonical_url to modify return value.
@@ -757 +756 @@
              * Filters the logged in register page redirect URL.
              *
-             * @since BuddyPress (1.5.1)
+             * @since 1.5.1
              *
              * @param string $value URL to redirect logged in members to.
@@ -805 +804 @@
      * Filters the canonical url of the current page.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param string $canonical_url Canonical URL of the current page.
@@ -816 +815 @@
  * Return the URL as requested on the current page load by the user agent.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @return string Requested URL string.
@@ -831 +830 @@
      * Filters the URL as requested on the current page load by the user agent.
      *
-     * @since BuddyPress (1.7.0)
+     * @since 1.7.0
      *
      * @param string $value Requested URL string.
@@ -847 +846 @@
  * notice in future versions of BuddyPress.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @uses bp_is_blog_page()
@@ -879 +878 @@
  * (and plugin authors!) should ignore it.
  *
- * @since BuddyPress (1.6.1)
+ * @since 1.6.1
  *
  * @link https://buddypress.trac.wordpress.org/ticket/4329
@@ -898 +897 @@
  * notice in future versions of BuddyPress.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  */
 function _bp_maybe_remove_rel_canonical() {