Ticket #6570: 6570.first-step.patch

src/bp-core/bp-core-actions.php

@@ -98 +98 @@
  * Add the BuddyPress functions file.
  */
 add_action( 'bp_after_setup_theme', 'bp_load_theme_functions', 1 );
+add_action( 'bp_after_setup_theme', 'bp_set_theme_support'   , 2 );
 
 // Load the admin
 if ( is_admin() ) {

src/bp-core/bp-core-cssjs.php

@@ -337 +337 @@
                 'bp-jquery-scroll-to'
         ) );
 }
+
+/**
+ * Add inline css to display the component's single item cover image
+ *
+ * @since BuddyPress (2.4.0)
+ */
+function bp_add_cover_image_inline_css() {
+        // Find the component of the current item
+        if ( bp_is_user() ) {
+                $cover_component = 'members';
+        } elseif ( bp_is_group() ) {
+                $cover_component = 'groups';
+        } else {
+                $cover_component = apply_filters( 'bp_add_cover_image_inline_css_component', '' );
+        }
+
+        // Bail if no component were found.
+        if ( empty( $cover_component ) ) {
+                return;
+        }
+
+        // Check for theme support
+        if ( current_theme_supports( 'buddypress-cover-images', $cover_component ) ) {
+                // WordPress does not allow to directly get the sub feature if not a built-in one.
+                $theme_support = get_theme_support( 'buddypress-cover-images' );
+                $feature = reset( $theme_support );
+
+                // Try to call the callback
+                if ( isset( $feature[ $cover_component ]['callback'] ) && is_callable( $feature[ $cover_component ]['callback'] ) ) {
+                        /**
+                         * Send the component's feature parameters to the callback to get an array informing about
+                         * the handle to attach the inline css to and the inline css to add
+                         *
+                         * $css_data = array( 'handle' => 'handle_name', 'inline_css' => 'css rules to add' );
+                         */
+                        $css_data = call_user_func_array( $feature[ $cover_component ]['callback'], array( $feature[ $cover_component ] ) );
+
+                        // Finally add the inline css to the handle
+                        if ( isset( $css_data['handle'] ) && isset( $css_data['inline_css'] ) ) {
+                                wp_add_inline_style( $css_data['handle'], $css_data['inline_css'] );
+                        }
+                }
+        }
+}
+add_action( 'bp_enqueue_scripts', 'bp_add_cover_image_inline_css', 11 );

src/bp-core/bp-core-filters.php

@@ -1078 +1078 @@
         return $load_mentions;
 }
 add_filter( 'bp_activity_maybe_load_mentions_scripts', 'bp_maybe_load_mentions_scripts_for_blog_content', 10, 2 );
+
+/**
+ * By default current_theme_supports() is returning true so if the feature is not active for a component,
+ * We need to override this default value. For instance:
+ * by using current_theme_supports( 'buddypress-cover-images', 'groups' ) you are able to know if the theme supports
+ * cover images for Groups single items.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @param  bool   $retval  Whether the current theme supports the given feature for the component. Default true.
+ * @param  array  $args    Array of arguments for the feature.
+ * @param  array  $feature The feature parameters.
+ * @return bool   True if the theme supports the feature for the given component, false otherwise
+ */
+function bp_current_theme_supports_feature( $retval, $args, $feature ) {
+        $bp_feature = reset( $feature );
+        $component  = reset( $args );
+
+        // We're using this to inform if BuddyPress is ready to support the feature
+        // so we need to return the value of it (should always be false, meaning it's active)
+        if ( 'inactive' === $component && isset( $bp_feature[ $component ] ) ) {
+                return (bool) $bp_feature[ $component ];
+        }
+
+        return isset( $bp_feature[ $component ] );
+}
+add_filter( 'current_theme_supports-buddypress-cover-images', 'bp_current_theme_supports_feature', 10, 3 );

src/bp-core/bp-core-template-loader.php

@@ -542 +542 @@
 }
 
 /**
+ * Checks if the current theme supports some BuddyPress features
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @global string $_wp_theme_features
+ */
+function bp_set_theme_support() {
+        global $_wp_theme_features;
+
+        /* Loop threw all features to find buddypress ones */
+        foreach ( $_wp_theme_features as $key_feature => $data_feature ) {
+                // Init params
+                $params = array();
+
+                if ( 0 !== strpos( $key_feature, 'buddypress' ) ) {
+                        continue;
+                }
+
+                if ( is_array( $data_feature ) ) {
+                        $theme_params = reset( $data_feature );
+                } else {
+                        $theme_params = $params;
+                }
+
+                switch ( $key_feature ) {
+                        case 'buddypress-cover-images' :
+                                $supported_components = apply_filters( 'bp_cover_images_supported_single_items', array( 'members', 'groups' ) );
+                                $theme_support        = array_diff( $supported_components, array_keys( $theme_params ) );
+
+                                /**
+                                 * The theme can use params for any single items or choose to use different params for each single item.
+                                 *
+                                 * In this second case if one of the BuddyPress supported single items is not available in the theme
+                                 * supported single items, then the cover image feature is not set for the corresponding item.
+                                 */
+                                if ( ! empty( $theme_support ) && count( $theme_support ) !== count( $supported_components ) ) {
+                                        $supported_components = array_diff( $supported_components, $theme_support );
+                                }
+
+                                foreach ( $supported_components as $component ) {
+                                        // If avatar uploads are disabled for the component, do not allow cover images uploads.
+                                        if ( ! bp_is_active( $component ) ) {
+                                                continue;
+                                        }
+
+                                        if ( ! isset( $theme_params[ $component ] ) ) {
+                                                $params_component = $theme_params;
+                                        } else {
+                                                $params_component = $theme_params[ $component ];
+                                        }
+
+                                        $params[ $component ] = bp_parse_args( $params_component, array(
+                                                'width'                => 0,
+                                                'height'               => 0,
+                                                'default_cover'        => '',
+                                                'callback'             => 'bp_legacy_theme_cover_image',
+
+                                        /**
+                                         * This is a dynamic filter to override the single item cover image
+                                         * parameters.
+                                         * For the groups component, you can for instance use this filter:
+                                         * 'bp_before_set_theme_support_groups_cover_images_parse_args'
+                                         * @see bp_parse_args()
+                                         *
+                                         * @since BuddyPress (2.4.0)
+                                         *
+                                         * @param array $params a list of parameters for single item.
+                                         */
+                                        ), 'set_theme_support_' . $component . '_cover_images' );
+                                }
+                                break;
+
+                        default:
+                                /**
+                                 * Plugins can add specific BuddyPress features relative to the theme and use
+                                 * this filter to build their params.
+                                 *
+                                 * @since BuddyPress (2.4.0)
+                                 *
+                                 * @param array  $theme_params a list of parameters for the feature.
+                                 * @param string $key_feature  the unique identifier for the feature.
+                                 */
+                                $params = apply_filters( 'bp_set_theme_support_custom_params', $theme_params, $key_feature );
+                                break;
+                }
+
+                /**
+                 * By default current_theme_supports() is returning true so if BuddyPress is not activated,
+                 * using current_theme_supports( 'buddypress-cover-images', 'inactive' ) will return true.
+                 * If BuddyPress is activated it will return false, meaning the functions are available to
+                 * handle the cover images for single items.
+                 */
+                $_wp_theme_features[ $key_feature ] = array( array_merge( $params, array( 'inactive' => false ) ) );
+        }
+}
+
+/**
  * Get the templates to use as the endpoint for BuddyPress template parts.
  *
  * @since BuddyPress (1.7.0)

src/bp-core/bp-core-theme-compatibility.php

@@ -83 +83 @@
                 // Setup methods
                 $this->setup_globals();
                 $this->setup_actions();
+                $this->setup_supports();
         }
 
         /**
@@ -106 +107 @@
         protected function setup_actions() {}
 
         /**
+         * Set up theme supports for your template package.
+         *
+         * Meant to be overridden in your class. See
+         * {@link BP_Legacy::setup_supports()} for an example.
+         *
+         * @since BuddyPress (2.4.0)
+         */
+        protected function setup_supports() {}
+
+        /**
          * Set a theme's property.
          *
          * @since BuddyPress (1.7.0)

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

@@ -597 +597 @@
 
                 return $templates;
         }
+
+        /**
+         * Setup the theme hooks
+         *
+         * @since BuddyPress (2.4.0)
+         * @access protected
+         *
+         * @global integer $content_width
+         */
+        protected function setup_supports() {
+                global $content_width;
+
+                // The user has already set the cover images feature directly inside his theme's functions
+                if ( current_theme_supports( 'buddypress-cover-images' ) ) {
+                        return;
+                }
+
+                // Let's check if it's a "twenty" or a "twenty" child
+                $current_theme = wp_get_theme();
+                $theme_handle  = $current_theme->get_stylesheet();
+                $author        = $current_theme->get( 'Author' );
+                $parent        = $current_theme->parent();
+
+                if ( $parent ) {
+                        $author       = $parent->get( 'Author' );
+                        $theme_handle = $parent->get_stylesheet();
+                }
+
+                // It's not a "twenty" do not include default support
+                if ( 'the WordPress team' !== $author ) {
+                        return;
+                }
+
+                /**
+                 * Since Companion stylesheets, the $content_width is smaller
+                 * than the item-header width, so we need to manually set the
+                 * cover image width for the concerned themes.
+                 *
+                 * array( stylesheet => cover image width )
+                 */
+                $supported_companion_stylesheet = array(
+                        'twentyfifteen'  => 830,
+                        'twentyfourteen' => 955,
+                        'twentythirteen' => 890,
+                );
+
+                // Default values
+                $cover_width     = (int) $content_width;
+                $bp_theme_handle = 'bp-legacy-css';
+
+                // Specific to themes having companion stylesheets
+                if ( isset( $supported_companion_stylesheet[ $theme_handle ] ) ) {
+                        $cover_width     = $supported_companion_stylesheet[ $theme_handle ];
+                        $bp_theme_handle = 'bp-' . $theme_handle;
+                }
+
+                if ( is_rtl() ) {
+                        $bp_theme_handle .= '-rtl';
+                }
+
+                // Avatar constants are not yet defined
+                $top_offset    = 150;
+                $avatar_height = apply_filters( 'bp_core_avatar_full_height', $top_offset );
+
+                if ( $avatar_height > $top_offset ) {
+                        $top_offset = $avatar_height;
+                }
+
+                // Add the support to the current theme
+                add_theme_support( 'buddypress-cover-images', array(
+                        'width'        => $cover_width,
+                        'height'       => $top_offset + round( $avatar_height / 2 ),
+                        'theme_handle' => $bp_theme_handle,
+                ) );
+        }
 }
 new BP_Legacy();
 endif;
@@ -1758 +1833 @@
         echo '-1';
         die();
 }
+
+/**
+ * BP Legacy's callback for the cover image feature
+ *
+ * @since  BuddyPress (2.4.0)
+ *
+ * @param  array  $params the current component's feature parameters
+ * @return array          an array to inform about the css handle to attach the css rules to
+ */
+function bp_legacy_theme_cover_image( $params = array() ) {
+        if ( empty( $params ) ) {
+                return;
+        }
+
+        /**
+         * @todo create the attachment functions to manage cover
+         * uploads.
+         *
+         * For now we can test with these covers
+         */
+        $testing_covers = array(
+                /* twentytwelve */
+                'bp-legacy-css'     => 'https://cldup.com/BB4ZtZz-G8.jpg',
+                'bp-twentythirteen' => 'https://cldup.com/THkaA2U3-u.jpg',
+                'bp-twentyfourteen' => 'https://cldup.com/aL6CbN-hua.jpg',
+                'bp-twentyfifteen'  => 'https://cldup.com/DB-6lSS9Or.jpg',
+        );
+
+        $cover = $testing_covers[ $params['theme_handle'] ];
+
+        if ( ! $cover && ! empty( $params['default_cover'] ) ) {
+                $cover = esc_url( $params['default_cover'] );
+        }
+
+        // Bail if the single item has no cover images
+        if ( ! $cover || empty( $params['theme_handle'] ) ) {
+                return;
+        }
+
+        // feature's height - padding - 1/2 avatar height
+        $top_offset = $params['height'] - 5 - round( (int) bp_core_avatar_full_height() / 2 );
+
+        /**
+         * @todo  css media queries + groups single item rules
+         */
+        return array( 'handle' => $params['theme_handle'], 'inline_css' => '
+                /* Cover image */
+                .bp-user #buddypress #item-header,
+                body:not(.sidebar) #buddypress #item-header {
+                        background: #FFF url(' . $cover . ') no-repeat center top;
+                        padding:5px;
+                }
+
+                #buddypress #item-header #item-header-avatar,
+                #buddypress #item-header #item-header-content {
+                        margin-top:'. $top_offset .'px;
+                }
+
+                /* when the latest activity is too long */
+                #buddypress #item-header #item-header-content {
+                        width:60%;
+                }
+
+                /* This should only happen on regular screens */
+                #buddypress div#item-header h2 a,
+                #buddypress div#item-header h2 {
+                        color: #FFF;
+                        text-rendering: optimizelegibility;
+                        text-shadow: 0px 0px 3px rgba( 0, 0, 0, 0.8 );
+                        margin:25px 0;
+                        font-size:200%;
+                }
+
+                .bp-user #buddypress #item-header #item-header-avatar img.avatar {
+                        border: solid 2px #FFF;
+                        background: rgba( 255, 255, 255, 0.8 );
+                }
+        ' );
+}