Changeset 9210 for trunk/src/bp-members/bp-members-admin.php

Timestamp:

12/04/2014 01:47:49 AM (11 years ago)

Author:

boonebgorges

Message:

Introduce Member Types API.

BuddyPress member types are akin to WordPress's custom post types. Developers
can use bp_register_member_type() to register their types with BuddyPress,
and BP will automatically provide a number of pieces of functionality:

• Mechanisms for storing and fetching member types (as a WP taxonomy term), with full cache support.
• A 'member_type' argument for the bp_has_members()/BP_User_Query stack, which allows filtering member loops by member type.
• Admin UI for changing member types on Dashboard > Users > Community Profile (appears when member types have been registered).

We'll continue to build out more core member type functionality in future
versions of BuddyPress. In the meantime, this is a good starting point for BP
site implementations to have a shared infrastructure for storing and retrieving
this data.

See #6006.

File:

• trunk/src/bp-members/bp-members-admin.php (modified) (3 diffs)

trunk/src/bp-members/bp-members-admin.php

@@ -186 +186 @@
         // Add user row actions for single site
         add_filter( 'user_row_actions', array( $this, 'row_actions' ), 10, 2 );
+
+        // Process changes to member type.
+        add_action( 'bp_members_admin_load', array( $this, 'process_member_type_update' ) );
 
         /** Signups ***********************************************************/
@@ -720 +723 @@
             );
 
+            // Member Type metabox. Only added if member types have been registered.
+            $member_types = bp_get_member_types();
+            if ( ! empty( $member_types ) ) {
+                add_meta_box(
+                    'bp_members_admin_member_type',
+                    _x( 'Member Type', 'members user-admin edit screen', 'buddypress' ),
+                    array( $this, 'user_admin_member_type_metabox' ),
+                    get_current_screen()->id,
+                    'side',
+                    'core'
+                );
+            }
+
             /**
              * Custom metabox ?
@@ -996 +1012 @@
 
         <?php
+    }
+
+    /**
+     * Render the Member Type metabox.
+     *
+     * @since BuddyPress (2.2.0)
+     * @access public
+     *
+     * @param WP_User $user The WP_User object to be edited.
+     */
+    public function user_admin_member_type_metabox( $user = null ) {
+
+        // Bail if no user ID.
+        if ( empty( $user->ID ) ) {
+            return;
+        }
+
+        $types = bp_get_member_types( array(), 'objects' );
+        $current_type = bp_get_member_type( $user->ID );
+
+        /* translators: no option picked in select box */
+        $null_option = __( '----', 'buddypress' );
+
+        ?>
+        <select name="bp-members-profile-member-type">
+            <option value="" <?php selected( '', $current_type ); ?>><?php esc_attr_e( $null_option ) ?></option>
+            <?php foreach ( $types as $type ) : ?>
+                <option value="<?php echo esc_attr( $type->name ) ?>" <?php selected( $type->name, $current_type ) ?>><?php echo esc_html( $type->labels['singular_name'] ) ?></option>
+            <?php endforeach; ?>
+        </select>
+
+        <?php
+
+        wp_nonce_field( 'bp-member-type-change-' . $user->ID, 'bp-member-type-nonce' );
+    }
+
+    /**
+     * Process changes from the Member Type metabox.
+     *
+     * @since BuddyPress (2.2.0)
+     * @access public
+     */
+    public function process_member_type_update() {
+        if ( ! isset( $_POST['bp-member-type-nonce'] ) || ! isset( $_POST['bp-members-profile-member-type'] ) ) {
+            return;
+        }
+
+        $user_id = $this->get_user_id();
+
+        check_admin_referer( 'bp-member-type-change-' . $user_id, 'bp-member-type-nonce' );
+
+        // Permission check.
+        if ( ! current_user_can( 'bp_moderate' ) && $user_id != bp_loggedin_user_id() ) {
+            return;
+        }
+
+        // Member type string must either reference a valid member type, or be empty.
+        $member_type = stripslashes( $_POST['bp-members-profile-member-type'] );
+        if ( ! empty( $member_type ) && ! bp_get_member_type_object( $member_type ) ) {
+            return;
+        }
+
+        /*
+         * If an invalid member type is passed, someone's doing something
+         * fishy with the POST request, so we can fail silently.
+         */
+        if ( bp_set_member_type( $user_id, $member_type ) ) {
+            // @todo Success messages can't be posted because other stuff happens on the pageload.
+        }
     }