Changeset 8090

Timestamp:

03/09/2014 02:38:24 PM (10 years ago)

Author:

boonebgorges

Message:

Improve strings used for <title> and header of directory pages

Our legacy method for creating directory titles involved concatenating the
component name into '% Directory', which did not work well in languages where
a term like 'Groups Directory' would be translated into a single word. In
addition, there was inconistency between the <title> element on directory pages
and the header element used in the page body.

This changeset introduces a 'directory_title' parameter to BP_Core_Component,
so that directories can register a fully localizable string as the title/
header for directories.

To avoid filter name conflicts, the filter names associated with the headers
on group and blog directory pages were changed to _directory_header. See r7942,

See #4726, #4630

Fixes #4631

Location:

trunk

Files:

• bp-activity/bp-activity-loader.php (modified) (1 diff)
• bp-activity/bp-activity-screens.php (modified) (1 diff)
• bp-blogs/bp-blogs-screens.php (modified) (1 diff)
• bp-core/bp-core-component.php (modified) (2 diffs)
• bp-core/bp-core-filters.php (modified) (1 diff)
• bp-core/bp-core-template.php (modified) (1 diff)
• bp-groups/bp-groups-loader.php (modified) (1 diff)
• bp-groups/bp-groups-screens.php (modified) (1 diff)
• bp-members/bp-members-loader.php (modified) (1 diff)
• bp-members/bp-members-screens.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress-functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-loader.php

@@ -107 +107 @@
             'root_slug'             => isset( $bp->pages->activity->slug ) ? $bp->pages->activity->slug : BP_ACTIVITY_SLUG,
             'has_directory'         => true,
+            'directory_title'       => _x( 'Sitewide Activity', 'component directory title', 'buddypress' ),
             'notification_callback' => 'bp_activity_format_notifications',
             'search_string'         => __( 'Search Activity...', 'buddypress' ),

trunk/bp-activity/bp-activity-screens.php

@@ -382 +382 @@
         bp_theme_compat_reset_post( array(
             'ID'             => 0,
-            'post_title'     => __( 'Sitewide Activity', 'buddypress' ),
+            'post_title'     => bp_get_directory_title( 'activity' ),
             'post_author'    => 0,
             'post_date'      => 0,

trunk/bp-blogs/bp-blogs-screens.php

@@ -142 +142 @@
     public function directory_dummy_post() {
 
-        $title = apply_filters( 'bp_blogs_directory_title', __( 'Sites', 'buddypress' ) );
+        $title = apply_filters( 'bp_blogs_directory_header', __( 'Sites', 'buddypress' ) );
 
         bp_theme_compat_reset_post( array(

trunk/bp-core/bp-core-component.php

@@ -216 +216 @@
             'root_slug'             => $default_root_slug,
             'has_directory'         => false,
+            'directory_title'       => '',
             'notification_callback' => '',
             'search_string'         => '',
@@ -230 +231 @@
         // Does this component have a top-level directory?
         $this->has_directory         = apply_filters( 'bp_' . $this->id . '_has_directory',         $r['has_directory']         );
+
+        // Does this component have a top-level directory?
+        $this->directory_title       = apply_filters( 'bp_' . $this->id . '_directory_title',       $r['directory_title']         );
 
         // Search string

trunk/bp-core/bp-core-filters.php

@@ -432 +432 @@
     // An index or directory
     } elseif ( bp_is_directory() ) {
-        if ( !bp_current_component() ) {
-            $title = sprintf( __( '%s Directory', 'buddypress' ), bp_get_name_from_root_slug() );
+
+        $current_component = bp_current_component();
+
+        // No current component (when does this happen?)
+        if ( empty( $current_component ) ) {
+            $title = _x( 'Directory', 'component directory title', 'buddypress' );
         } else {
-            $title = sprintf( __( '%s Directory', 'buddypress' ), bp_get_name_from_root_slug() );
+            $title = bp_get_directory_title( $current_component );
         }
 

trunk/bp-core/bp-core-template.php

@@ -82 +82 @@
 
     echo apply_filters( 'bp_get_options_title', esc_attr( $bp->bp_options_title ) );
+}
+
+/**
+ * Get the directory title for a component.
+ *
+ * Used for the <title> element and the page header on the component directory
+ * page.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @return string
+ */
+function bp_get_directory_title( $component = '' ) {
+    $title = '';
+
+    // Use the string provided by the component
+    if ( isset( buddypress()->{$component}->directory_title ) ) {
+        $title = buddypress()->{$component}->directory_title;
+
+    // If none is found, concatenate
+    } else if ( isset( buddypress()->{$component}->name ) ) {
+        $title = sprintf( __( '%s Directory', 'buddypress' ), buddypress()->{$component}->name );
+    }
+
+    return apply_filters( 'bp_get_directory_title', $title, $component );
 }
 

trunk/bp-groups/bp-groups-loader.php

@@ -148 +148 @@
             'root_slug'             => isset( $bp->pages->groups->slug ) ? $bp->pages->groups->slug : BP_GROUPS_SLUG,
             'has_directory'         => true,
+            'directory_title'       => _x( 'Groups', 'component directory title', 'buddypress' ),
             'notification_callback' => 'groups_format_notifications',
             'search_string'         => __( 'Search Groups...', 'buddypress' ),

trunk/bp-groups/bp-groups-screens.php

@@ -1022 +1022 @@
     public function directory_dummy_post() {
 
-        $title = apply_filters( 'bp_groups_directory_title', __( 'Groups', 'buddypress' ) );
+        $title = apply_filters( 'bp_groups_directory_header', bp_get_directory_title( 'groups' ) );
 
         bp_theme_compat_reset_post( array(

trunk/bp-members/bp-members-loader.php

@@ -73 +73 @@
             'root_slug'     => isset( $bp->pages->members->slug ) ? $bp->pages->members->slug : BP_MEMBERS_SLUG,
             'has_directory' => true,
+            'directory_title' => _x( 'Members', 'component directory title', 'buddypress' ),
             'global_tables' => array(
                 'table_name_last_activity' => bp_core_get_table_prefix() . 'bp_activity',

trunk/bp-members/bp-members-screens.php

@@ -364 +364 @@
         bp_theme_compat_reset_post( array(
             'ID'             => 0,
-            'post_title'     => __( 'Members', 'buddypress' ),
+            'post_title'     => bp_get_directory_title( 'members' ),
             'post_author'    => 0,
             'post_date'      => 0,

trunk/bp-templates/bp-legacy/buddypress-functions.php

@@ -112 +112 @@
                 add_action( 'bp_group_header_actions',     'bp_group_new_topic_button',      20 );
                 add_action( 'bp_directory_groups_actions', 'bp_group_join_button' );
-                add_filter( 'bp_groups_directory_title',   'bp_legacy_theme_group_create_button' );
-                add_filter( 'bp_blogs_directory_title',    'bp_legacy_theme_blog_create_button' );
+                add_filter( 'bp_groups_directory_header',  'bp_legacy_theme_group_create_button' );
+                add_filter( 'bp_blogs_directory_header',   'bp_legacy_theme_blog_create_button' );
             }