ms_view_frontend_payment_form_start

Trigger an action before the payment form is displayed.

Description

do_action( 'ms_view_frontend_payment_form_start', (unknown) $invoice, (unknown) $instance ); 

This hook can be used by Add-ons or plugins to initialize payment settings or add custom code.

Parameters (2)

0. $invoice (unknown)
The invoice.
1. $instance (unknown)
The instance.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'ms_view_frontend_payment_form_start', $invoice, $instance ); 
The following example is for adding a hook callback.
  1. // define the ms_view_frontend_payment_form_start callback 
  2. function action_ms_view_frontend_payment_form_start( $invoice, $instance ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'ms_view_frontend_payment_form_start', 'action_ms_view_frontend_payment_form_start', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'ms_view_frontend_payment_form_start', 'action_ms_view_frontend_payment_form_start', 10, 2 ); 

Defined (1)

The action is defined in the following location(s).

/app/view/frontend/class-ms-view-frontend-payment.php  
  1. do_action( 'ms_view_frontend_payment_form_start', $invoice, $this );