CiviCRM Community Forums (archive)

I spent a lot of time wading through documentation to figure out how to add a token to an email.  I took the example for contribution and changed the query to get info from membership.  Enabled the module.  Added the token between {} into my mailing.  Nothing is replaced in my test emails.  I haven't a clue how to debug this. 

My query works from a sql prompt, well with mods to remove the contact_id in stuff.

Should I see the new token I added when I click on insert token from the New Mailing form?  I'm guessing not.

In the examples the functions are named myhooks_civicrm_tokens and myhooks_civicrm_tokenValues, what calls these?  Are these names baked in so these names get called or do I need to have the names of these functions stuck in some other chunk of code so they get called or does it matter what they named?

I'm running 3.2.4 drupal 6.19

Here is the code I stuck in sites/all/modules/hooks/hooks.module

<?php

# implement the tokens hook so we can add our new token to the list of tokens
# displayed to CiviMail users
function myhooks_civicrm_tokens( &$tokens ) {
    $tokens['affiliation'] =
        array('affiliation.ug' );
}

function myhooks_civicrm_tokenValues( &$details, &$contactIDs ) {
    # prepare the contact ID(s) for use in a database query
    if ( is_array( $contactIDs ) ) {
        $contactIDString = implode( ',', array_values( $contactIDs ) );
        $single = false;
    } else {
        $contactIDString = "( $contactIDs )";
        $single = true;
    }

    # build the database query
    $query = "
      SELECT contact_id,
             concat(mt.name, ' class of ' , date_format(m.end_date,'%y')) as ug
      FROM   civicrm_membership m,
             civicrm_membership_type mt
      WHERE  mt.id= m.membership_type_id
      and    m.contact_id in ( $contactIDString )
      and    curdate() between m.start_date and m.end_date
      and    m.membership_type_id = 1
      and    is_test = 0
    ";

    # run the query
    $dao = CRM_Core_DAO::executeQuery( $query );
    while ( $dao->fetch( ) ) {
        if ( $single ) {
            $value =& $details;
        } else {
            if ( ! array_key_exists( $dao->contact_id, $details ) ) {
                $details[$dao->contact_id] = array( );
            }
            $value =& $details[$dao->contact_id];
        }

        # set the token's value
        $value['affiliation.ug'] = $dao->ug;
    }
}

It looks like your hook isn't being called. (I suppose the module is enabled?)

Is your hook named correctly? What is your actual module name / actual hook name (presumably myhooks is just a placeholder)

I found my problem.  I suppose in hindsight I should have seen this but none of the documentation that I came across mentions this explicitly.

Apparently, as Eileen eluded, the names of the modules and functions are critical. 

I don't know for sure and don't want to spend the time testing it, but it seems that the function names beginning must match the module name.

So if I name a module acme_hooks and I have the files acme_hooks.info and acme_hooks.module the functions in acme_hooks.module must start with acme_hooks, e.g. acme_hooks_civicrm_token, acme_hooks_civicrm_tokenValues.

I updated the wiki a touch to clarify this.