Changeset 12868 for trunk/src/bp-xprofile/bp-xprofile-admin.php

Timestamp:

03/21/2021 02:17:21 PM (4 years ago)

Author:

imath

Message:

Field Types can now declare supported features & field visibility

• Edit the JavaScript file used by the xProfile Create field Administration screen to handle Field types requirements by showing/hiding screen metaboxes according to feature supports and to get ride of some jQuery deprecated methods.
• Improve the xProfile Field API to take in account xProfile Field Types declared feature supports by adding two new methods to get (BP_XProfile_Field->get_field_type_supports()) & check (BP_XProfile_Field->field_type_supports( $feature_name )) the field type supported features.
• The xProfile Create field Administration Screen Metaboxes displayed to set the field properties can now be disabled by the Field Type using the static variable $supported_features. See tests/phpunit/assets/bptest-xprofile-field-type.php for an example of use.
• Improve the xProfile Field API to take in account the xProfile Field Types visibility property to use as default field visibility. NB: setting this Field Type visibility and its allow_custom_visibility feature support to false, a Field Type can now enforce the visibility to use for a field.
• Introduce a new xProfile Fields loop argument $hide_field_types to avoid displaying fields according to an array of Field types. To customize this new argument you can use the bp_before_has_profile_parse_args filter for existing xProfile loop. For instance you can avoid to list xProfile fields according to their type from the WP-Admin/Extended profile screen checking the corresponding Administration Screen ID.
• Add PHP unit tests to verify these improvements are working the right way.

Props DJPaul, Offereins, needle, netweb, vapvarun

See #7162

File:

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

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

@@ -494 +494 @@
             $field->name        = $_POST['title'];
 
+            /*
+             * By default a Textbox field is created. To run field type's feature
+             * checks we need to set it to what it really is early.
+             */
+            if ( is_null( $field_id ) ) {
+                $field_type = bp_xprofile_create_field_type( $field->type );
+
+                // If it's a placeholder, then the field type is not registered.
+                if ( ! $field_type instanceof BP_XProfile_Field_Type_Placeholder ) {
+                    $field->type_obj = $field_type;
+                }
+            }
+
+            if ( ! $field->field_type_supports( 'required' ) ) {
+                $field->is_required = "0";
+            }
+
             if ( ! empty( $_POST['description'] ) ) {
                 $field->description = $_POST['description'];
@@ -538 +555 @@
                 // Validate default visibility.
                 if ( ! empty( $_POST['default-visibility'] ) && in_array( $_POST['default-visibility'], wp_list_pluck( bp_xprofile_get_visibility_levels(), 'id' ) ) ) {
-                    bp_xprofile_update_field_meta( $field_id, 'default_visibility', $_POST['default-visibility'] );
+                    $default_visibility = $_POST['default-visibility'];
+
+                    if ( ! $field->field_type_supports( 'allow_custom_visibility' ) ) {
+                        $default_visibility = 'public';
+                    }
+
+                    bp_xprofile_update_field_meta( $field_id, 'default_visibility', $default_visibility );
                 }
 
                 // Validate custom visibility.
                 if ( ! empty( $_POST['allow-custom-visibility'] ) && in_array( $_POST['allow-custom-visibility'], array( 'allowed', 'disabled' ) ) ) {
-                    bp_xprofile_update_field_meta( $field_id, 'allow_custom_visibility', $_POST['allow-custom-visibility'] );
+                    $allow_custom_visibility = $_POST['allow-custom-visibility'];
+
+                    if ( ! $field->field_type_supports( 'allow_custom_visibility' ) ) {
+                        $allow_custom_visibility = 'disabled';
+                    }
+
+                    bp_xprofile_update_field_meta( $field_id, 'allow_custom_visibility', $allow_custom_visibility );
                 }
 
@@ -553 +582 @@
                 }
 
+                $do_autolink = '';
+                if ( $field->field_type_supports( 'do_autolink' ) && isset( $_POST['do_autolink'] ) && $_POST['do_autolink'] ) {
+                    $do_autolink = wp_unslash( $_POST['do_autolink'] );
+                }
+
                 // Save autolink settings.
-                if ( isset( $_POST['do_autolink'] ) && 'on' === wp_unslash( $_POST['do_autolink'] ) ) {
+                if ( 'on' === $do_autolink ) {
                     bp_xprofile_update_field_meta( $field_id, 'do_autolink', 'on' );
                 } else {