HOWTO: Customise the quick search box

[abeverley]

I thought I'd write this quick tutorial on customising the quick search box, as it seems that it's something that quite a few people want to do, but despite there being various hints on the web, there are no complete instructions.

This is still fairly brief, but hopefully enough to get people up and running.

1. Create a new directory in sites/all/modules/ for custom modules. I called mine civi_custom

2. Create a file in the above directory with the extension .info for the module's details. I called mine quicksearch.info. Add the following contents:

name = Customised Quicksearch
description = Module containing the CiviCRM hooks for customising the Quicksearch
dependencies[] = civicrm
package = CiviCRM
core = 7.x
version = 0.1

3. Create another file in the above directory with the extension .module for the module's code. I called mine quicksearch.module. Add the following contents. Note that the SQL query below is where you do your search customisation (both the search and what's returned). I'm not going to explain that here, but there is another example below and others on the web. Also note that the first part of the function should be the same as your module filename.

<?php
function quicksearch_civicrm_contactListQuery( &$query, $name, $context, $id ) {
  if ($context == 'navigation') {
    $query = "SELECT cc.id as id, CONCAT_WS( ' :: ', sort_name, phone ) as data
              FROM civicrm_contact cc
              LEFT JOIN civicrm_phone phe ON ( cc.id = phe.contact_id AND phe.is_primary = 1 )
              WHERE sort_name LIKE '%$name%' OR external_identifier = '$name'       
              AND cc.is_deleted = 0
              LIMIT 0,10";
  }
}
?>

4. Go to "modules" in the main Drupal administration pages. You should see your new module under the CiviCRM section.

5. Tick to enable and save settings.

That's it - your new custom search should start working when you do a new quick search.

Another custom search example:

$query = "SELECT cc.id as id, CONCAT_WS( ' :: ', sort_name, email, phone, street_address, city, ste.name, coy.name ) as data
        FROM civicrm_contact cc LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )
        LEFT JOIN civicrm_phone phe ON ( cc.id = phe.contact_id AND phe.is_primary = 1 )
        LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1 )
        LEFT JOIN civicrm_state_province ste ON ( sts.state_province_id = ste.id )
        LEFT JOIN civicrm_country coy ON ( sts.country_id = coy.id )
        WHERE sort_name LIKE '%$name%' OR external_identifier = '$name'
        OR postal_code LIKE '%$name%' AND cc.is_deleted = 0
        LIMIT 0,10";


Andy Beverley / andy@andybev.com

[Keith]

Thanks, Andy,

This was just what I needed to get the idea of modules in civi and drupal

Keith

[abeverley]

Glad you found it helpful. It took me ages just to work out how the function names should be called!

[Tony Horrocks]

Nice one

[mjpforsberg]

Thanks for that!

I needed to put the WHERE clause in parentheses in order for it to work correctly.

[Aahar]

I think hook_civicrm_contactListQuery can be applied to a custom auto-complete field for contacts.
But in that case, how will I be able to know the value of 'context'?

[xavier]

$context is a param of the hook

the easiest is add a die($context) and see the value when using it in the context you want (might need to use firebug to see what's returned by the ajax call)

X+

[flug]

Thanks for that!

I needed to put the WHERE clause in parentheses in order for it to work correctly.

Yes, like this:

Code: [Select]

$query = "SELECT cc.id as id, CONCAT_WS( ' :: ', sort_name, email, phone, street_address, city, ste.name, coy.name ) as data
        FROM civicrm_contact cc LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )
        LEFT JOIN civicrm_phone phe ON ( cc.id = phe.contact_id AND phe.is_primary = 1 )
        LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1 )
        LEFT JOIN civicrm_state_province ste ON ( sts.state_province_id = ste.id )
        LEFT JOIN civicrm_country coy ON ( sts.country_id = coy.id )
        WHERE  ( sort_name LIKE '%$name%' OR external_identifier = '$name'
        OR postal_code LIKE '%$name%' ) AND cc.is_deleted = 0
        LIMIT 0,10";

Otherwise the deleted contacts are pulled up, which is probably not what you want.

[flug]

Here is another example--in our case almost all contacts are from the same country and state so that info wasn't very helpful, but being able to search by name, email, contact ID, and street address is quite helpful.

Code: [Select]

    $query = "SELECT cc.id as id, CONCAT_WS( ' :: ',  cc.id, sort_name, email,  street_address, city, postal_code ) as data
        FROM civicrm_contact cc LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )
        LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1 )
        LEFT JOIN civicrm_state_province ste ON ( sts.state_province_id = ste.id )
        WHERE ( sort_name LIKE '%$name%'
        OR email LIKE '%$name%'
        OR display_name LIKE '%$name%'
        OR  cc.id LIKE '$name'
        OR sts.street_address LIKE '%$name%' )
        AND cc.is_deleted = 0
        LIMIT 0,10";


[Aahar]

This is how to make this Custom QuickSearch of Contact List in Drupal Block:-

1). Make a CiviCRM profile and use this custom field. (Administer -. Customize Data & Screens -> Profiles)
2) Now take the HTML Snippet of the profile  (In the profile page click on more and select HTML Snippet)
3) Copy this code and paste it in a new Drupal Block. Use Full HTML.