Ticket #2607: patch-2607-2.patch

bp-themes/bp-default/functions.php

@@ -1 +1 @@
 <?php
-
-/* Stop the theme from killing WordPress if BuddyPress is not enabled. */
+// Stop the theme from killing WordPress if BuddyPress is not enabled.
 if ( !class_exists( 'BP_Core_User' ) )
         return false;
 
-/* Register the widget columns */
+// Register the widget columns
 register_sidebars( 1,
         array(
                 'name' => 'Sidebar',
@@ -15 +14 @@
         )
 );
 
-/* Load the AJAX functions for the theme */
+// Load the AJAX functions for the theme
 require_once( TEMPLATEPATH . '/_inc/ajax.php' );
 
-/* Load the javascript for the theme */
+// Load the javascript for the theme
 wp_enqueue_script( 'dtheme-ajax-js', get_template_directory_uri() . '/_inc/global.js', array( 'jquery' ) );
 
-/* Add the JS needed for blog comment replies */
+// Add words that we need to use in JS to the end of the page so they can be translated and still used.
+$params = array(
+        'my_favs' => __( "My Favorites", "buddypress" ),
+        'accepted' => __( "Accepted", "buddypress" ),
+        'rejected' => __( "Rejected", "buddypress" ),
+        'show_all_comments' => __( "Show all comments for this thread", "buddypress" ),
+        'show_all' => __( "Show all", "buddypress" ),
+        'comments' => __( "comments", "buddypress" ),
+        'close' => __( "Close", "buddypress" ),
+        'mention_explain' => sprintf( __( "%s is a unique identifier for %s that you can type into any message on this site. %s will be sent a notification and a link to your message any time you use it.", "buddypress" ), '@' . bp_get_displayed_user_username(), bp_get_user_firstname( bp_get_displayed_user_fullname() ), bp_get_user_firstname( bp_get_displayed_user_fullname() ) )
+);
+wp_localize_script( 'dtheme-ajax-js', 'BP_DTheme', $params );
+
+/**
+ * Add the JS needed for blog comment replies
+ *
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_add_blog_comments_js() {
         if ( is_singular() ) wp_enqueue_script( 'comment-reply' );
 }
 add_action( 'template_redirect', 'bp_dtheme_add_blog_comments_js' );
 
-/* HTML for outputting blog comments as defined by the WP comment API */
+/**
+ * HTML for outputting blog comments as defined by the WP comment API
+ *
+ * @param mixed $comment Comment record from database
+ * @param array $args Arguments from wp_list_comments() call
+ * @param int $depth Comment nesting level
+ * @see wp_list_comments()
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_blog_comments( $comment, $args, $depth ) {
         $GLOBALS['comment'] = $comment; ?>
 
@@ -68 +94 @@
 <?php
 }
 
-/* Filter the dropdown for selecting the page to show on front to include "Activity Stream" */
+/**
+ * Filter the dropdown for selecting the page to show on front to include "Activity Stream"
+ *
+ * @param string $page_html A list of pages as a dropdown (select list)
+ * @see wp_dropdown_pages()
+ * @return string
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_wp_pages_filter( $page_html ) {
         if ( !bp_is_active( 'activity' ) )
                 return $page_html;
@@ -87 +121 @@
 }
 add_filter( 'wp_dropdown_pages', 'bp_dtheme_wp_pages_filter' );
 
-/* Hijack the saving of page on front setting to save the activity stream setting */
+/**
+ * Hijack the saving of page on front setting to save the activity stream setting
+ *
+ * @param $string $oldvalue Previous value of get_option( 'page_on_front' )
+ * @param $string $oldvalue New value of get_option( 'page_on_front' )
+ * @return string
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_page_on_front_update( $oldvalue, $newvalue ) {
         if ( !is_admin() || !is_super_admin() )
                 return false;
@@ -99 +141 @@
 }
 add_action( 'pre_update_option_page_on_front', 'bp_dtheme_page_on_front_update', 10, 2 );
 
-/* Load the activity stream template if settings allow */
+/**
+ * Load the activity stream template if settings allow
+ *
+ * @param string $template Absolute path to the page template 
+ * @return string
+ * @global WP_Query $wp_query WordPress query object
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_page_on_front_template( $template ) {
         global $wp_query;
 
@@ -110 +160 @@
 }
 add_filter( 'page_template', 'bp_dtheme_page_on_front_template' );
 
-/* Return the ID of a page set as the home page. */
+/**
+ * Return the ID of a page set as the home page.
+ *
+ * @return false|int ID of page set as the home page
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_page_on_front() {
         if ( 'page' != get_option( 'show_on_front' ) )
                 return false;
@@ -118 +174 @@
         return apply_filters( 'bp_dtheme_page_on_front', get_option( 'page_on_front' ) );
 }
 
-/* Force the page ID as a string to stop the get_posts query from kicking up a fuss. */
+/**
+ * Force the page ID as a string to stop the get_posts query from kicking up a fuss.
+ *
+ * @global WP_Query $wp_query WordPress query object
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_fix_get_posts_on_activity_front() {
         global $wp_query;
 
@@ -127 +189 @@
 }
 add_action( 'pre_get_posts', 'bp_dtheme_fix_get_posts_on_activity_front' );
 
-/* WP 3.0 requires there to be a non-null post in the posts array */
+/**
+ * WP 3.0 requires there to be a non-null post in the posts array
+ *
+ * @param array $posts Posts as retrieved by WP_Query
+ * @global WP_Query $wp_query WordPress query object
+ * @return array
+ * @package BuddyPress Theme
+ * @since 1.2.5
+ */
 function bp_dtheme_fix_the_posts_on_activity_front( $posts ) {
         global $wp_query;
 
@@ -139 +209 @@
 }
 add_filter( 'the_posts', 'bp_dtheme_fix_the_posts_on_activity_front' );
 
+/**
+ * Add secondary avatar image to this activity stream's record, if supported
+ *
+ * @param string $action The text of this activity
+ * @param BP_Activity_Activity $activity Activity object
+ * @return string
+ * @package BuddyPress Theme
+ * @since 1.2.6
+ */
 function bp_dtheme_activity_secondary_avatars( $action, $activity ) {
-
         switch ( $activity->component ) {
                 case 'groups' :
                 case 'blogs' :
@@ -158 +236 @@
 }
 add_filter( 'bp_get_activity_action_pre_meta', 'bp_dtheme_activity_secondary_avatars', 10, 2 );
 
-/****
+/**
  * Custom header image support. You can remove this entirely in a child theme by adding this line
  * to your functions.php: define( 'BP_DTHEME_DISABLE_CUSTOM_HEADER', true );
+ *
+ * @package BuddyPress Theme
+ * @since 1.2
  */
 function bp_dtheme_add_custom_header_support() {
-        /* Set the defaults for the custom header image (http://ryan.boren.me/2007/01/07/custom-image-header-api/) */
+        // Set the defaults for the custom header image (http://ryan.boren.me/2007/01/07/custom-image-header-api/)
         define( 'HEADER_TEXTCOLOR', 'FFFFFF' );
         define( 'HEADER_IMAGE', '%s/_inc/images/default_header.jpg' ); // %s is theme dir uri
         define( 'HEADER_IMAGE_WIDTH', 1250 );
@@ -235 +316 @@
 if ( !defined( 'BP_DTHEME_DISABLE_CUSTOM_HEADER' ) )
         add_action( 'init', 'bp_dtheme_add_custom_header_support' );
 
-/* Show a notice when the theme is activated - workaround by Ozh (http://old.nabble.com/Activation-hook-exist-for-themes--td25211004.html) */
+/**
+ * Show a notice when the theme is activated - workaround by Ozh (http://old.nabble.com/Activation-hook-exist-for-themes--td25211004.html)
+ *
+ * @package BuddyPress Theme
+ * @since 1.2
+ */
 function bp_dtheme_show_notice() { ?>
         <div id="message" class="updated fade">
                 <p><?php printf( __( 'Theme activated! This theme contains <a href="%s">custom header image</a> support and <a href="%s">sidebar widgets</a>.', 'buddypress' ), admin_url( 'themes.php?page=custom-header' ), admin_url( 'widgets.php' ) ) ?></p>
@@ -246 +332 @@
 }
 if ( is_admin() && isset($_GET['activated'] ) && $pagenow == "themes.php" )
         add_action( 'admin_notices', 'bp_dtheme_show_notice' );
-
-/* Add words that we need to use in JS to the end of the page so they can be translated and still used. */
-function bp_dtheme_js_terms() { ?>
-<script type="text/javascript">
-        var bp_terms_my_favs = '<?php _e( "My Favorites", "buddypress" ) ?>';
-        var bp_terms_accepted = '<?php _e( "Accepted", "buddypress" ) ?>';
-        var bp_terms_rejected = '<?php _e( "Rejected", "buddypress" ) ?>';
-        var bp_terms_show_all_comments = '<?php _e( "Show all comments for this thread", "buddypress" ) ?>';
-        var bp_terms_show_all = '<?php _e( "Show all", "buddypress" ) ?>';
-        var bp_terms_comments = '<?php _e( "comments", "buddypress" ) ?>';
-        var bp_terms_close = '<?php _e( "Close", "buddypress" ) ?>';
-        var bp_terms_mention_explain = '<?php printf( __( "%s is a unique identifier for %s that you can type into any message on this site. %s will be sent a notification and a link to your message any time you use it.", "buddypress" ), '@' . bp_get_displayed_user_username(), bp_get_user_firstname(bp_get_displayed_user_fullname()), bp_get_user_firstname(bp_get_displayed_user_fullname()) ); ?>';
-        </script>
-<?php
-}
-add_action( 'wp_footer', 'bp_dtheme_js_terms' );
-
 ?>
- No newline at end of file

bp-themes/bp-default/_inc/global.js

@@ -168 +168 @@
 
                                 if ( 'fav' == type ) {
                                         if ( !jq('div.item-list-tabs li#activity-favorites').length )
-                                                jq('div.item-list-tabs ul li#activity-mentions').before( '<li id="activity-favorites"><a href="#">' + bp_terms_my_favs + ' (<span>0</span>)</a></li>');
+                                                jq('div.item-list-tabs ul li#activity-mentions').before( '<li id="activity-favorites"><a href="#">' + BP_DTheme.my_favs + ' (<span>0</span>)</a></li>');
 
                                         target.removeClass('fav');
                                         target.addClass('unfav');
@@ -460 +460 @@
 
         jq('span.highlight span').click( function() {
                 if ( !jq('div.help').length ) {
-                        jq(this).parent().after( '<div id="message" class="info help"><p>' + bp_terms_mention_explain + '</p></div>' );
+                        jq(this).parent().after( '<div id="message" class="info help"><p>' + BP_DTheme.mention_explain + '</p></div>' );
                         jq('div.help').hide().slideDown(200);
                 } else {
                         jq('div.help').hide().remove();
@@ -712 +712 @@
                         } else {
                                 button.fadeOut( 100, function() {
                                         if ( jq(this).hasClass('accept') ) {
-                                                jq(this).html( bp_terms_accepted ).fadeIn(50);
+                                                jq(this).html( BP_DTheme.accepted ).fadeIn(50);
                                                 jq(this).addClass('accepted');
                                         } else {
-                                                jq(this).html( bp_terms_rejected ).fadeIn(50);
+                                                jq(this).html( BP_DTheme.rejected ).fadeIn(50);
                                                 jq(this).addClass('rejected');
                                         }
                                 });
@@ -1205 +1205 @@
                                 jq(this).toggle();
 
                                 if ( !i )
-                                        jq(this).before( '<li class="show-all"><a href="#' + parent_li.attr('id') + '/show-all/" title="' + bp_terms_show_all_comments + '">' + bp_terms_show_all + ' ' + comment_count + ' ' + bp_terms_comments + '</a></li>' );
+                                        jq(this).before( '<li class="show-all"><a href="#' + parent_li.attr('id') + '/show-all/" title="' + BP_DTheme.show_all_comments + '">' + BP_DTheme.show_all + ' ' + comment_count + ' ' + BP_DTheme.comments + '</a></li>' );
                         }
                 });