Ticket #2086: 2086.03.patch

bp-activity/bp-activity-actions.php

@@ -577 +577 @@
 function bp_activity_action_favorites_feed() {
         global $bp, $wp_query;
 
-        if ( !bp_is_user_activity() || !bp_is_current_action( 'favorites' ) || !bp_is_action_variable( 'feed', 0 ) )
+        if ( !bp_is_user_activity() || !bp_is_current_action( bp_get_activity_favorites_slug() ) || !bp_is_action_variable( 'feed', 0 ) )
                 return false;
 
         $wp_query->is_404 = false;

bp-activity/bp-activity-loader.php

@@ -71 +71 @@
          * @global object $bp BuddyPress global settings
          */
         function setup_globals() {
-                global $bp;
+                global $bp, $current_user;
 
                 // Define a slug, if necessary
                 if ( !defined( 'BP_ACTIVITY_SLUG' ) )
                         define( 'BP_ACTIVITY_SLUG', $this->id );
+                
+                $slugs = array(
+                        'root_slug' => array(
+                                'slug'        => isset( $bp->pages->activity->slug ) ? $bp->pages->activity->slug : BP_ACTIVITY_SLUG,
+                                'description' => sprintf( __( 'Used to construct top-level activity URLs, e.g. %1$s/<strong>%2$s</strong>/', 'buddypress' ), bp_get_root_domain(), isset( $bp->pages->activity->slug ) ? $bp->pages->activity->slug : BP_ACTIVITY_SLUG )
+                        ),
+                        'slug'      => array(
+                                'slug'        => BP_ACTIVITY_SLUG,
+                                'description' => sprintf( __( 'Used to construct mid-level URLs, e.g. %1$s<strong>%2$s</strong>/', 'buddypress' ), bp_get_root_domain() . '/members/username/', BP_ACTIVITY_SLUG ) // Activity component loaded too early to use bp_loggedin_user_domain()
+                        ),
+                        'just-me'   => array(
+                                'slug'        => 'just-me',
+                                'description' => sprintf( __( 'Used to construct URL for a user\'s personal activity, e.g. %1$s<strong>%2$s</strong>/', 'buddypress' ), bp_get_root_domain() . '/members/username/' . BP_ACTIVITY_SLUG . '/', 'just-me' )
+                        ),
+                        'favorites'   => array(
+                                'slug'        => 'favorites',
+                                'description' => sprintf( __( 'Used to construct URL for a user\'s favorite activity items, e.g. %1$s<strong>%2$s</strong>/', 'buddypress' ), bp_get_root_domain() . '/members/username/' . BP_ACTIVITY_SLUG . '/', 'favorites' )
+                        ),
+                        'mentions'   => array(
+                                'slug'        => 'mentions',
+                                'description' => sprintf( __( 'Used to construct URL for a user\'s public @-mentions, e.g. %1$s<strong>%2$s</strong>/', 'buddypress' ), bp_get_root_domain() . '/members/username/' . BP_ACTIVITY_SLUG . '/', 'mentions' )
+                        )
+                );
 
                 // Global tables for activity component
                 $global_tables = array(
@@ -87 +110 @@
                 // Note that global_tables is included in this array.
                 $globals = array(
                         'path'                  => BP_PLUGIN_DIR,
-                        'slug'                  => BP_ACTIVITY_SLUG,
-                        'root_slug'             => isset( $bp->pages->activity->slug ) ? $bp->pages->activity->slug : BP_ACTIVITY_SLUG,
+                        'slugs'                 => $slugs,
+                        'slug'                  => $slugs['slug']['slug'],
+                        'root_slug'             => $slugs['root_slug']['slug'],
                         'has_directory'         => true,
                         'search_string'         => __( 'Search Activity...', 'buddypress' ),
                         'global_tables'         => $global_tables,
@@ -118 +142 @@
                         'slug'                => $this->slug,
                         'position'            => 10,
                         'screen_function'     => 'bp_activity_screen_my_activity',
-                        'default_subnav_slug' => 'just-me',
+                        'default_subnav_slug' => $this->slugs['just-me']['slug'],
                         'item_css_id'         => $this->id
                 );
 
@@ -140 +164 @@
                 // Add the subnav items to the activity nav item if we are using a theme that supports this
                 $sub_nav[] = array(
                         'name'            => __( 'Personal', 'buddypress' ),
-                        'slug'            => 'just-me',
+                        'slug'            => $this->slugs['just-me']['slug'],
                         'parent_url'      => $activity_link,
                         'parent_slug'     => $this->slug,
                         'screen_function' => 'bp_activity_screen_my_activity',
@@ -150 +174 @@
                 // @ mentions
                 $sub_nav[] = array(
                         'name'            => __( 'Mentions', 'buddypress' ),
-                        'slug'            => 'mentions',
+                        'slug'            => $this->slugs['mentions']['slug'],
                         'parent_url'      => $activity_link,
                         'parent_slug'     => $this->slug,
                         'screen_function' => 'bp_activity_screen_mentions',
@@ -161 +185 @@
                 // Favorite activity items
                 $sub_nav[] = array(
                         'name'            => __( 'Favorites', 'buddypress' ),
-                        'slug'            => 'favorites',
+                        'slug'            => $this->slugs['favorites']['slug'],
                         'parent_url'      => $activity_link,
                         'parent_slug'     => $this->slug,
                         'screen_function' => 'bp_activity_screen_favorites',
@@ -245 +269 @@
                                 'parent' => 'my-account-' . $this->id,
                                 'id'     => 'my-account-' . $this->id . '-mentions',
                                 'title'  => $title,
-                                'href'   => trailingslashit( $activity_link . 'mentions' )
+                                'href'   => trailingslashit( $activity_link . bp_get_activity_mentions_slug() )
                         );
 
                         // Personal
@@ -261 +285 @@
                                 'parent' => 'my-account-' . $this->id,
                                 'id'     => 'my-account-' . $this->id . '-favorites',
                                 'title'  => __( 'Favorites', 'buddypress' ),
-                                'href'   => trailingslashit( $activity_link . 'favorites' )
+                                'href'   => trailingslashit( $activity_link . bp_get_activity_favorites_slug() )
                         );
 
                         // Friends?

bp-activity/bp-activity-template.php

@@ -25 +25 @@
          *
          * @since 1.5.0
          *
-         * @global object $bp BuddyPress global settings
          * @uses apply_filters() To call the 'bp_get_activity_slug' hook
          */
         function bp_get_activity_slug() {
-                global $bp;
-                return apply_filters( 'bp_get_activity_slug', $bp->activity->slug );
+                return apply_filters( 'bp_get_activity_slug', bp_get_slug( 'activity', 'slug' ) );
         }
 
 /**
@@ -48 +46 @@
          *
          * @since 1.5.0
          *
-         * @global object $bp BuddyPress global settings
          * @uses apply_filters() To call the 'bp_get_activity_root_slug' hook
          */
         function bp_get_activity_root_slug() {
-                global $bp;
-                return apply_filters( 'bp_get_activity_root_slug', $bp->activity->root_slug );
+                return apply_filters( 'bp_get_activity_root_slug', bp_get_slug( 'activity', 'root_slug' ) );
+        }
+
+/**
+ * Output the activity component 'just-me' slug
+ *
+ * @since 1.6
+ *
+ * @uses bp_get_activity_justme_slug()
+ */
+function bp_activity_justme_slug() {
+        echo bp_get_activity_justme_slug();
+}
+        /**
+         * Return the activity component 'just-me' slug
+         *
+         * @since 1.6
+         *
+         * @uses apply_filters() To call the 'bp_get_activity_justme_slug' hook
+         */
+        function bp_get_activity_justme_slug() {
+                return apply_filters( 'bp_get_activity_justme_slug', bp_get_slug( 'activity', 'just-me' ) );
+        }
+
+/**
+ * Output the activity component 'favorites' slug
+ *
+ * @since 1.6
+ *
+ * @uses bp_get_activity_favorites_slug()
+ */
+function bp_activity_favorites_slug() {
+        echo bp_get_activity_favorites_slug();
+}
+        /**
+         * Return the activity component 'favorites' slug
+         *
+         * @since 1.6
+         *
+         * @uses apply_filters() To call the 'bp_get_activity_favorites_slug' hook
+         */
+        function bp_get_activity_favorites_slug() {
+                return apply_filters( 'bp_get_activity_favorites_slug', bp_get_slug( 'activity', 'favorites' ) );
+        }
+
+/**
+ * Output the activity component 'mentions' slug
+ *
+ * @since 1.6
+ *
+ * @uses bp_get_activity_mentions_slug()
+ */
+function bp_activity_mentions_slug() {
+        echo bp_get_activity_mentions_slug();
+}
+        /**
+         * Return the activity component 'mentions' slug
+         *
+         * @since 1.6
+         *
+         * @uses apply_filters() To call the 'bp_get_activity_mentions_slug' hook
+         */
+        function bp_get_activity_mentions_slug() {
+                return apply_filters( 'bp_get_activity_mentions_slug', bp_get_slug( 'activity', 'mentions' ) );
         }
 
 /**
@@ -279 +338 @@
         // The default scope should recognize custom slugs
         if ( array_key_exists( $bp->current_action, (array)$bp->loaded_components ) ) {
                 $scope = $bp->loaded_components[$bp->current_action];
-        }
-        else
+        } else if ( $slug_index = array_search( bp_current_action(), $bp->activity->slugs ) ) {
+                $scope = $slug_index;
+        } else {
                 $scope = bp_current_action();
+        }
 
         // Support for permalinks on single item pages: /groups/my-group/activity/124/
         if ( bp_is_current_action( bp_get_activity_slug() ) )
@@ -2486 +2547 @@
         function bp_get_member_activity_feed_link() {
                 global $bp;
 
-                if ( bp_is_profile_component() || bp_is_current_action( 'just-me' ) )
+                if ( bp_is_profile_component() || bp_is_current_action( bp_get_activity_justme_slug() ) )
                         $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/feed/';
                 elseif ( bp_is_active( 'friends' ) && bp_is_current_action( bp_get_friends_slug() ) )
                         $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_friends_slug() . '/feed/';
-                elseif ( bp_is_active( 'groups'  ) && bp_is_current_action( bp_get_groups_slug()  ) )
+                elseif ( bp_is_active( 'groups' ) && bp_is_current_action( bp_get_groups_slug()  ) )
                         $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_groups_slug() . '/feed/';
-                elseif ( 'favorites' == $bp->current_action )
-                        $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/favorites/feed/';
-                elseif ( 'mentions' == $bp->current_action )
-                        $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/mentions/feed/';
+                elseif ( bp_is_current_action( bp_get_activity_favorites_slug() ) )
+                        $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_activity_favorites_slug() . '/feed/';
+                elseif ( bp_is_current_action( bp_get_activity_mentions_slug() ) )
+                        $link = bp_displayed_user_domain() . bp_get_activity_slug() . bp_get_activity_mentions_slug() . '/feed/';
                 else
                         $link = '';
 

bp-core/bp-core-component.php

@@ -28 +28 @@
          * @var Unique ID (normally for custom post type)
          */
         var $id;
+        
+        /**
+         * @var array Slugs for this component (used to construct permalinks)
+         */
+        var $slugs;
 
         /**
          * @var string Unique slug (used in query string and permalinks)
@@ -106 +111 @@
                 /** Slugs *************************************************************/
 
                 $defaults = array(
+                        'slugs'                 => array(),
                         'slug'                  => $this->id,
                         'root_slug'             => '',
                         'has_directory'         => false,
@@ -115 +121 @@
                 );
                 $r = wp_parse_args( $args, $defaults );
 
+                // Component slugs
+                $this->slugs         = apply_filters( 'bp_' . $this->id . '_slugs',         bp_parse_component_slugs( $this->id, $r['slugs'] ) );
+
                 // Slug used for permalink URI chunk after root
                 $this->slug          = apply_filters( 'bp_' . $this->id . '_slug',          $r['slug']          );
 

bp-core/bp-core-functions.php

@@ -1116 +1116 @@
                 // BuddyPress core settings
                 'bp-deactivated-components'       => serialize( array( ) ),
                 'bp-blogs-first-install'          => '0',
-                'bp-disable-blogforum-comments'  => '0',
+                'bp-disable-blogforum-comments'   => '0',
                 'bp-xprofile-base-group-name'     => 'Base',
                 'bp-xprofile-fullname-field-name' => 'Name',
                 'bp-disable-profile-sync'         => '0',
@@ -1584 +1584 @@
 }
 
 /**
+ * Fetch a slug from the $bp global
+ *
+ * @since 1.6
+ * @global obj $bp
+ *
+ * @param str $component_id The id of the component that the slug belongs to
+ * @param str $slug_name The name of the slug you're fetching
+ * @param str $return 'slugonly' to get the slug only, 'array' to get the slug + description array
+ */
+function bp_get_slug( $component_id = '', $slug_name = '', $return = 'slugonly' ) {
+        global $bp;
+        
+        $slug = '';
+        
+        if ( $component_id && $slug_name ) {
+                if ( isset( $bp->{$component_id}->slugs[$slug_name] ) ) {
+                        $slug = 'slugonly' == $return ? $bp->{$component_id}->slugs[$slug_name]['slug'] : $bp->{$component_id}->slugs[$slug_name];
+                }
+        }
+        
+        return apply_filters( 'bp_get_slug', $slug, $component_id, $slug_name );
+}
+
+/**
+ * Parse a component's default slugs with the custom slugs saved to the database by the user
+ *
+ * Custom components should pass their slugs through this function in their setup_globals() method
+ * so that they can be customized by site admins.
+ *
+ * @since 1.6
+ * @global obj $bp
+ *
+ * @param str $component_id The id of the component the slugs belong to
+ * @param array $slugs The default slugs passed along from the component loader
+ */
+function bp_parse_component_slugs( $component_id = '', $slugs = array() ) {
+        global $bp;
+        
+        $parsed_slugs = array();
+        $saved_slugs  = (array)bp_get_option( 'bp-slugs' );
+        
+        // Get a full list of slug names, in case there is a mismatch
+        if ( !empty( $saved_slugs[$component_id] ) ) {
+                $slug_indexes = array_unique( array_merge( array_keys( $saved_slugs[$component_id] ), array_keys( $slugs ) ) );
+        } else {
+                $slug_indexes = array_unique( array_keys( $slugs ) );
+        }
+        
+        foreach( $slug_indexes as $slug_index ) {
+                $saved_data   = isset( $saved_slugs[$component_id][$slug_index] ) ? $saved_slugs[$component_id][$slug_index] : array();
+                $default_data = isset( $slugs[$slug_index] ) ? $slugs[$slug_index] : array();
+                $parsed_slugs[$slug_index] = wp_parse_args( (array)$saved_data, (array)$default_data );
+        }       
+        
+        return apply_filters( 'bp_parse_component_slugs', $parsed_slugs, $component_id, $slugs );
+}
+
+/**
  * Trigger a 404
  *
  * @global object $bp Global BuddyPress settings object