JamFrame (Featured & Social Images)

By jamframe

0+ active installationsVersion 1.0.0

Make featured images and social sharing images for every post from your JamFrame template. Add rendered templates with a block or shortcode.

Description

Design an image template once in JamFrame, then let this plugin make an image for every post: the title, excerpt, author, date, categories, featured image or any custom field fill the template, and the result becomes the post’s featured image, its social sharing image (og:image), or both.

  • Automatic images. When a post is published or updated, its image is made in the background, so saving never waits. Nothing is made again unless something used in the image changed.
  • Per post type. Choose for each post type whether the image becomes the featured image, the social sharing image, or both.
  • Plays nicely with SEO plugins. With Yoast SEO or Rank Math, their social image is replaced with yours, so your pages keep a single og:image tag. Without an SEO plugin, the plugin adds the og:image and twitter:image tags itself.
  • In the editor. A “JamFrame” box shows the post’s image, with “Regenerate” and “Off for this post”.
  • Block and shortcode. Add an image rendered from any template, with your own text: the “JamFrame image” block, or [jamframe template="TEMPLATE_ID" title="Hello"]. Each image is copied into your media library, so it is rendered once.
  • Your featured images are safe. By default the plugin only fills posts that have no featured image, and keeps its own images up to date.

You need a JamFrame account and an API key. Each image uses one render credit from your JamFrame plan.

External services

This plugin connects to the JamFrame API (https://api.jamframe.com/v1 by default, or the API URL set in Settings → JamFrame) to list your templates and render images. It is needed for everything the plugin does.

  • When: when you open Settings → JamFrame or test the connection (your templates and their parameters are listed); when a post of an enabled post type is published or updated and something used in its image changed, or you click “Regenerate” (a render); when a page with a JamFrame block or shortcode is shown for the first time with given values (a signed image link is created, and the image is then rendered and saved to your media library).
  • What is sent: your API key (in the Authorization header, from your server only, never in pages), the template id, and the values mapped into the template: by your settings, for example the post’s title, excerpt, author name, date, categories, tags, featured image URL, link, site name or the custom fields you choose. Block and shortcode images send the values you typed. Your site’s address is sent in the User-Agent header.
  • In your pages: until a block or shortcode image has been copied into your media library, the page shows it from a signed JamFrame link (it contains the template id and the values, signed, and no API key), so visitors’ browsers load that image from JamFrame.

The service is provided by JamFrame: Terms of Service, Privacy Policy.

Installation

  1. Install and activate the plugin.
  2. In JamFrame, open API keys and create a key.
  3. In WordPress, open Settings → JamFrame, paste the key and click Test connection, then Save Changes.
  4. Choose the Template for automatic images and save again.
  5. Map the template’s parameters to post fields (for example title → Title, author → Author), choose the post types and whether the image becomes the featured image, the social sharing image or both, and save.
  6. Publish or update a post: its image appears a moment later in the JamFrame box of the post editor.

FAQ

Does saving a post wait for the image?

No. The image is made in the background with WP-Cron right after the save. On sites with WP-Cron turned off (DISABLE_WP_CRON), it is made when your server’s cron runs wp-cron.php.

I use Yoast SEO or Rank Math. Will I get two og:image tags?

No. While either is active, this plugin prints no Open Graph tags of its own: it only replaces the SEO plugin’s social image with the generated one. Make sure the SEO plugin’s social (Open Graph) tags are turned on, or the page will have no og:image.

Will it replace a featured image I chose?

Not unless you turn on “Replace featured images I chose myself”. Otherwise it only fills posts without a featured image and updates images it made itself.

Which shortcode attributes can I use?

template (required: the template id, shown in JamFrame’s editor under API), alt, format (png, jpeg or webp), class, and any template parameter by name: [jamframe template="clx8m2k3p0001" title="Summer sale" subtitle="Up to 50% off"]. WordPress makes attribute names lowercase, so give template parameters lowercase names, or use the block.

How do I make images for posts published before I installed the plugin?

Open the post and click “Regenerate”, or update it. Each post gets its image the next time it is saved.

What happens when I uninstall the plugin?

Its settings, caches and scheduled jobs are removed. Images it made stay in your media library, as they may still be in use.

Screenshots

Changelog

1.0.0

  • First release: automatic featured and social sharing images, Yoast SEO and Rank Math support, the editor box, the block and the shortcode.