Purpose of order receipt theme suggestions/overrides

Hi - thanks for the feedback. I wrote that method 7 years ago, when this was a customization for client and not yet contributed, so my best guess is I needed it for that work.

Perhaps the best DX solution at this point is to remove the template but leave the suggestion, since Commerce adds the order bundle type but not the gateway ID as a suggestion

A closer look and I have a better answer. There is a small but important difference between the templates.

The template at commerce/modules/order/templates/commerce-order-receipt.html.twig has this block:

{% block payment_method %}
  {{ payment_method }}
{% endblock %}

And the template in this module has:

{% block payment_method %}
  {{ payment_method }}
  {{ payment_instructions }}
{% endblock %}

The payment instruction info is preprocessed in commerce_purchase_order_preprocess_commerce_order_receipt. I've changed the template in this module to a clear twig block override. Please would this have saved you time?

Hey Shawn,

Thanks for making the update and explaining the preprocess. I think all of this makes sense.

Thanks,
Andy

Related: It looks as if the system is using this module's receipt template for all orders, even those that don't use the purchase order gateway.

Is that correct/intended?

If so, would it make sense to add the theme suggestions only for purchase orders? Maybe wrap it in something like:

if ($variables['order_entity']->get('payment_gateway') == "purchase_order")  {
}

I'd like to customize the template for other payment methods and this is a complication.