Share Target

Description

By using this plugin, you can share content like images, media, URLs and text directly to your WordPress site from a capable device and browser. For example, you can share a photo that you just took on your phone to your WordPress site in the same way that you would otherwise share it with your friends in a native messaging app.

When you share content to your WordPress site using this plugin, it will automatically start a new block editor draft post with it; you can then just add anything else you like, or immediately publish it as is. For certain use-cases, e.g. an image blog, creating a post with the shared image might be everything that’s needed before publishing right away!

To name a few other examples of what you can share to your WordPress site using this plugin, think about audio and video files, short text notes, Spotify playlists – basically anything that you can share from an app on your phone you can now also share directly to your WordPress site.

Requirements

In order to use this plugin, you will also need to install and activate the PWA plugin, which provides the basic infrastructure for your site to become a PWA.

Usage

With both plugins active, once you visit your site on a capable device and browser, you should see a prompt (via the PWA plugin’s functionality) to add the plugin to your home screen (e.g. similar to an app on your phone).

Once you have added your website to the home screen of your device, it should be available as a target when sharing any content from that device, e.g. a photo or a URL.

When you share something to your WordPress site, the installed PWA of your website should open. You should then (potentially after logging in) land directly on a new post in the block editor where the shared content has already been added. If you are sharing a media file (e.g. an image or video file), it will be automatically added to your site’s media library.

Background information

This plugin is powered by the Web Share Target API. The Web Share Target API is a modern browser API which allows sharing images, media, URLs and basic text content directly to your website, relying on the regular sharing UI that is for example integrated in your phone. See here for more technical background information about the Web Share Target API.

Third-party developer API

The Share Target plugin allows other plugins to integrate with it. You can customize what should happen with incoming shared content when it arrives in the block editor, conditionally overriding the default behavior of the plugin.

In PHP, enqueue your custom JavaScript file. Make sure to include the share-target script in its dependencies. For example:

wp_enqueue_script(
  'my-share-target-handler',
  '/assets/js/my-share-target-handler.js',
  array( 'share-target' )
);

In your JavaScript file you can then add your custom share handler using the following function:

wp.shareTarget.registerShareHandler( options )

Registers a new share handler for incoming shared data.

Parameters:

• options: (Object) (required) Handler options.
• options.handle: (Function) (required) Share handler function. Must be asynchronous and accept an object with properties title, description, link (each strings), and attachment (object). Any of these may be undefined. Depending on the data, the function should decide whether to handle it and if so run the necessary logic and return true, to stop following handlers from being called. Otherwise, it should return false.
• options.priority: (number) (optional) Priority for the handler. A lower number means higher priority, like for WordPress hooks. Default is 10.

The following example handles any shared Spotify content and embeds it into the post:

// Matches a shared Spotify URL.
const spotifyRegex = /^https:\/\/open\.spotify\.com/;

wp.shareTarget.registerShareHandler( {
  handle: async ( { link, attachment } ) => {
    // Do not handle if a media file is being shared.
    if ( attachment ) {
      return false;
    }

    // If a shared Spotify URL, embed it.
    if ( link && link.match( spotifyRegex ) ) {
      wp.data.dispatch( 'core/block-editor' ).insertBlocks( [
        wp.blocks.createBlock( 'core/embed', {
          url: link,
          type: 'rich',
          providerNameSlug: 'spotify',
          responsive: true,
        } ),
      ] );
      return true;
    }

    // Otherwise fall back to other handlers.
    return false;
  },
  priority: 5,
} );

Screenshots

Installation

Make sure you have the PWA plugin installed before using the Share Target plugin.

1. Upload the entire share-target folder to the /wp-content/plugins/ directory or download it through the WordPress backend.
2. Activate the plugin through the ‘Plugins’ menu in WordPress.

FAQ

Why does my website not show up as a target for shared content?

In order for your website to show up in your device’s integrated sharing UI, you need to install your website as a PWA on your device. Make sure to use a browser and OS that supports adding your website as a PWA to your homescreen.

Where should I submit my support request?

For regular support requests, please use the www.ads-software.com support forums. If you have a technical issue with the plugin where you already have more insight on how to fix it, you can also open an issue on Github instead.

How can I contribute to the plugin?

If you have some ideas to improve the plugin or to solve a bug, feel free to raise an issue or submit a pull request in the Github repository for the plugin. Please stick to the contributing guidelines.

You can also contribute to the plugin by translating it. Simply visit translate.www.ads-software.com to get started.

Reviews

Contributors & Developers

Changelog

1.0.0-beta.1

• Initial beta release