Signature

$url = apply_filters( 'mam_universal_link_get_branch_link', $campaign, $channel, $feature, $stage, $data );

Returns the Branch URL (string), or '' when no Branch key is configured or the API call fails — always handle the empty case with a fallback URL.

Behavior

• Uses the test key when Use Test Keys is checked on the Universal Link settings page, otherwise the live key.
• Calls POST https://api2.branch.io/v1/url server-side (15 s timeout); errors are logged via the MAM debug log and return ''.
• Each call creates a fresh link (unique alias) — cache the result if you mint per-object links (the contact-invite integration caches per invite in post meta branch_invite_url).

Example

$data = array(
    'listing_id'   => $post_id,
    '$desktop_url' => get_permalink( $post_id ),
);
$link = apply_filters( 'mam_universal_link_get_branch_link', 'new_listing', 'share', null, null, $data );
if ( '' === $link ) {
    $link = get_permalink( $post_id ); // Branch unavailable — fall back
}

(MAM GeoDirectory uses exactly this shape for new-listing links.)

Related hooks

• mam_universal_link_enabled — feature-detection filter; this plugin forces it to true so other plugins (e.g. MAM GeoDirectory) know a universal-link provider is active.
• mam_invite_link (MAM Main) — this plugin consumes it to upgrade contact-invite links to Branch links automatically.

Related articles

• Set up Branch.io deep links

Metadata