Changeset 9755 for trunk/src/bp-core/bp-core-avatars.php

Timestamp:

04/16/2015 10:11:05 PM (10 years ago)

Author:

imath

Message:

Avatar UI: Add Conditional functions and new BP Attachment methods

• bp_avatar_is_front_edit() checks if the user is editing his or a group avatar on front-end
• bp_avatar_use_webcam() checks if the Camera feature should be enabled. By default, it is not the case for touch devices as it can introduce some confustions with the possibility of using the camera of the device to take a selfie, save it as an image an upload it using the Browse button of the Avatar UI. Chrome and Firefox are the only browsers supporting getUserMedia.

NB: these two functions can be filtered to disallow the Camera feature or to completely disallow the new Avatar UI if you prefer to carry on using the legacy UI.

BP_Attachment::script_data() and BP_Attachment_Avatar::script_data() are two new methods to build the javascript localization data. The bp_attachment_avatar_params filter is fired if the current object is not a group or a user and can be used to build the params of another object such as a blog. You can also use the filter bp_attachment_avatar_script_data if you need to override data for any object.

Props boonebgorges, DJPaul.

See #6290
See #6278

File:

• trunk/src/bp-core/bp-core-avatars.php (modified) (1 diff)

trunk/src/bp-core/bp-core-avatars.php

@@ -1374 +1374 @@
 }
 add_action( 'bp_parse_query', 'bp_core_avatar_reset_query', 10, 1 );
+
+/**
+ * Checks whether Avatar UI should be loaded
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @return bool True if Avatar UI should load, false otherwise
+ */
+function bp_avatar_is_front_edit() {
+    $retval = false;
+
+    if ( bp_is_user_change_avatar() && 'crop-image' !== bp_get_avatar_admin_step() ) {
+        $retval = ! bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+    }
+
+    if ( bp_is_active( 'groups' ) ) {
+        // Group creation
+        if ( bp_is_group_create() && bp_is_group_creation_step( 'group-avatar' ) && 'crop-image' !== bp_get_avatar_admin_step() ) {
+            $retval = ! bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+
+        // Group Manage
+        } elseif ( bp_is_group_admin_page() && bp_is_group_admin_screen( 'group-avatar' ) && 'crop-image' !== bp_get_avatar_admin_step() ) {
+            $retval = ! bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+        }
+    }
+
+    /**
+     * Use this filter if you need to :
+     * - Load the avatar UI for a component that is !groups or !user (return true regarding your conditions)
+     * - Completely disable the avatar UI introduced in 2.3 (eg: __return_false())
+     *
+     * @since  BuddyPress (2.3.0)
+     *
+     * @var  bool whether to load the Avatar UI
+     */
+    return apply_filters( 'bp_avatar_is_front_edit', $retval );
+}
+
+/**
+ * Checks whether the Webcam Avatar UI part should be loaded
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @return bool True to load the Webcam Avatar UI part. False otherwise.
+ */
+function bp_avatar_use_webcam() {
+    /**
+     * Do not use the webcam feature for mobile devices
+     * to avoid possible confusions.
+     */
+    if ( wp_is_mobile() ) {
+        return false;
+    }
+
+    /**
+     * Use this filter if you need to disable the webcam capture feature
+     * by returning false.
+     *
+     * @since  BuddyPress (2.3.0)
+     *
+     * @var  bool whether to load Webcam Avatar UI part
+     */
+    return apply_filters( 'bp_avatar_use_webcam', true );
+}