bp_avatar_is_front_edit()

Checks whether Avatar UI should be loaded.

Description

Return

(bool) True if Avatar UI should load, false otherwise.

Source

function bp_avatar_is_front_edit() {
    $retval = false;
 
    // No need to carry on if the current WordPress version is not supported.
    if ( ! bp_attachments_is_wp_version_supported() ) {
        return $retval;
    }
 
    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_disable_group_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_disable_group_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
     *
     * @param bool $retval Whether or not to load the Avatar UI.
     */
    return apply_filters( 'bp_avatar_is_front_edit', $retval );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.3.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_is_group_admin_screen()	Is the current page a specific group admin screen?
bp-groups/bp-groups-template.php: bp_is_group_creation_step()	Check which step is displayed during the group creation process.
bp-core/bp-core-template.php: bp_is_group_create()	Is the current page part of the group creation process?
bp-core/bp-core-template.php: bp_is_group_admin_page()	Is the current page part of a single group’s admin screens?
bp-core/bp-core-template.php: bp_is_user_change_avatar()	Is the current page part of a user’s profile avatar editing section?
bp-core/bp-core-template.php: bp_is_active()	Check whether a given component (or feature of a component) is active.
bp-core/bp-core-template.php: bp_get_avatar_admin_step()	Return the current avatar upload step.
bp-core/bp-core-attachments.php: bp_attachments_is_wp_version_supported()	Check if the current WordPress version is using Plupload 2.1.1
bp-core/bp-core-avatars.php: bp_avatar_is_front_edit	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())
bp-core/bp-core-options.php: bp_core_get_root_option()	Get a root option.
bp-core/bp-core-options.php: bp_disable_group_avatar_uploads()	Are group avatars disabled?

Show 6 more uses Hide more uses

Used By
Used By	Description
bp-core/bp-core-cssjs.php: bp_core_avatar_scripts()	Enqueues the css and js required by the Avatar UI.
bp-core/bp-core-avatars.php: bp_avatar_get_templates()	Template function to load the Avatar UI javascript templates.
bp-core/bp-core-avatars.php: bp_avatar_template_check()	Trick to check if the theme’s BuddyPress templates are up to date.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents