{"id":24801363,"url":"https://github.com/urlbox/wordpress-screenshots","last_synced_at":"2026-01-31T21:39:57.672Z","repository":{"id":43416178,"uuid":"70984354","full_name":"urlbox/wordpress-screenshots","owner":"urlbox","description":"A wordpress plugin to add website screenshots to your wordpress site","archived":false,"fork":false,"pushed_at":"2024-10-14T13:16:36.000Z","size":4583,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-13T02:32:16.164Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/urlbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-10-15T11:38:59.000Z","updated_at":"2024-10-14T12:02:32.000Z","dependencies_parsed_at":"2024-07-22T10:04:21.980Z","dependency_job_id":"eaf3a5de-e8b5-40f1-b0ed-9d73443e40e6","html_url":"https://github.com/urlbox/wordpress-screenshots","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/urlbox/wordpress-screenshots","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urlbox%2Fwordpress-screenshots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urlbox%2Fwordpress-screenshots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urlbox%2Fwordpress-screenshots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urlbox%2Fwordpress-screenshots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/urlbox","download_url":"https://codeload.github.com/urlbox/wordpress-screenshots/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urlbox%2Fwordpress-screenshots/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28956511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T18:30:42.805Z","status":"ssl_error","status_checked_at":"2026-01-31T18:30:19.593Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-30T04:28:22.631Z","updated_at":"2026-01-31T21:39:57.654Z","avatar_url":"https://github.com/urlbox.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Urlbox WordPress Screenshots\r\n\r\n🎉 Easily display screenshots of websites right in your WordPress site 🎉\r\n\r\nUses the [Urlbox](https://urlbox.com) API to generate website screenshots from any URL and displays them in your WordPress site using a simple shortcode.\r\n\r\nJust add the `[urlbox]` shortcode to any of your posts with the Shortcode block.\r\n\r\n## Basic Example\r\n\r\nJust use `[urlbox url=urlbox.com thumb_width=600]` in a Shortcode block.\r\n\r\nThis will generate the following screenshot:\r\n\r\n![urlbox.com](https://api.urlbox.com/v1/ca482d7e-9417-4569-90fe-80f7c5e1c781/8f949c12462f53ea3359a412f536ceb69a8ce8e8/png?url=urlbox.com\u0026thumb_width=600)\r\n\r\n## Full Page Screenshot Example\r\n\r\nAdd full_page=true to your shortcode options `[urlbox url=urlbox.com thumb_width=600 full_page=true]`\r\n\r\nAnd the resulting screenshot will look like this:\r\n\r\n![urlbox.com](https://api.urlbox.com/v1/ca482d7e-9417-4569-90fe-80f7c5e1c781/5efad4d9d0ce3b77f1ec529c8b201ad93beeb14c/png?url=urlbox.com\u0026thumb_width=600\u0026full_page=true)\r\n\r\n## What do you need\r\n\r\n- WordPress\r\n- Urlbox Account\r\n- Urlbox API key and secret\r\n\r\n[Sign up to obtain your API Key and Secret at urlbox.com](https://urlbox.com)\r\n\r\n## Usage\r\n\r\nUsing the plugin is very easy:\r\n\r\n- First activate the plugin and fill in your Urlbox.com API Key and Secret in the settings page. (Settings -\u003e Urlbox)\r\n\r\n- (Optional) Set default options for your screenshots, such as width, height, and thumbnail width on the plugin settings page.\r\n\r\n- Now when you want to display a screenshot inside a post, simply use the following shortcode in a Shortcode block:\r\n\r\n`[urlbox url=google.com] // display a screenshot of google.com `\r\n\r\n- If you want to add any extra settings, simply pass the option into the shortcode:\r\n\r\n`[urlbox url=google.com full_page=true thumbnail_width=400] // display a full_page screenshot of google, thumbnailed down to 400px wide`\r\n\r\n- The plugin wraps the `\u003cimg\u003e` element inside a `\u003cfigure\u003e` element. You can set the class of both of these elements from the settings page (which will apply to all screenshots), and also override these settings for individual screenshots by passing in the options in the shortcode:\r\n\r\n`[urlbox url=google.com div_class=my-div-class img_class=my-img-class ] // change the css classes of the elements`\r\n\r\n## Frequently asked questions\r\n\r\n- How to change options from the shortcode?\r\n\r\nPass them in like so: `[urlbox url=www.bbc.co.uk width=100]`\r\nSee the plugin settings page for all possible options\r\n\r\n## Screenshots\r\n\r\n1. Settings view\r\n   ![Settings view](https://raw.githubusercontent.com/urlbox-io/wordpress-screenshots/master/.wordpress-org/screenshot-1.png)\r\n\r\n2. Using the shortcode in a post\r\n   ![Using the shortcode in a post](https://raw.githubusercontent.com/urlbox-io/wordpress-screenshots/master/.wordpress-org/screenshot-2.png)\r\n\r\n3. Viewing the results\r\n   ![Viewing the post](https://raw.githubusercontent.com/urlbox-io/wordpress-screenshots/master/.wordpress-org/screenshot-3.png)\r\n\r\n## Known Bugs\r\n\r\n- None at this time\r\n\r\n## Changelog\r\n\r\n### 1.6.2\r\n\r\nUpdate instances of .io to .com. This includes the generated URL made by the generateUrl() method.\r\n\r\n### 1.6.1\r\n\r\nPerforms a refactor of the plugin, fixing a bug in the proxy logic, adding more documentation to docblocks, improving security issues, and decoupling proxy logic into a specific test method for the proxy connection and a generalised POST /sync method.\r\n\r\n### 1.6.0\r\n\r\nIntroduce proxy logic, so users can make urlbox screenshot requests via their proxy which is set in the plugin settings.\r\n\r\n### 1.5.4 \r\n\r\nFixes minor bug introduced in 1.5.3 - Checkbox state wasn't held in settings.\r\n\r\n### 1.5.3 \r\n\r\nUpdates shortcode logic to allow an 'alt' attribute in the \u003cimg\u003e tag\r\n\r\n### 1.5.2\r\n\r\nUpdated shortcode logic to allow all Urlbox API options\r\n\r\n### 1.5.1\r\n\r\nUpdated HTML output and instructions for the block editor; tested with WordPress 5.9\r\n\r\n### 1.5\r\n\r\nFixed minor bugs and tested with Wordpress 5.7-beta\r\n\r\n### 1.0\r\n\r\nInitial Release\r\n\r\n## Upgrade Notice\r\n\r\n### 1.5\r\n\r\nFixed minor bugs and tested with Wordpress 5.7-beta\r\n\r\n### 1.0\r\n\r\nInitial Release!\r\n\r\n## Testing\r\n\r\nThere are two ways to test the plugin easily, one with the wordpress playground, and the other using wp-env.\r\n\r\nTo install wp env make sure you have Node installed and Docker. Make sure docker is running!\r\n\r\nInstall: `npm -g i @wordpress/env`\r\n\r\nwp-env uses a config file held in this directory (wp-env.json). Make sure you're in this directory in your terminal, then run:\r\n\r\n`WP_ENV_PORT=3333 wp-env start`\r\n\r\nThis will set the exposed port to 3333 instead of 8888 which some people often have in use. You can change this port to whatever you wish that is unused.\r\n\r\nYou can change wordpress and php versions by changing the wp-env.json:\r\n\r\n```JSON\r\n    \"core\": \"Wordpress/WordPress#6.0\",\r\n    \"phpVersion\": \"8.0\",\r\n```\r\n\r\nWill change to wordpress version 6.0 and PHP 8.0 on rerunning wp-env start.\r\n\r\nYou can also test the plugin by zipping it from the root file, then importing the zipped file in this playground:\r\n\r\n'''https://playground.wordpress.net/?storage=browser\u0026php=8.0\u0026wp=6.5\u0026networking=yes'''\r\n\r\nEnsure that you're on at least PHP 8, Wordpress 6.5 and you have networking enabled.\r\n\r\n## Releasing/Updating the Plugin on Wordpress\r\n\r\n[URLBox Screenshots Wordpress Plugin Homepage](https://wordpress.org/plugins/urlbox-screenshots/#developers)\r\n\r\n\r\n### Overview\r\n\r\nBy creating a new tagged release with the zipped repo, GH actions should automatically update the wordpress.org repository.\r\n\r\nWordpress uses SVN, similar to Github.\r\n\r\nThe plugin is stored centrally on their servers, so any changes need to be pushed to their server using the svn CLI (there are also GUI's).\r\n\r\nThe publicly available svn repo is available for anyone to check out. Simply go [here](https://plugins.svn.wordpress.org/urlbox-screenshots/), and you'll see the publicly available repo served by apache.\r\n\r\nNOTE - When updating to a new tag, ensure that the tag number is updated in the wordpress meta fields in both the readme.txt and the core .php file.\r\n\r\n### Steps to update manually via SVN:\r\n\r\nIf the GH actions deployment isn't working you can update the plugin manually via SVN.\r\n\r\n1. Checkout the svn repo\r\n\r\n``` svn checkout https://plugins.svn.wordpress.org/urlbox-screenshots/ ```\r\n\r\n2. Make changes from Github\r\n\r\nCopy any files which changed in the github repo into the svn repo's /trunk directory. This would typically be the readme.txt (which Wordpress uses for your readme on their website) and urlbox-screenshots.php.\r\n\r\nThe /trunk directory is the 'working' or 'dev' directory. It is where unstable releases would typically sit.\r\n\r\nNOTE - Make sure that readme.txt and urlbox-screenshots.php now includes the latest tag number.\r\n\r\n3. make a new tag by copying the trunk folder into the new tag number (use versioning major/minor/patch):\r\n\r\n``` cp /trunk /tags/1.5.3 ```\r\n\r\nCheck the svn status:\r\n\r\n``` svn status ```\r\n\r\nAny new files will have a `?` beside them, and any modified will have `M` beside them.\r\n\r\nAdd new files using:\r\n\r\n``` svn add your/filepath ```\r\n\r\n4. Finally, by committing them changes will be pushed to the remote server:\r\n\r\n``` svn commit --username=USERNAMEGOESHERE --password=PASSWORDGOESHERE ```\r\n\r\nEnsure the changes took effect by going [here](https://wordpress.org/plugins/urlbox-screenshots/#developers).\r\n\r\n#### Further resources\r\n\r\nhttps://developer.wordpress.org/plugins/wordpress-org/how-to-use-subversion/\r\n\r\nSee every publicly served github plugin - https://plugins.svn.wordpress.org/\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furlbox%2Fwordpress-screenshots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Furlbox%2Fwordpress-screenshots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furlbox%2Fwordpress-screenshots/lists"}