Changeset 11150

Timestamp:

09/22/2016 12:35:27 AM (8 years ago)

Author:

r-a-y

Message:

Blogs: Use WordPress' Site Icons as blog avatars.

If the current install is using WordPress 4.3+, we'll now use WordPress'
Site Icon as the site avatar in the Sites Directory:
​https://codex.wordpress.org/Creating_a_Favicon#WordPress_Version_4.3_or_later

If no site icon is available, we'll fallback to the site owner's user
avatar as before. Under the hood, we are mirroring the site icon URLs to
blogmeta whenever a site icon is updated or deleted.

Devs can disable this functionality with the following filter:
add_filter( 'bp_is_blogs_site-icon_active', '__return_false' );

Fixes #6544.

Location:

trunk/src/bp-blogs

Files:

• bp-blogs-filters.php (modified) (1 diff)
• bp-blogs-functions.php (modified) (1 diff)
• bp-blogs-template.php (modified) (1 diff)
• classes/class-bp-blogs-component.php (modified) (1 diff)

trunk/src/bp-blogs/bp-blogs-filters.php

@@ -122 +122 @@
 add_filter( 'bp_activity_post_pre_publish', 'bp_blogs_post_pre_publish', 10, 4 );
 add_filter( 'bp_activity_post_pre_comment', 'bp_blogs_post_pre_publish', 10, 4 );
+
+/**
+ * Registers our custom thumb size with WP's Site Icon feature.
+ *
+ * @since 2.7.0
+ *
+ * @param  array $sizes Current array of custom site icon sizes.
+ * @return array
+ */
+function bp_blogs_register_custom_site_icon_size( $sizes ) {
+    $sizes[] = bp_core_avatar_thumb_width();
+    return $sizes;
+}
+add_filter( 'site_icon_image_sizes', 'bp_blogs_register_custom_site_icon_size' );

trunk/src/bp-blogs/bp-blogs-functions.php

@@ -477 +477 @@
 
 /**
+ * Syncs site icon URLs to blogmeta.
+ *
+ * @since 2.7.0
+ *
+ * @param int|string $old_value Old value
+ * @param int|string $new_value New value
+ */
+function bp_blogs_update_option_site_icon( $old_value, $new_value ) {
+    if ( 0 === $new_value ) {
+        bp_blogs_update_blogmeta( get_current_blog_id(), 'site_icon_url_thumb', 0 );
+        bp_blogs_update_blogmeta( get_current_blog_id(), 'site_icon_url_full',  0 );
+    } else {
+        // Save site icon URL as blogmeta.
+        bp_blogs_update_blogmeta( get_current_blog_id(), 'site_icon_url_thumb', get_site_icon_url( bp_core_avatar_thumb_width() ) );
+        bp_blogs_update_blogmeta( get_current_blog_id(), 'site_icon_url_full',  get_site_icon_url( bp_core_avatar_full_width()  ) );
+    }
+}
+add_action( 'update_option_site_icon', 'bp_blogs_update_option_site_icon', 10, 2 );
+
+/**
  * Deletes the 'url' blogmeta for a site.
  *

trunk/src/bp-blogs/bp-blogs-template.php

@@ -346 +346 @@
         ) );
 
-        // Fetch the avatar.
-        $avatar = bp_core_fetch_avatar( array(
-            'item_id'    => $blogs_template->blog->admin_user_id,
-            'title'      => $r['title'],
-            // 'avatar_dir' => 'blog-avatars',
-            // 'object'     => 'blog',
-            'type'       => $r['type'],
-            'alt'        => $r['alt'],
-            'css_id'     => $r['id'],
-            'class'      => $r['class'],
-            'width'      => $r['width'],
-            'height'     => $r['height']
-        ) );
+        // Use site icon if available.
+        $avatar = '';
+        if ( bp_is_active( 'blogs', 'site-icon' ) && function_exists( 'has_site_icon' ) ) {
+            $site_icon = bp_blogs_get_blogmeta( bp_get_blog_id(), "site_icon_url_{$r['type']}" );
+
+            // Never attempted to fetch site icon before; do it now!
+            if ( '' === $site_icon ) {
+                switch_to_blog( bp_get_blog_id() );
+
+                // Fetch the other size first.
+                if ( 'full' === $r['type'] ) {
+                    $size      = bp_core_avatar_thumb_width();
+                    $save_size = 'thumb';
+                } else {
+                    $size      = bp_core_avatar_full_width();
+                    $save_size = 'full';
+                }
+
+                $site_icon = get_site_icon_url( $size );
+                // Empty site icons get saved as integer 0.
+                if ( empty( $site_icon ) ) {
+                    $site_icon = 0;
+                }
+
+                // Sync site icon for other size to blogmeta.
+                bp_blogs_update_blogmeta( bp_get_blog_id(), "site_icon_url_{$save_size}", $site_icon );
+
+                // Now, fetch the size we want.
+                if ( 0 !== $site_icon ) {
+                    $size      = 'full' === $r['type'] ? bp_core_avatar_full_width() : bp_core_avatar_thumb_width();
+                    $site_icon = get_site_icon_url( $size );
+                }
+
+                // Sync site icon to blogmeta.
+                bp_blogs_update_blogmeta( bp_get_blog_id(), "site_icon_url_{$r['type']}", $site_icon );
+
+                restore_current_blog();
+            }
+
+            // We have a site icon.
+            if ( ! is_numeric( $site_icon ) ) {
+                if ( empty( $r['width'] ) && ! isset( $size ) ) {
+                    $size = 'full' === $r['type'] ? bp_core_avatar_full_width() : bp_core_avatar_thumb_width();
+                } else {
+                    $size = (int) $r['width'];
+                }
+
+                $avatar = sprintf( '<img src="%1$s" class="%2$s" width="%3$s" height="%3$s" alt="%4$s" title="%4$s" />',
+                    esc_url( $site_icon ),
+                    esc_attr( "{$r['class']} avatar-{$size}" ),
+                    esc_attr( $size ),
+                    sprintf( esc_attr__( 'Site icon for %s', 'buddypress' ), bp_get_blog_name() )
+                );
+            }
+        }
+
+        // Fallback to user ID avatar.
+        if ( '' === $avatar ) {
+            $avatar = bp_core_fetch_avatar( array(
+                'item_id'    => $blogs_template->blog->admin_user_id,
+                'title'      => $r['title'],
+                // 'avatar_dir' => 'blog-avatars',
+                // 'object'     => 'blog',
+                'type'       => $r['type'],
+                'alt'        => $r['alt'],
+                'css_id'     => $r['id'],
+                'class'      => $r['class'],
+                'width'      => $r['width'],
+                'height'     => $r['height']
+            ) );
+        }
 
         /**

trunk/src/bp-blogs/classes/class-bp-blogs-component.php

@@ -33 +33 @@
                 'adminbar_myaccount_order' => 30,
                 'search_query_arg' => 'sites_search',
+                'features' => array( 'site-icon' )
             )
         );