Skip to main content

fc_pro_order_pay_substep_{substep_id}_text_lines

Type: Filter

Filters the review text lines for an order pay substep.

The dynamic portion of the hook name, $substep_id, is the order pay substep ID. Possible hook names include:

  • fc_pro_order_pay_substep_billing_address_text_lines
  • fc_pro_order_pay_substep_contact_text_lines
  • fc_pro_order_pay_substep_order_notes_text_lines
  • fc_pro_order_pay_substep_payment_text_lines
  • fc_pro_order_pay_substep_shipping_address_text_lines
  • fc_pro_order_pay_substep_shipping_method_text_lines

Signature​

apply_filters( 'fc_pro_order_pay_substep_{substep_id}_text_lines', $value, $order );

Parameters​

NameTypeDescription
$valuearrayFiltered value. Default empty array.
$order\WC_OrderOrder object.

Since​

  • 3.0.0

Source: inc/order-pay-page.php

Examples​

In fc_pro_order_pay_substep_{substep_id}_text_lines, order_notes replaces {substep_id}.

add_filter( 'fc_pro_order_pay_substep_order_notes_text_lines',
/**
* Add custom text lines to order notes substep.
*
* @param array $value Filtered value. Default empty array.
* @param \WC_Order $order Order object.
* @return array Filtered value.
*/
function( $value, $order ) {
// Add order date for reference
$order_date = $order->get_date_created();

if ( $order_date ) {
$value[] = __( 'Order Date:', 'text-domain' ) . ' ' . $order_date->date_i18n( get_option( 'date_format' ) );
}

return $value;
},
10,
2
);