Changeset 12887

Timestamp:

04/16/2021 05:37:03 AM (5 years ago)

Author:

imath

Message:

Update both Template Pack registration forms to use signup fields

• Nouveau and Legacy are now usinf the bp_xprofile_signup_args() to build the argument of their registration's form xProfile loop.
• Include a backward compatibility mechanism if the register.php page has been overriden from a theme or a plugin.
• This commit also includes PHP Unit tests about the xProfile loop and Signup Fields.

Props johnjamesjacoby, boonebgorges, DJPaul, Offereins

Fixes #6347

Location:

trunk

Files:

• src/bp-templates/bp-legacy/buddypress/members/register.php (modified) (1 diff)
• src/bp-templates/bp-nouveau/buddypress/members/register.php (modified) (2 diffs)
• src/bp-templates/bp-nouveau/includes/template-tags.php (modified) (1 diff)
• src/bp-templates/bp-nouveau/includes/xprofile/template-tags.php (modified) (2 diffs)
• src/bp-xprofile/bp-xprofile-filters.php (modified) (1 diff)
• tests/phpunit/testcases/xprofile/template.php (added)

trunk/src/bp-templates/bp-legacy/buddypress/members/register.php

@@ -166 +166 @@
 
                     <?php /* Use the profile field loop to render input fields for the 'base' profile field group */ ?>
-                    <?php if ( bp_is_active( 'xprofile' ) ) : if ( bp_has_profile( array( 'profile_group_id' => 1, 'fetch_field_data' => false ) ) ) : while ( bp_profile_groups() ) : bp_the_profile_group(); ?>
+                    <?php if ( bp_is_active( 'xprofile' ) ) : if ( bp_has_profile( bp_xprofile_signup_args() ) ) : while ( bp_profile_groups() ) : bp_the_profile_group(); ?>
 
                     <?php while ( bp_profile_fields() ) : bp_the_profile_field(); ?>

trunk/src/bp-templates/bp-nouveau/buddypress/members/register.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 4.0.0
+ * @version 8.0.0
  */
 
@@ -39 +39 @@
                 <?php /***** Extra Profile Details ******/ ?>
 
-                <?php if ( bp_is_active( 'xprofile' ) && bp_nouveau_base_account_has_xprofile() ) : ?>
+                <?php if ( bp_is_active( 'xprofile' ) && bp_nouveau_has_signup_xprofile_fields( true ) ) : ?>
 
                     <?php bp_nouveau_signup_hook( 'before', 'signup_profile' ); ?>

trunk/src/bp-templates/bp-nouveau/includes/template-tags.php

@@ -1516 +1516 @@
 
         // Provide a class token to acknowledge additional extended profile fields added to default account reg screen
-        if ( 'register' === bp_current_component() && bp_is_active( 'xprofile' ) && bp_nouveau_base_account_has_xprofile()) {
+        if ( 'register' === bp_current_component() && bp_is_active( 'xprofile' ) && bp_nouveau_has_signup_xprofile_fields()) {
             $classes[] = 'extended-default-reg';
         }

trunk/src/bp-templates/bp-nouveau/includes/xprofile/template-tags.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 3.0.0
+ * @version 8.0.0
  */
 
@@ -63 +63 @@
  *
  * @since 3.0.0
+ * @deprecated 8.0.0
  */
 function bp_nouveau_base_account_has_xprofile() {
-    return (bool) bp_has_profile(
-        array(
-            'profile_group_id' => 1,
-            'fetch_field_data' => false,
-        )
-    );
+    _deprecated_function( __FUNCTION__, '8.0.0', 'bp_nouveau_has_signup_xprofile_fields()' );
+    return bp_nouveau_has_signup_xprofile_fields();
 }
+
+/**
+ * Checks whether there are signup profile fields to display.
+ *
+ * @since 8.0.0
+ *
+ * @param bool Whether to init an xProfile loop.
+ * @return bool True if there are signup profile fields to display. False otherwise.
+ */
+function bp_nouveau_has_signup_xprofile_fields( $do_loop = false ) {
+    if ( ! $do_loop ) {
+        $signup_fields = (array) bp_xprofile_get_signup_field_ids();
+        return 1 <= count( $signup_fields );
+    }
+
+    return bp_has_profile( bp_xprofile_signup_args() );
+}

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

@@ -692 +692 @@
     return $exporters;
 }
+
+/**
+ * Used to edit the field input name inside the xProfile Admin Screen
+ *
+ * @see bp_xprofile_admin_get_signup_field()
+ *
+ * @since 8.0.0
+ *
+ * @param string $field_selector The text to use as the input name/id attribute.
+ * @return string                The text to use as the input name/id attribute.
+ */
+function bp_get_the_profile_signup_field_input_name( $field_selector = '' ) {
+    global $field;
+
+    if ( isset( $field->id ) && $field->id ) {
+        $field_selector = sprintf( 'signup_field_%d', $field->id );
+    }
+
+    return $field_selector;
+}
+
+/**
+ * Provides Signup fields argument back compatibility for template overrides.
+ *
+ * @since 8.0.0
+ * @access private
+ *
+ * @param array $args The xProfile loop's signup arguments.
+ * @return array The xProfile loop's signup arguments.
+ */
+function _bp_xprofile_signup_do_backcompat( $args = array() ) {
+    $expected_args = bp_xprofile_signup_args();
+    $needed_args   = array_intersect_key( $args, $expected_args );
+
+    if ( 1 === $args['profile_group_id'] || array_diff_key( $expected_args, $needed_args ) ) {
+        _doing_it_wrong( 'bp_has_profile()', __( 'The argument of this function into your custom `members/register.php` template should be bp_xprofile_signup_args()', 'buddypress' ), '8.0.0' );
+        $args = $expected_args;
+    }
+
+    return $args;
+}
+
+/**
+ * Checks whether back compatibility is needed about xProfile loop's signup arguments.
+ *
+ * @since 8.0.0
+ * @access private
+ *
+ * @param string $template      The located path for registration template.
+ * @param string $template_name The needed template name.
+ */
+function _bp_xprofile_signup_check_backcompat( $template = '', $template_name = '' ) {
+    if ( 'members/register.php' !== $template_name ) {
+        return;
+    }
+
+    if ( 0 !== strpos( $template, buddypress()->theme_compat->theme->dir ) ) {
+        add_filter( 'bp_after_has_profile_parse_args', '_bp_xprofile_signup_do_backcompat', 100 );
+    }
+}
+
+/**
+ * Starts Signup fields back compatibility process only on the signup's page.
+ *
+ * @since 8.0.0
+ * @access private
+ */
+function _bp_xprofile_signup_start_backcompat() {
+    $signup_fields = (array) bp_xprofile_get_signup_field_ids();
+    if ( ! $signup_fields ) {
+        return;
+    }
+
+    add_action( 'bp_locate_template', '_bp_xprofile_signup_check_backcompat', 10, 2 );
+}
+add_action( 'bp_core_screen_signup', '_bp_xprofile_signup_start_backcompat' );