Changeset 10557

Timestamp:

02/08/2016 04:52:44 PM (9 years ago)

Author:

boonebgorges

Message:

Introduced 'Autolink' setting for XProfile fields.

Since BP 1.1, XProfile fields have been "autolinked". This means that a user's
entry for profile fields is linked to a search of the Members directory, using
that field's value as a search term. For short values - say, "Wichita, KS" for
the field "City" - the entire field value would be a link to a member search
on the phrase "Wichita, KS". For longer values, as in a multiline text field,
an algorithm detects "lists" (words between commas) and creates links
from them.

This feature was intended to aid in user discovery and serendipity. Sometimes
it works. But sometimes it makes very little sense.

This changeset introduces the ability for administrators to configure this
setting, on a per-field basis.

• The new Autolink metabox on the XProfile Field Admin panel lets admin enable or disable the feature.
• Smart defaults are pre-selected for new fields, or fields for which no value has yet to be saved. Namely: "multi fields" like checkboxes and radio buttons have Autolink enabled by default, while "single fields" have it disabled.

Props LenLay, sooskriszta, jeffsayre, boonebgorges.
Fixes #787.

Location:

trunk/src/bp-xprofile

Files:

• admin/js/admin.js (modified) (2 diffs)
• bp-xprofile-admin.php (modified) (1 diff)
• bp-xprofile-cssjs.php (modified) (2 diffs)
• bp-xprofile-filters.php (modified) (2 diffs)
• classes/class-bp-xprofile-field.php (modified) (4 diffs)

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

@@ -77 +77 @@
  */
 function show_options( forWhat ) {
+    var do_autolink;
+
     for ( var i = 0; i < XProfileAdmin.supports_options_field_types.length; i++ ) {
         document.getElementById( XProfileAdmin.supports_options_field_types[i] ).style.display = 'none';
@@ -83 +85 @@
     if ( XProfileAdmin.supports_options_field_types.indexOf( forWhat ) >= 0 ) {
         document.getElementById( forWhat ).style.display = '';
+        do_autolink = 'on';
+    } else {
+        jQuery( '#do-autolink' ).val( '' );
+        do_autolink = '';
+    }
+
+    // Only overwrite the do_autolink setting if no setting is saved in the database.
+    if ( '' === XProfileAdmin.do_autolink ) {
+        jQuery( '#do-autolink' ).val( do_autolink );
     }
 }

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

@@ -416 +416 @@
                 }
 
+                // Save autolink settings.
+                if ( 1 != $field_id ) {
+                    if ( isset( $_POST['do_autolink'] ) && 'on' === wp_unslash( $_POST['do_autolink'] ) ) {
+                        bp_xprofile_update_field_meta( $field_id, 'do_autolink', 'on' );
+                    } else {
+                        bp_xprofile_update_field_meta( $field_id, 'do_autolink', 'off' );
+                    }
+                }
+
                 /**
                  * Fires at the end of the process to save a field for a user, if successful.

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

@@ -53 +53 @@
         $strings = array(
             'supports_options_field_types' => array(),
+            'do_autolink' => '',
         );
 
@@ -62 +63 @@
         }
 
+        // Load 'autolink' setting into JS so that we can provide smart defaults when switching field type.
+        if ( ! empty( $_GET['field_id'] ) ) {
+            $field_id = intval( $_GET['field_id'] );
+
+            // Pull the raw data from the DB so we can tell whether the admin has saved a value yet.
+            $strings['do_autolink'] = bp_xprofile_get_meta( $field_id, 'field', 'do_autolink' );
+        }
+
         wp_localize_script( 'xprofile-admin-js', 'XProfileAdmin', $strings );
     }

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

@@ -329 +329 @@
  * - Not run on values without commas with less than 5 words.
  * - URL's are made clickable.
- * - To disable: remove_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_link_profile_data', 9, 2 );
+ *
+ * To disable globally:
+ *     remove_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_link_profile_data', 9, 3 );
+ *
+ * To disable for a single field, use the 'Autolink' settings in Dashboard > Users > Profile Fields.
  *
  * @since 1.1.0
@@ -338 +342 @@
  */
 function xprofile_filter_link_profile_data( $field_value, $field_type = 'textbox' ) {
+    global $field;
+
+    if ( ! $field->get_do_autolink() ) {
+        return $field_value;
+    }
 
     if ( 'datebox' === $field_type ) {

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

@@ -129 +129 @@
      */
     protected $allow_custom_visibility;
+
+    /**
+     * Whether values from this field are autolinked to directory searches.
+     *
+     * @since 2.5.0
+     *
+     * @var bool
+     */
+    public $do_autolink;
 
     /**
@@ -793 +802 @@
     }
 
+    /**
+     * Get whether the field values should be auto-linked to a directory search.
+     *
+     * Lazy-loaded to reduce overhead.
+     *
+     * Defaults to true for multi and default fields, false for single fields.
+     *
+     * @since 2.5.0
+     *
+     * @return bool
+     */
+    public function get_do_autolink() {
+        if ( ! isset( $this->do_autolink ) ) {
+            $do_autolink = bp_xprofile_get_meta( $this->id, 'field', 'do_autolink' );
+
+            if ( '' === $do_autolink ) {
+                $this->do_autolink = $this->is_default_field() || $this->type_obj->supports_options;
+            } else {
+                $this->do_autolink = 'on' === $do_autolink;
+            }
+        }
+
+        return $this->do_autolink;
+    }
+
     /* Static Methods ********************************************************/
 
@@ -1138 +1172 @@
                             // Output the field visibility metaboxes.
                             $this->visibility_metabox();
+
+                            // Output the autolink metabox.
+                            $this->autolink_metabox();
+
 
                             /**
@@ -1412 +1450 @@
 
     /**
+     * Private method used to output autolink metabox.
+     *
+     * @since 2.5.0
+     *
+     * @return void If default field id 1.
+     */
+    private function autolink_metabox() {
+
+        // Default field cannot have custom visibility.
+        if ( true === $this->is_default_field() ) {
+            return;
+        }
+
+        ?>
+
+        <div class="postbox">
+            <h2><label for="do-autolink"><?php esc_html_e( 'Autolink', 'buddypress' ); ?></label></h2>
+            <div class="inside">
+                <p class="description"><?php esc_html_e( 'On user profiles, link this field to a search of the Members directory, using the field value as a search term:', 'buddypress' ); ?></p>
+
+                <p>
+                    <label>
+                        <select name="do_autolink" id="do-autolink">
+                            <option value="on" <?php selected( $this->get_do_autolink() ); ?>><?php esc_html_e( 'Enabled', 'buddypress' ); ?></option>
+                            <option value="" <?php selected( $this->get_do_autolink(), false ); ?>><?php esc_html_e( 'Disabled', 'buddypress' ); ?></option>
+                        </select>
+                    </label>
+                </p>
+            </div>
+        </div>
+
+        <?php
+    }
+
+    /**
      * Output the metabox for setting what type of field this is.
      *