feat(shortcode): Add Company attribute to give_receipt shortcode

[mathetos]

User Story

As a Give Admin I want to be able to display the Company field on the Donation Receipt page.

Current Behavior

Currently, the Company Name is not added by default to the receipt, and there's no option to add it without code.

Expected Behavior

I expect that the Company field would be included in the output of the give_receipt shortcode by default, and that I'd have the option in the Shortcode Builder to exclude it optionally:

Related

• HS Ticket: https://secure.helpscout.net/conversation/600810076/20156?folderId=672194

Tasks

• Ensure the company field is output (if present) in the output of the Donation Receipt by default
• Add the Company field as an option in the Shortcode Builder with "Include" as the default value, with an additional option to "Exclude" it.
• Ensure that the output of the donation receipt respects the new shortcode attribute when it's set to exclude the company field.

[mathetos]

UPDATE:
I do see that the code to pass the value is in the shortcode, but it has to be passed as company_name="true" in order to display, and as shown above, that's not discoverable in the builder. So the only task is to have it output by default (if present) and show in the builder).

[raftaar1191]

@ravinderk Here is the point that needs to be cover but the first two-point is not done as expected. The third point is working fine

• Ensure the company field is output (if present) in the output of the Donation Receipt by default
• Add the Company field as an option in the Shortcode Builder with "Include" as the default value, with an additional option to "Exclude" it.
• Ensure that the output of the donation receipt respects the new shortcode attribute when it's set to exclude the company field.

[ravinderk]

@mathetos @raftaar1191

We can not show company name by default because Shortcode builder do not generate attribute value for default value and it will be difficult to add backward compatibility for existing receipt shortcode. .

[mathetos]

@ravinderk I think I understand. Essentially, we currently only have a global setting for the Company option, not a per-form setting. So your PR essentially just ensures that the Company field is output in the Donation Receipt by default, no changes necessary to the shortcode at all.

But to be clear, I was referring to the Shortcode Builder for the give_receipt shortcode, not the give_form shortcode. So we're not talking about per-form functionality when it comes to the Builder. Instead, the Builder is used for customizing the give_receipt shortcode. This would respect the global setting just fine. I'm simply saying that because we have the option in the shortcode, we should expose that in the Builder.

Does that make sense?

[ravinderk]

@mathetos We have per form company field setting:

@mathetos Shortcode builder does not allow us to set default value other than the default value of shortcode attribute. That means by default company_name has false value, so we can not set it to true in shortcode by default. Admin has to choose that value and then it will be set in the shortcode.

[ravinderk]

Slack Chat Summary

Participants: Matt Ravinder
Topic: Shortcode Builder
Result:There was confusion about what Ravinder's PR actually did. It turns out it does exactly what Matt was hoping for and this should resolve the user issue completely.