wsf_action_pdf_orientationPRO

This add-on is included with the Agency edition. Users of other WS Form PRO editions can also purchase this add-on separately.
Add-ons require WS Form PRO and are not compatible with the WS Form LITE edition.

Contents

Description

The wsf_action_pdf_orientation filter hook allows you to customize the orientation of a PDF when it is generated.

Usage

add_filter( 'wsf_action_pdf_orientation', 'my_hook_function', 10, 4 );

Parameters

  1. $orientation String
    The orientation. Either portrait or landscape.
    Default value: The orientation configured in WS Form > Settings > PDF
  2. $form Form Object
    The form object.
  3. $submit Submit Object
    The submit object.
  4. $template String
    The custom PDF template name. Blank if not used.

Example

// Callback function for the wsf_action_pdf_orientation filter hook
function my_hook_function( $orientation, $form, $submit, $template ) {
    
    // Only change orientation for form ID 123
    if ( $form->id != 123 ) {

         return $orientation;
    }

    // Set the orientation to landscape for form ID 123
    return 'landscape';
}

// Add a callback function for the wsf_action_pdf_orientation filter hook
add_filter( 'wsf_action_pdf_orientation', 'my_hook_function', 10, 4 );

 

Source File

This hook can be found in: <plugin root>/ws-form-pdf.php