BP_Button::__construct( array|string $args = '' )

Builds the button based on class parameters.

Description

Parameters

$args

(Optional) See {@BP_Button}.

Default value: ''

Source

File: bp-core/classes/class-bp-button.php

public function __construct( $args = '' ) {
 
    $r = wp_parse_args( $args, get_class_vars( __CLASS__ ) );
 
    // Backward compatibility with deprecated parameters.
    $r = $this->backward_compatibility_args( $r );
 
    // Deprecated. Subject to removal in a future release.
    $this->wrapper = $r['wrapper'];
    if ( !empty( $r['link_id']    ) ) $this->link_id    = ' id="' .    $r['link_id']    . '"';
    if ( !empty( $r['link_href']  ) ) $this->link_href  = ' href="' .  $r['link_href']  . '"';
    if ( !empty( $r['link_title'] ) ) $this->link_title = ' title="' . $r['link_title'] . '"';
    if ( !empty( $r['link_rel']   ) ) $this->link_rel   = ' rel="' .   $r['link_rel']   . '"';
    if ( !empty( $r['link_class'] ) ) $this->link_class = ' class="' . $r['link_class'] . '"';
    if ( !empty( $r['link_text']  ) ) $this->link_text  =              $r['link_text'];
 
    // Required button properties.
    $this->id                = $r['id'];
    $this->component         = $r['component'];
    $this->must_be_logged_in = (bool) $r['must_be_logged_in'];
    $this->block_self        = (bool) $r['block_self'];
 
    // $id and $component are required and component must be active.
    if ( empty( $r['id'] ) || empty( $r['component'] ) || ! bp_is_active( $this->component ) ) {
        return false;
    }
 
    // No button for guests if must be logged in.
    if ( true == $this->must_be_logged_in && ! is_user_logged_in() ) {
        return false;
    }
 
    // The block_self property.
    if ( true == $this->block_self ) {
        /*
         * No button if you are the current user in a members loop.
         *
         * This condition takes precedence, because members loops can be found on user
         * profiles.
         */
        if ( bp_get_member_user_id() ) {
            if ( is_user_logged_in() && bp_loggedin_user_id() == bp_get_member_user_id() ) {
                return false;
            }
 
        // No button if viewing your own profile (and not in a members loop).
        } elseif ( bp_is_my_profile() ) {
            return false;
        }
    }
 
    // Should we use a parent element?
    if ( ! empty( $r['parent_element'] ) ) {
        if ( ! isset( $r['parent_attr']['class'] ) ) {
            $r['parent_attr']['class'] = '';
        }
 
        // Always add 'generic-button' class.
        if ( false === strpos( $r['parent_attr']['class'], 'generic-button' ) ) {
            if ( ! is_array( $r['parent_attr'] ) ) {
                $r['parent_attr'] = array();
            }
            if ( ! empty( $r['parent_attr']['class'] ) ) {
                $r['parent_attr']['class'] .= ' ';
            }
            $r['parent_attr']['class'] .= 'generic-button';
        }
 
        // Set parent element props.
        $this->parent_element = $r['parent_element'];
        $this->parent_attr    = $r['parent_attr'];
 
        // Render parent element attributes.
        $parent_elem = new BP_Core_HTML_Element( array(
            'element' => $r['parent_element'],
            'attr'    => $r['parent_attr']
        ) );
 
        // Set before and after.
        $before = $parent_elem->get( 'open_tag' );
        $after  = $parent_elem->get( 'close_tag' );
 
    // No parent element.
    } else {
        $before = $after = '';
    }
 
    // Button properties.
    $button = '';
    if ( ! empty( $r['button_element'] ) ) {
        $button = new BP_Core_HTML_Element( array(
            'element'    => $r['button_element'],
            'attr'       => $r['button_attr'],
            'inner_html' => ! empty( $r['link_text'] ) ? $r['link_text'] : ''
        ) );
        $button = $button->contents();
    }
 
    // Build the button.
    $this->contents = $before . $button . $after;
 
    /**
     * Filters the button based on class parameters.
     *
     * This filter is a dynamic filter based on component and component ID and
     * allows button to be manipulated externally.
     *
     * @since BuddyPress 1.2.6
     * @since BuddyPress 2.7.0 Added $r as a parameter.
     *
     * @param string    $contents HTML being used for the button.
     * @param BP_Button $this     Current BP_Button instance.
     * @param string    $before   HTML appended before the actual button.
     * @param string    $after    HTML appended after the actual button.
     * @param array     $r        Parsed button arguments.
     */
    $this->contents = apply_filters( 'bp_button_' . $this->component . '_' . $this->id, $this->contents, $this, $before, $after, $r );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.6	Introduced.

Uses

Uses
Uses	Description
bp-members/bp-members-template.php: bp_get_member_user_id()	Get the ID of the current member in the loop.
bp-core/bp-core-template.php: bp_is_my_profile()	Is the current page part of the profile of the logged-in user?
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_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/classes/class-bp-button.php: BP_Button::backward_compatibility_args()	Provide backward compatibility for deprecated button arguments.
bp-core/classes/class-bp-button.php: bp_button_{$this->component}_	Filters the button based on class parameters.
bp-core/classes/class-bp-core-html-element.php: BP_Core_HTML_Element::__construct()	Constructor.

Show 2 more uses Hide more uses

Used By
Used By	Description
bp-core/bp-core-template.php: bp_get_button()	Create and return a button.

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