Adding copy/code to specific donation pages

Question

Drupal 7 site:

We need to add data to certain donation pages. For instance, it should appear on id=1 but not on id=2. This includes some code and js.

I made a Main.extra.tpl and everything works fine when it appears on all pages, but I have not been able to restrict it to be included only on page id=1.

I read that you can do: {if $contributionPageId == "yourPageId"} Your custom messaging here {/if}

but wrapping my code in
{if $contributionPageId == "1"} {/if} doesn't work.

Is there a better way to do this?

Thanks, Rachel

Edit: For now I've modified Drupal's page.tpl.php with:

if ((arg(0) == 'civicrm' && arg(1) == 'contribute') && ($_GET['id'] == '1')):

which does the job - but I still believe there must be a better way.

Answer 1

There are two "better ways" you can try.

First, you can put a template override into a folder with the contribution page ID. So if the current override is at <overrides>/templates/CRM/Contribution/Form.php, then <overrides>/templates/CRM/Contribution/1/Form.php will only override page ID 1.

However, template overrides aren't very maintainable, and they're pretty hacky.

Instead, you can create an extension. You can use hook_civicrm_buildForm like so:

function myextension_civicrm_buildForm( $formName, &$form ) { 
  if ($formName == 'CRM_Contribution_Form_Main' ){
    CRM_Core_Resources::singleton()->addScriptFile('org.example.myextension', 'js/myjavascript.js');
  }
}

This technique is covered in greater detail in the Resources Reference.

Answer 2

Writing an extension is a better way of packaging this type of change.

As Jon pointed out, it's fairly easy with civix to create one and inject the js/css you need

However, it soon becomes a bit of a nightmare to try to handle the contribution page ids and on the top of having to track that id 42 has that lovely towel feature while id 84 has whatever special, you have users that start cloning and replacing and reshuffling stuff...

So assuming it's more than a quick hack, I would create a custom field (eg "layout" + a list of options and modify your extension so it reads this custom field value instead of the id to decide what to inject

And if you think whatever you are changing is generic enough, please consider submit it to our extension directory, and if not, making your repository public on github or somewhere would certainly help someone else facing a problem similar to yours

X+

Answer 3

While I know that an extension is a preferred method using the extra templates method works for me in some situations. (I also found it a great way to get my feet wet learning the possibilities of customizing and the API).

To answer why the {if $contributionPageId == "1"} {/if} code didn't work may be you need to wrap those variables in a literal tag.

From the documentation here: https://docs.civicrm.org/dev/en/latest/framework/templates/

One heads up … if your file contains Javascript (as it probably will), you will need to start your "extra" custom file with the Smarty {literal} tag and the tag. Then use {/literal}{$variable}{literal} if you need to use any Smarty code or variables. Finally, end the file with {/literal}.