WooCommerce Checkout Field Editor Code Generator

/**
 * Checkout field: How did you hear about us?
 * Paste into your child theme's functions.php or a code snippets plugin.
 * Test on a staging site first.
 */

// Checkout block: register the field with the Additional Checkout Fields API.
add_action( 'woocommerce_init', 'my_store_how_did_you_hear_register_block_field' );
function my_store_how_did_you_hear_register_block_field() {
	if ( ! function_exists( 'woocommerce_register_additional_checkout_field' ) ) {
		return;
	}
	woocommerce_register_additional_checkout_field(
		array(
			'id'       => 'my-store/how-did-you-hear',
			'label'    => 'How did you hear about us?',
			'location' => 'order',
			'type'     => 'select',
			'required' => false,
			'placeholder' => 'Select an option',
			'options'  => array(
				array( 'value' => 'google', 'label' => 'Google' ),
				array( 'value' => 'instagram', 'label' => 'Instagram' ),
				array( 'value' => 'a-friend', 'label' => 'A friend' ),
				array( 'value' => 'other', 'label' => 'Other' ),
			),
		)
	);
}
// WooCommerce shows the value on the order screen, in emails and in the customer's account automatically.
// To read it in your own code:
// $checkout_fields = Automattic\WooCommerce\Blocks\Package::container()->get( Automattic\WooCommerce\Blocks\Domain\Services\CheckoutFields::class );
// $value = $checkout_fields->get_field_from_object( 'my-store/how-did-you-hear', $order, 'other' );

// Classic checkout: add the field with the woocommerce_checkout_fields filter.
add_filter( 'woocommerce_checkout_fields', 'my_store_how_did_you_hear_add_classic_field' );
function my_store_how_did_you_hear_add_classic_field( $fields ) {
	$field = array(
		'type'     => 'select',
		'label'    => 'How did you hear about us?',
		'required' => false,
		'class'    => array( 'form-row-wide' ),
		'options'  => array(
			'' => 'Select an option',
			'google' => 'Google',
			'instagram' => 'Instagram',
			'a-friend' => 'A friend',
			'other' => 'Other',
		),
	);
	$fields['order']['my_store_how_did_you_hear'] = $field;
	return $fields;
}

// Save it to the order (HPOS-compatible: uses the order object, not post meta).
add_action( 'woocommerce_checkout_create_order', 'my_store_how_did_you_hear_save_classic_field', 10, 2 );
function my_store_how_did_you_hear_save_classic_field( $order, $data ) {
	if ( isset( $data['my_store_how_did_you_hear'] ) && '' !== $data['my_store_how_did_you_hear'] ) {
		$order->update_meta_data( '_my_store_how_did_you_hear', $data['my_store_how_did_you_hear'] );
	}
}

function my_store_how_did_you_hear_label( $value ) {
	$options = array(
		'google' => 'Google',
		'instagram' => 'Instagram',
		'a-friend' => 'A friend',
		'other' => 'Other',
	);
	return isset( $options[ $value ] ) ? $options[ $value ] : $value;
}

// Show it on the order edit screen.
add_action( 'woocommerce_admin_order_data_after_billing_address', 'my_store_how_did_you_hear_show_in_admin' );
function my_store_how_did_you_hear_show_in_admin( $order ) {
	foreach ( array( '_my_store_how_did_you_hear' => 'How did you hear about us?' ) as $meta_key => $title ) {
		$value = my_store_how_did_you_hear_label( $order->get_meta( $meta_key ) );
		if ( '' !== (string) $value ) {
			echo '<p><strong>' . esc_html( $title ) . ':</strong> ' . esc_html( $value ) . '</p>';
		}
	}
}

// Add it to order emails.
add_filter( 'woocommerce_email_order_meta_fields', 'my_store_how_did_you_hear_add_to_emails', 10, 3 );
function my_store_how_did_you_hear_add_to_emails( $fields, $sent_to_admin, $order ) {
	foreach ( array( '_my_store_how_did_you_hear' => 'How did you hear about us?' ) as $meta_key => $title ) {
		$value = my_store_how_did_you_hear_label( $order->get_meta( $meta_key ) );
		if ( '' !== (string) $value ) {
			$fields[ $meta_key ] = array(
				'label' => $title,
				'value' => esc_html( $value ),
			);
		}
	}
	return $fields;
}