Automattic\WooCommerce\Internal\StockNotifications\Utilities

UtmHelper::add_email_utm_params │ public static │ WC 1.0

Append the standard email UTM parameters to a URL.

Method of the class: UtmHelper{}

No Hooks.

Returns

String.

Usage

$result = UtmHelper::add_email_utm_params( $url, $medium ): string;

$url(string) (required)

The URL to annotate.

$medium(string)

The UTM medium (defaults to email).
Default: self::UTM_MEDIUM_EMAIL

UtmHelper::add_email_utm_params() UtmHelper::add email utm params code ^{WC 10.9.1}

public static function add_email_utm_params( string $url, string $medium = self::UTM_MEDIUM_EMAIL ): string {
	if ( empty( $url ) ) {
		return $url;
	}

	// Defensive: lock down the medium to a safe URL-friendly slug, falling back to the default
	// if sanitization strips everything. Prevents any future caller from piping user-controlled
	// input into the outbound tracking URL.
	$sanitized_medium = sanitize_key( $medium );
	if ( '' === $sanitized_medium ) {
		$sanitized_medium = self::UTM_MEDIUM_EMAIL;
	}

	return add_query_arg(
		array(
			'utm_source' => self::UTM_SOURCE,
			'utm_medium' => $sanitized_medium,
		),
		$url
	);
}