JSM's Screenshot Machine Shortcode
View the Project on GitHub jsmoriss/screenshot-machine-shortcode
Plugin Name | JSM Screenshot Machine Shortcode |
---|---|
Summary | Shortcode to include images from Screenshot Machine in your content. |
Stable Version | 2.3.0 |
Requires PHP | 7.4.33 or newer |
Requires WordPress | 5.9 or newer |
Tested Up To WordPress | 6.7.1 |
Contributors | jsmoriss |
License | GPLv3 |
Tags / Keywords | screenshot, machine, shortcode |
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 120x90)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 320x240 pixels800x600
- screenshot size 800x600 pixels1024x768
- screenshot size 1024x768 pixels1920x1080
- screenshot size 1920x1080 pixels1024xfull
- 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 1024x768 pixelsdevice="phone"
and dimension="480x800"
- mobile phone screenshot with size 480x800 pixelsdevice="tablet"
and dimension="800x1280"
- tablet screenshot with size 800x1280 pixelsThe 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"]