JSM's Screenshot Machine Shortcode

Description

Shortcode to include images from Screenshot Machine in your content.

Use the ssm shortcode in your content with the following arguments:

  • key="{customer key}"
  • url="{url}"
  • dimension="{width x height}" (default is 120×90)
  • device="{desktop|phone|tablet}" (default is desktop)
  • format="{jpg|png|gif}" (default is jpg)
  • days="{cache expiration}" (default is 14)
  • wait="{wait in ms}" (default is 200)
  • title="{href title}"
  • link="{yes|no}" (default is yes)
  • target="{frame name}" (default is _blank)
  • refresh="{yes|no}" (default is yes)

You can find the {customer key} on your Screenshot Machine customer profile.

The {url} is the web page URL you want to capture in the screenshot.

Example dimension values:

  • 320x240 – screenshot size 320×240 pixels
  • 800x600 – screenshot size 800×600 pixels
  • 1024x768 – screenshot size 1024×768 pixels
  • 1920x1080 – screenshot size 1920×1080 pixels
  • 1024xfull – full page screenshot with width equals to 1024 pixels (can be pretty long)

Example device and dimension values:

  • device="desktop" and dimension="1024x768" – desktop screenshot with size 1024×768 pixels
  • device="phone" and dimension="480x800" – mobile phone screenshot with size 480×800 pixels
  • device="tablet" and dimension="800x1280" – tablet screenshot with size 800×1280 pixels

The format {jpeg|png|gif} is an image format to use for the screenshot (default is jpg).

The {cache expiration} is a number of days a screenshot should be used before a new one is created (default is 14).

The {wait in ms} is a number of milliseconds to wait before capturing the screenshot (default is 200).

The {href title} is a title text for the image alt and title attributes.

The link {yes|no} value will determine if the image is linked to the web page URL or not.

The target {frame name} default value opens the link in a new window/tab. An empty string, “_self”, “_top”, “_parent”, or an HTML frame name are also valid values.

The refresh {yes|no} value includes javascript to retry the image every second until it’s available (for a maximum of 10 seconds).

Example shortcode:

[ssm key="abc123" url="https://google.com/" dimension="800x600"]

Additional Documentation

  • None

Installation

Automated Install

  1. Go to the wp-admin/ section of your website.
  2. Select the Plugins menu item.
  3. Select the Add New sub-menu item.
  4. In the Search box, enter the plugin name.
  5. Click the Search Plugins button.
  6. Click the Install Now link for the plugin.
  7. Click the Activate Plugin link.

Semi-Automated Install

  1. Download the plugin ZIP file.
  2. Go to the wp-admin/ section of your website.
  3. Select the Plugins menu item.
  4. Select the Add New sub-menu item.
  5. Click on Upload link (just under the Install Plugins page title).
  6. Click the Browse… button.
  7. Navigate your local folders / directories and choose the ZIP file you downloaded previously.
  8. Click on the Install Now button.
  9. Click the Activate Plugin link.

FAQ

Frequently Asked Questions

  • None
Installation Instructions

Automated Install

  1. Go to the wp-admin/ section of your website.
  2. Select the Plugins menu item.
  3. Select the Add New sub-menu item.
  4. In the Search box, enter the plugin name.
  5. Click the Search Plugins button.
  6. Click the Install Now link for the plugin.
  7. Click the Activate Plugin link.

Semi-Automated Install

  1. Download the plugin ZIP file.
  2. Go to the wp-admin/ section of your website.
  3. Select the Plugins menu item.
  4. Select the Add New sub-menu item.
  5. Click on Upload link (just under the Install Plugins page title).
  6. Click the Browse… button.
  7. Navigate your local folders / directories and choose the ZIP file you downloaded previously.
  8. Click on the Install Now button.
  9. Click the Activate Plugin link.

Contributors & Developers

“JSM's Screenshot Machine Shortcode” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

Repositories

Version Numbering

Version components: {major}.{minor}.{bugfix}[-{stage}.{level}]

  • {major} = Major structural code changes / re-writes or incompatible API changes.
  • {minor} = New functionality was added or improved in a backwards-compatible manner.
  • {bugfix} = Backwards-compatible bug fixes or small improvements.
  • {stage}.{level} = Pre-production release: dev < a (alpha) < b (beta) < rc (release candidate).

Changelog / Release Notes

Version 2.0.0 (2017/09/24)

  • New Features
    • None
  • Improvements
    • Added support for the new “dimension” argument.
    • Deprecated the “size” argument — older size values are converted to dimension values for backwards compatibility.
  • Bugfixes
    • None
  • Developer Notes
    • None