Document hooks in fillpdf.api.php

We currently don't yet have a fillpdf.api.php file, though we should. That said, you simply implement hook_fillpdf_merge_pdf_fields_alter(&$fields, $context); and change the fields as needed. Your modified values will be placed into the PDF. Note that this happens after field transformations (as configured in the UI) have occurred.

Fields are indexed by PDF key. The value is the array element value. $context contains 'nodes' and 'webforms', which contain loaded nodes and webforms corresponding to the Fill PDF URL. There won't be any webforms in there if you aren't filling a webform, and the nodes will correspond to the webform node if you are.

So here is an example. Untested but gives a starting point:

/**
  * Implements hook_fillpdf_merge_fields_alter().
  */
function mymodule_fillpdf_merge_fields_alter(&$fields, $context) {
  $submission = end($webforms); // Gets the last sid passed.
  $ticket_price = 5.00; // @todo: Replace with code to get this from the webform object.
  $fields['Number of Guests'] *= $ticket_price; // Multiply number of guests by ticket price.
}

Does this help?

Also changing this to a task to document this hook.

Need to create fillpdf.api.php and document the other hooks as well.

I try to do the same thing, I create a function

function form_template_fillpdf_merge_fields_alter(&$fields, $context) {
  $fields['Labo'] = 'test'; 
}

in my own module named form_template which contain other functions which work.

Nothing different when FillPDF generate the PDF.
When I put this line

  $fields['Labo'] = 'test'; 

just under the

drupal_alter('fillpdf_merge_fields_alter', $fields, $context);

in FillPDF module, it works.

I uninstall and reinstall my module but nothing.

Any idea for debugging?
drupal 7.22
FillPDF 7.x-1.9
Thanks

Is your module named form_tempalte? Try clearing the cache. Your function signature looks correct. Doing it in your module should work as well, particularly if it works there.

Yes, the name of the module is correct others hooks work.

But I work with Fill PDF 7.x-1.9, maybe it's better with dev version ?

Thanks

if I rename my function :
function form_template_fillpdf_merge_fields_alter_alter(&$fields, $context) {
two times _alter

it works !!

i don't know why... but it works

I need to add new line in the field I alter, how to do that ?

Like "Line 1\nLine2" ...

Thanks

Simon

Ah. You're right about the function signature. That's not what I intended, but that is currently the right way to do it.

To add a new line, trying adding <br> or <br /> to the output. There is code somewhere in fillpdf_merge_pdf that replaces it with newlines.

Thank you but '<br />' does not work.
To add a new line, simply

fields['labo']="1 line
line2
";

and the form field has to support multi line !

filantrop: Yes, I said that in comment #10 :)

Patch welcome in a separate issue to fix the callback name. It can be changed completely in 7.x-2.x, but the correct version can only be added as an alias for the current version in 7.x-1.x (can't break the API in 7.x-1.x). Thanks.

Thanks for the comments and usage examples! If you want to put these in the Fill PDF documentation, you are welcome. Everyone can edit documentation.

I encountered the same problem, added a patch in #2140435: Confusing hook name 'hook_fillpdf_merge_fields_alter_alter'.

For me it is not working with drupal version 9.5.2 and fillpdf version 5.0
I not see any output.
I want this hook to remove prefix and change date format for some fields
/**
* Implements hook_fillpdf_merge_fields_alter().
*/
function miscellaneous_fillpdf_merge_fields_alter(&$fields, $context) {
dump($fields);
// $submission = end($webforms); // Gets the last sid passed.
// $ticket_price = 5.00; // @todo: Replace with code to get this from the webform object.
// $fields['The rent is'] *= $ticket_price; // Multiply number of guests by ticket price.
}

I thought dump() was a Twig function. It won't work in a hook implementation. If devel module is enabled, you should be able to use dpm().

No success, actually the hook is not triggering.

hook_fillpdf_merge_fields_alter() only exists in Drupal 7.

Drupal 7 is no longer supported. If this applies to a supported version, please re-open.