# Custom Handler Schema Reference This guide is for plugin developers who want to add FrontEdit support for a custom Gutenberg block. It documents the public schema contract used by custom handler plugins. Custom handlers are experimental. Build and test them on a staging site before using them on production content. ## Compatibility requirement FrontEdit saves edits by parsing and serializing the native Gutenberg block: ```js wp.blocks.parse( rawBlockContent ); wp.blocks.serialize( blocks ); ``` Before writing a handler for a non-core block, confirm that its provider has already registered the block on the editable frontend page. This registration must include the block's client-side attributes and its matching `save` implementation. ```js wp.blocks.getBlockType( 'your-namespace/your-block' ); ``` The command must return a block definition. If it returns `undefined`, do not add a FrontEdit handler yet. An editor-only provider script is not compatible with FrontEdit and must not be enqueued from a custom handler. Loading an editor-only bundle on the frontend can cause fatal errors, missing browser dependencies, or serialized content that loses provider settings. Core WordPress blocks are registered by FrontEdit. For a custom or third-party block, the block provider is responsible for the compatible frontend registration surface. ## Create a custom handler plugin Copy the `templates/frontedit-live-block-editor-custom-handlers` folder shipped with FrontEdit into `wp-content/plugins`, rename it, and activate it. Its bootstrap registers a PHP handler file through the `mwpsfe_external_handler_files` filter. Handler classes use the `MWPSFE` namespace and extend FrontEdit's public abstract handler classes. Give every PHP class a unique name. A handler ID that matches a built-in ID intentionally replaces that built-in registration. An edit handler normally extends `MWPSFE_Abstract_Text_Edit_Handler` and implements `MWPSFE_Schema_Handler_Interface`. Pair it with a comment handler only when you want the block to support FrontEdit comments. ## Minimal edit handler ```php class My_Plugin_Handler_Notice extends MWPSFE_Abstract_Text_Edit_Handler implements MWPSFE_Schema_Handler_Interface { public function id() { return 'my_plugin_notice'; } public function title() { return 'Edit Notice'; } public function element_type() { return 'Notice'; } public function element_type_code() { return 'my-plugin-notice'; } public function description() { return 'Edit this notice.'; } public function call_to_action() { return 'Click to edit this notice.'; } public function get_supported_blocks() { return array( 'my-plugin/notice' ); } public function get_schema_definition() { return array( 'version' => 1, 'block' => array( 'name' => 'my-plugin/notice', 'type' => 'text', ), 'components' => array( array( 'id' => 'content', 'label' => 'Content', 'type' => 'text', 'selector' => '.my-plugin-notice__content', 'default' => true, 'required' => true, 'placeholder' => 'Add content', 'bindings' => array( array( 'path' => 'content', 'source' => 'html' ), ), 'editor' => array( 'enterMode' => 'never', 'formats' => array( array( 'undo', 'redo' ), array( 'bold', 'italic' ) ), 'operations' => $this->normalize_editor_operations( array( $this->get_editor_text_rewrite_operation( 'content' ), $this->get_editor_inline_format_change_operation( 'content', array( 'bold', 'italic' ) ), ) ), ), ), ), ); } } ``` ## Schema shape Every schema has these required keys: ```php array( 'version' => 1, 'block' => array( 'name' => 'namespace/block', 'type' => 'text' ), 'components' => array(), ) ``` `block.type` is `text` or `media`. A schema may contain both text and file components when a block supports both kinds of editing. ### Optional pristine-default identity declaration Only use this declaration when a block is Gutenberg's native default writing surface and you know its exact untouched serialization: ```php 'identity' => array( 'pristineDefaultInnerHTML' => '

', ), ``` It tells FrontEdit to defer the *first* UUID assignment only while the block has no UUID or shadow UUID, no other block attributes or inner blocks, and its trimmed parsed `innerHTML` exactly matches the declared markup. This is not a general empty-content setting. Once an element has an identifier, FrontEdit will retain it—even if its content is later emptied—so existing history remains attached to that element. ### Components A component describes one editable part of the rendered block. | Key | Required | Description | | --- | --- | --- | | `id` | Yes | Unique component ID within the schema. | | `label` | Yes | Editor-facing label. | | `type` | Yes | `text` or `file`. | | `selector` | Yes | CSS selector relative to the rendered block root. Use `:scope` for the root. | | `default` | No | Selects the component opened by default. | | `required` | No | Blocks saving an empty text component. | | `placeholder` | No | Editor-only placeholder text. | | `bindings` | Text components | Maps the edited DOM value to block attributes. | | `editor` | No | Toolbar, operations, and keyboard behavior. | | `missingUI` | No | Describes an optional text node that may be absent from saved markup. | Text bindings use an attribute `path` and `source`. Use `source: 'html'` for rich text markup and `source: 'text'` for plain text. Attribute paths can be nested, for example `style.typography.textAlign`. ### Optional text components Use `missingUI` when a provider omits an optional text node until it has content. ```php 'missingUI' => array( 'mode' => 'ghost', 'mountSelector' => ':scope', 'placement' => 'append', // append or prepend 'tag' => 'p', 'attributes' => array( 'class' => 'my-plugin-notice__description' ), 'when' => array( 'path' => 'showDescription', 'equals' => true ), 'placementWhen' => array( 'path' => 'descriptionPosition', 'equals' => 'above', 'placement' => 'prepend', ), ), ``` `when` controls whether the ghost appears. `placementWhen` optionally changes its placement when an attribute matches. Both conditions use a scalar `equals` value. ### File components Use `type: 'file'` for a media replacement surface. In addition to the standard component keys, it requires a `target` object: ```php 'target' => array( 'selector' => ':self', // or a selector relative to the component root 'attribute' => 'src', 'mediaType' => 'image', ), ``` `mediaType` is one of `image`, `audio`, `video`, `file`, `image_or_video`, or `icon`. The target attribute is normally `src` or `href`. File and text components may be combined in one schema; FrontEdit switches at component scope but still serializes the complete block. ### Repeated components Use `repeat` for a component that occurs in a table, list, or another repeated structure. Grid mode declares `rowSelector` and `cellSelector`; FrontEdit then resolves `{row}` and `{column}` placeholders in binding paths. ```php 'repeat' => array( 'rowSelector' => 'tbody tr', 'cellSelector' => 'td', ), ``` Nested tree mode uses `mode: 'tree_path'`, `itemSelector`, and an optional `pathKey` (default `path`). Use it for one block that owns nested repeated text surfaces, such as a list. ### Binding sources Bindings require `path` and `source`. A path uses dot notation and may include repeat placeholders. Supported sources are: - `html` - rich inner HTML, including supported inline formatting. - `plaintext` - trimmed text without markup. - `textAlignment` - the active text alignment value. - `url` and `id` - media URL or attachment ID. - `media_type` - derives `image` or `video` from a pending media change. - `list_block` - rebuilds a complete nested list block from the live DOM. Media `url` bindings may set `resolved: true` to use WordPress-resolved attachment data. Set `value` to `width` or `height` when that resolved field is needed instead of the URL. ### Editor formats and operations `editor.formats` controls the toolbar. Supported tokens include `undo`, `redo`, `align`, `textAlignment`, `headingLevels`, `bold`, `italic`, `strikethrough`, `link`, `buttonLink`, `orderedList`, `unorderedList`, `indent`, and `outdent`. Nest tokens in an array to group them. `enterMode` may be `auto`, `always`, `never`, or `linebreak`. `linkUIMode: 'manual'` suppresses automatic link UI while a user edits an existing anchor; omit it for the default `auto` behavior. `tabMode` can use `none`, `indent`, `outdent`, `nextComponent`, or `previousComponent` for its `tab` and `shiftTab` values. `editor.options.preserveNewlines` converts `
` elements to literal newlines before saving. `newlinesToBR` does the opposite. Use only when the native block uses that representation. Use the protected helper methods on the abstract edit handler to declare the matching operations. Common helpers are: - `get_editor_text_rewrite_operation( $component_id )` - `get_editor_inline_format_change_operation( $component_id, $formats )` - `get_editor_inline_attribute_change_operation( $component_id, 'link', $capabilities )` - `get_editor_block_attribute_change_operation( $operation_id, $component_id, $capability )` Pass the completed array through `normalize_editor_operations()`. ### Attribute capabilities Declare block attributes used by toolbar operations under `editor.attributeCapabilities`. ```php 'headingLevels' => array( 'attribute' => 'level', 'values' => array( 1, 2, 3, 4, 5, 6 ), 'unsetValue' => 2, ), 'textAlignment' => array( 'attribute' => 'style.typography.textAlign', 'values' => array( 'left', 'center', 'right', 'justify' ), 'unsetValue' => 'left', ), ``` `headingLevels` is the canonical token for a heading-level or element-tag menu. For blocks whose values are tags, use values such as `h1`, `p`, and `div`, plus `tagChange: true`. The corresponding block-attribute operation will update both the declared attribute and the editable element tag. For a text-alignment capability, `preview: 'inline_style'` applies the preview through `style.textAlign` on the resolved format target. Use it only when the block's native frontend styling does not use WordPress `has-text-align-*` classes. `editor.formatTargets` can direct a toolbar operation to a selector or an object with `scope` (`component`, `block`, or `column`), `selector`, and an optional column `contextKey`. For example, use `array( 'align' => 'block' )` when block alignment belongs on the wrapper rather than the editable text node. ### Inline formatting For standard text formatting, obtain the supported format declarations with: ```php $inline_format_capabilities = $this->get_inline_format_capabilities( array( 'bold', 'italic', 'strikethrough', 'link' ) ); ``` Attach that value to `editor.inlineFormatCapabilities` and create matching inline-format and link operations. ## Validation checklist Before publishing a handler, verify all of the following on the frontend: 1. `wp.blocks.getBlockType( blockName )` returns the provider block definition. 2. Parsing then serializing an unchanged saved block preserves the block and its unrelated attributes. 3. Each text, media, attribute, and inline-format operation saves correctly. 4. Optional components materialize only under their declared conditions. 5. A provider update has not changed the saved markup, attributes, or `save` behavior your handler relies on. If any compatibility check fails, disable or defer the handler rather than editing rendered HTML directly. FrontEdit custom handlers always use Gutenberg's native block serialization path. Destinations – Aliancy Travels
Inquire Now

Destinations

Top Destinations

Discover the Many Faces of Sri Lanka

Sri Lanka may be a small island but it is overflowing with diverse and breathtaking destinations. From sun-drenched beaches and misty highlands to ancient cultural capitals and lush wildlife parks, each region tells its own unique story. This page is your starting point to explore the distinct character and must-see sights of each area.

We want to help you move beyond the map and truly connect with the soul of each place. Whether you dream of the historic grandeur of the Cultural Triangle, the relaxed surf vibe of Arugam Bay, or the cool climate of Ella’s tea country, we have the local knowledge to guide you.

Let us help you craft the perfect itinerary that blends iconic landmarks with hidden local gems. Your journey through this incredible island paradise begins with choosing your destinations.

Chat with Us

Leisure & Beaches: Where Every Sunset Feels Like a Celebration

Imagine the gentle rhythm of the Indian Ocean and the feeling of warm, golden sand beneath your feet. Sri Lanka’s coastline is a tapestry of vibrant beach towns and hidden coves, each offering its own unique charm. This is your invitation to unwind and embrace the art of doing nothing at all.

Whether you seek the lively energy of a popular resort town or the serene seclusion of a quiet bay, we know the perfect spot for you. Our island’s shores are a place to reconnect, relax, and be fully present in the moment. Let us guide you to your own perfect stretch of paradise, where every sunset truly feels like a celebration.

Bentota (West Coast)

Bentota is a lively coastal town perfect for families and adventure seekers. Its golden sands are lined with luxury resorts and offer a huge range of fun water sports for all ages. It is the ideal spot for those who want both relaxation and activity right at their doorstep.

Galle & Unawatuna Beach (South Coast)

This area beautifully blends rich history with stunning tropical relaxation. Explore the charming cobblestone streets of the historic Galle Fort, a UNESCO World Heritage site. Then, unwind on the palm-fringed crescent of Unawatuna Beach for the perfect mix of culture and leisure.

Mirissa - Whale Watching & Sunset Cruises

Mirissa is famously known as the best place in Sri Lanka for blue whale sightings. Setting sail to see these gentle giants is a truly awe-inspiring and humbling experience. The pristine shores also offer unforgettable sunset cruises to celebrate the sunset.

Polhena (South Coast, Matara)

Polhena is a hidden gem for families, featuring a protected lagoon with calm, shallow waters. This natural reef pool is absolutely ideal for safe swimming and beginner snorkeling right from the shore. It is a peaceful and relaxing spot away from the larger crowds.

Trincomalee (East Coast)

This historic port city is blessed with some of the island’s most stunning turquoise waters and golden beaches. It is the main gateway for incredible snorkeling and diving excursions to the coral gardens of Pigeon Island. History and natural beauty come together here perfectly.

Arugam Bay (East Coast)

Arugam Bay is a world-renowned surfing destination with a famously laid-back bohemian vibe. While surfers ride the famous point break, the area also offers scenic lagoons for more gentle exploration. It is the ultimate chill-out spot for travelers and wave enthusiasts.

Nilaveli (East Coast)

Nilaveli offers a tranquil escape with its long stretch of pristine white-sand beach. Its proximity to Pigeon Island makes it a perfect base for fantastic  snorkeling adventures. This is the place for a truly quiet and peaceful coastal getaway.

Passikudah (East Coast)

Passikudah is famous for its incredibly shallow and calm waters that stretch for kilometers. This makes it absolutely ideal for families with young children and for relaxed swimming. The bay is a giant, natural wading pool with a gentle, welcoming feel.

Uppuveli (East Coast)

Uppuveli is a serene coastal retreat located just north of Trincomalee. It offers beautiful coral reefs for snorkeling and a line of peaceful resorts away from the crowds. This is the perfect destination for travelers seeking a quieter, more laid-back beach experience.

Dickwella (South Coast)

Dickwella boasts a long and beautifully unspoiled sandy beach that sees far fewer tourists. It is an ideal destination for leisurely walks, peaceful sunbathing, and authentic local encounters. This hidden gem offers a genuine slice of coastal life.

Adventure & Discovery: Turn Curiosity into Adventure, One Journey at a Time

For those who hear the call of the wild, Sri Lanka offers a playground of endless adventure. Trek through the misty highlands of Horton Plains to the dramatic cliff edge of World’s End, or challenge yourself to scale Ella Rock for breathtaking views over tea plantations. Seek the thrill of spotting a leopard on a safari in Yala National Park or witness herds of elephants roaming freely in Udawalawe National Park.

Answer the call of the river with exhilarating white-water rafting in Kitulgala, surrounded by lush jungle scenery and hidden waterfalls. Each destination promises a new way to push your boundaries and connect with the raw, untamed spirit of the island. Let us guide you beyond the horizon and into the heart of discovery, where every journey sparks a new story.

Ella

This charming mountain town is a hiker’s paradise, famous for the climbs up Ella Rock and Little Adam’s Peak. The trails wind through lush green tea plantations and lead to some of the island’s most breathtaking viewpoints. It’s the perfect place to enjoy a cool climate and stunning highland scenery.

Horton Plains & World’s End

Embark on a memorable trek across misty highland plains to the dramatic cliff edge known as World’s End. The hike offers panoramic vistas that are absolutely ideal for photography and peaceful nature walks. This unique, windswept landscape feels like another world entirely.

Kitulgala

Calling all thrill-seekers to this adventure hub set in lush jungle scenery. The main draw here is exhilarating white-water rafting on the Kelani River. You can also find fantastic waterfall adventures and challenging jungle hikes for a full day of excitement.

Yala National Park

Embark on an exciting safari adventure in Sri Lanka’s most famous wildlife park. The biggest thrill is the chance to spot the elusive leopard in its natural habitat. The park is also home to herds of elephants and a spectacular variety of exotic birds.

Udawalawe National Park

This park offers an incredible opportunity to observe elephants in their natural environment. Unlike other parks, the open landscapes make it easy to see entire herds bathing, feeding, and socializing. It is one of the best places in the world for guaranteed and ethical elephant encounters.

Culture & Heritage: Walk the Streets, Hear the Stories, Feel the Legacy

Sri Lanka’s culture is a living tapestry woven over thousands of years, waiting to share its stories with you. From the sacred halls of the Temple of the Tooth in Kandy to the ancient kingdoms of Anuradhapura and Polonnaruwa, you can truly feel the weight and wonder of history all around you. This is a journey through time, where every stone has a tale to tell.

Walk in the footsteps of kings and monks through UNESCO World Heritage sites, explore the colonial charm of Galle Fort, and witness timeless traditional ceremonies. We connect you to the soul of the island, offering deep, authentic experiences that go beyond the guidebooks. Come listen to the whispers of the past and feel the enduring legacy of this incredible island.

Kandy

Nestled among misty hills, Kandy is the vibrant cultural heart of the island. It is most famous as the home of the sacred Temple of the Tooth, a site of immense spiritual significance. The city beautifully blends devotion with natural beauty, centered around the serene Kandy Lake and bursting with color during its famed cultural festivals.

Sigiriya & Dambulla

This area is a UNESCO-listed treasure trove of ancient wonders. Marvel at the breathtaking Sigiriya Rock Fortress, an astonishing feat of engineering and art. Just a short drive away, explore the magnificent cave temples of Dambulla, adorned with intricate Buddhist murals and statues.

Polonnaruwa

Step back in time as you explore the magnificent ruins of the medieval kingdom of Polonnaruwa. This ancient city allows you to wander among well-preserved royal palaces, majestic ancient ruins, and serene stone statues. Cycling through the archaeological park is a truly immersive historical experience.

Anuradhapura

Journey to Anuradhapura, one of the world’s oldest continuously inhabited capitals and a sacred city. This vast archaeological site is home to immense, bell-shaped stupas and ancient monastic complexes. Its heart is the sacred Bo Tree, grown from a cutting of the original tree under which Buddha attained enlightenment.

Galle

Discover the unique charm of Galle, where colonial history meets modern tropical life. Explore the cobblestone streets within the 17th-century Galle Fort, a UNESCO World Heritage site. The fort is a living museum, boasting charming cafes, boutique shops, historic museums, and a iconic lighthouse overlooking the ocean.

Nature & Scenic Beauty: From Misty Highlands to Hidden Valleys, Nature Awaits

Sri Lanka’s landscapes feel like they were painted by nature’s own brush, offering some of the most breathtaking scenery in the world. From the cool, misty highlands draped in emerald tea plantations to the secluded hidden valleys of the Knuckles Range, the island is a living tapestry of natural wonders. This is where adventure and tranquility meet under endless skies.

Whether you’re drawn to the dramatic cliffs of Horton Plains, the rich biodiversity of Sinharaja Rainforest, or the serene beauty of a secluded waterfall, we’ll guide you to moments of pure awe. Let us help you explore these untouched masterpieces and create memories surrounded by the unparalleled beauty of Sri Lanka’s great outdoors.

Nuwara Eliya

Escape to the cool, misty highlands of Nuwara Eliya, often called “Little England” for its charming colonial vibe. The town is beautifully surrounded by rolling tea plantations, serene misty mountains, and the picturesque Gregory Lake. It’s the perfect retreat for those seeking a tranquil atmosphere and stunning, temperate landscapes.

Sinharaja Rainforest

Step into a living biodiversity museum at the Sinharaja Rainforest, a pristine UNESCO World Heritage site. This dense, virgin rainforest is incredibly rich in wildlife and is a sanctuary for endemic birds and exotic tropical flora. A walk here is a truly immersive experience into Sri Lanka’s ancient ecological heart.

Horton Plains (beyond World’s End)

Discover the quieter, ethereal beauty of Horton Plains beyond its famous cliff edge. This national park features vast rolling grasslands, misty hills, and quiet hidden streams perfect for peaceful contemplation. It is an exceptional destination for serene nature walks and stunning landscape photography.

Kitulgala Forest Trails (non-adventure)

Experience the calm side of Kitulgala by exploring its peaceful forest trails. Wander through lush tropical forests alongside gentle streams, making it a paradise for birdwatching and quiet reflection. This area offers a wonderfully tranquil experience for nature enthusiasts seeking a gentle escape.

Knuckles Mountain Range Valleys & Streams

Step into a living biodiversity museum at the Sinharaja Rainforest, a pristine UNESCO World Heritage site. This dense, virgin rainforest is incredibly rich in wildlife and is a sanctuary for endemic birds and exotic tropical flora. A walk here is a truly immersive experience into Sri Lanka’s ancient ecological heart.

Wellness & Lifestyle: Recharge, Reflect, and Rediscover Your Best Self

True travel nourishes more than just your passport stamps; it rejuvenates your mind, body, and spirit. Sri Lanka’s serene landscapes provide the perfect sanctuary to pause and reconnect with yourself. We believe in journeys that restore your natural balance and inner peace.

From the ancient science of Ayurveda to sunrise yoga on silent beaches, we curate experiences that promote deep wellness. Whether in a misty mountain retreat or a coastal spa, find a space to recharge, reflect, and rediscover your best self. This is travel that transforms, leaving you renewed long after you return home.

Bentota

Indulge in complete rejuvenation at the luxury beach resorts in Bentota. Pamper yourself with authentic Ayurvedic spa treatments and gentle river cruises designed for deep relaxation. These holistic wellness programs are crafted to restore your balance and inner peace.

Passikudah

Find your center in Passikudah, where the shallow, calm waters create a naturally serene atmosphere. The seaside resorts here specialize in wellness-focused leisure, offering daily yoga and meditation sessions right on the beach. It is the ideal setting for a truly restorative escape.

Uppuveli

Discover a hidden sanctuary for wellbeing on the East Coast in Uppuveli. This peaceful destination is known for secluded resorts that offer sunrise yoga and expert spa therapies. The emphasis is on tranquil coastal relaxation, far from the crowds.

Belihuloya

Reconnect with nature at the riverside eco-resorts in Belihuloya. This unique retreat offers nature-based wellness and mindfulness programs surrounded by soothing sounds of the river and forest. It is the perfect peaceful retreat for a digital detox and inner calm.

Hakgala

Experience the revitalizing power of mountain air in Hakgala. High-altitude wellness lodges here use the cool climate, lush gardens, and fresh air as the foundation for their restorative wellness programs. It is a perfect serene getaway, especially for British tourists seeking a refreshing change of pace.

Get a Quote

Our local experts are available 24/7 to assist you whenever you need

What Our Travelers Say

Discover why travelers from around the world choose Aliancy Travels for their Sri Lankan adventures

“Avinra Travels made our Sri Lankan adventure absolutely magical! From the ancient temples of Anuradhapura to the pristine beaches of Mirissa, every moment was perfectly curated. Our guide was incredibly knowledgeable and passionate about sharing the beauty of his homeland.

Sarah Mitchell

United Kingdom

“Avinra Travels made our Sri Lankan adventure absolutely magical! From the ancient temples of Anuradhapura to the pristine beaches of Mirissa, every moment was perfectly curated. Our guide was incredibly knowledgeable and passionate about sharing the beauty of his homeland.

Sarah Mitchell

United Kingdom

“Avinra Travels made our Sri Lankan adventure absolutely magical! From the ancient temples of Anuradhapura to the pristine beaches of Mirissa, every moment was perfectly curated. Our guide was incredibly knowledgeable and passionate about sharing the beauty of his homeland.

Sarah Mitchell

United Kingdom

“Avinra Travels made our Sri Lankan adventure absolutely magical! From the ancient temples of Anuradhapura to the pristine beaches of Mirissa, every moment was perfectly curated. Our guide was incredibly knowledgeable and passionate about sharing the beauty of his homeland.

Sarah Mitchell

United Kingdom