Changeset 12885 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

Timestamp:

04/16/2021 05:29:26 AM (5 years ago)

Author:

imath

Message:

Improve the Field/Group APIs to pick selected fields as signup ones

• Introduce the bp_xprofile_get_signup_field_ids() function to get an ordered list of field IDs to use as signup fields.
• Introduce the bp_xprofile_signup_args() function to get the signup arguments to use into the registration page xProfile loop. If no signup fields are available, it falls back to the primary fields group.
• Introduce the $signup_fields_only xProfile loop argument to restrict fetched fields to signup ones if set to true.
• Adapt the BP_XProfile_Data_Template class to build a unique xProfile field group out of any possible field groups containing one or more signup fields when the $signup_fields_only argument is set to true and registration is allowed on the site.
• Adapt the BP_XProfile_Field class to get the possible field's signup position and add a new metabox to add a field to signup ones from the xProfile Field Administration screen.
• Adapt the BP_XProfile_Group class to ignore non signup fields if the $signup_fields_only argument is set to true.

Props johnjamesjacoby, boonebgorges, DJPaul, Offereins

See #6347

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php (modified) (10 diffs)

trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

@@ -139 +139 @@
      */
     public $do_autolink;
+
+    /**
+     * The signup position of the field into the signups form.
+     *
+     * @since 8.0.0
+     * @var int
+     */
+    public $signup_position;
 
     /**
@@ -861 +869 @@
 
     /**
+     * Get the field's signup position.
+     *
+     * @since 8.0.0
+     *
+     * @return int the field's signup position.
+     *             0 if the field has not been added to the signup form.
+     */
+    public function get_signup_position() {
+        if ( ! isset( $this->signup_position ) ) {
+            $this->signup_position = (int) bp_xprofile_get_meta( $this->id, 'field', 'signup_position' );
+        }
+
+        return $this->signup_position;
+    }
+
+    /**
      * Get whether the field values should be auto-linked to a directory search.
      *
@@ -1278 +1302 @@
                             $this->required_metabox();
 
+                            // Output signup position metabox.
+                            $this->signup_position_metabox();
+
                             // Output the Member Types metabox.
                             $this->member_type_metabox();
@@ -1346 +1373 @@
         $supports = array(
             'switch_fieldtype'        => true,
-            'allow_required'          => true,
-            'allow_autolink'          => true,
+            'required'                => true,
+            'do_autolink'             => true,
             'allow_custom_visibility' => true,
             'member_types'            => true,
+            'signup_position'         => true,
         );
 
@@ -1503 +1531 @@
      *
      * @since 2.4.0
+     *
+     * @return void If default field or if the field does not support the feature.
      */
     private function member_type_metabox() {
 
         // The primary field is for all, so bail.
-        if ( 1 === (int) $this->id || ! $this->field_type_supports( 'member_types' ) ) {
+        if ( true === $this->is_default_field() || ! $this->field_type_supports( 'member_types' ) ) {
             return;
         }
@@ -1557 +1587 @@
      * @since 2.3.0
      *
-     * @return void If default field id 1.
+     * @return void If default field or if the field does not support the feature.
      */
     private function visibility_metabox() {
@@ -1606 +1636 @@
      * @since 2.3.0
      *
-     * @return void If default field.
+     * @return void If default field or if the field does not support the feature.
      */
     private function required_metabox() {
@@ -1633 +1663 @@
      * @since 2.5.0
      *
-     * @return void If default field id 1.
+     * @return void If the field does not support the feature.
      */
     private function autolink_metabox() {
@@ -1704 +1734 @@
 
     <?php
+    }
+
+    /**
+     * Output the metabox for setting the field's position into the signup form.
+     *
+     * @since 8.0.0
+     *
+     * @return void If default field or if the field does not support the feature.
+     */
+    private function signup_position_metabox() {
+        // Field types not supporting the feature cannot be added to signups form.
+        if ( ! $this->field_type_supports( 'signup_position' ) || true === $this->is_default_field() ) {
+            return;
+        }
+
+        $next_signup_position = 1;
+        $signup_position      = $this->get_signup_position();
+
+        if ( 0 === $signup_position ) {
+            $signup_fields_order = bp_xprofile_get_signup_field_ids();
+            $next_signup_position = count( $signup_fields_order ) + 1;
+        } else {
+            $next_signup_position = $signup_position;
+        }
+        ?>
+
+        <div class="postbox" id="field-signup-position-metabox">
+            <h2><label for="default-visibility"><?php esc_html_e( 'Signups', 'buddypress' ); ?></label></h2>
+            <div class="inside">
+                <div>
+                    <ul>
+                        <li>
+                            <input type="checkbox" id="has-signup-position" name="signup-position" value="<?php echo esc_attr( $next_signup_position ); ?>" <?php checked( $signup_position, $next_signup_position ); ?> />
+                            <label for="has-signup-position"><?php esc_html_e( 'Use the field into the registration form.', 'buddypress' ); ?></label>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+        <?php
     }
 
@@ -1755 +1825 @@
                     'value' => 'textbox',
                 ),
+                array(
+                    'name'  => 'signup-position',
+                    'id'    => 'has-signup-position',
+                    'value' => $this->get_signup_position(),
+                ),
             );
         }