playground-plugin-admin-notice's Introduction

Playground Plugin Admin Notice

Basic example demonstrating how to display an admin notice inside the WordPress Playground.

This repository includes the plugin source code, the plugin ZIP file, the default blueprint.json, and the blueprint-override-message.json for overriding the default message.

How to use

This repository is designed for using the raw GitHub URLs to load both the plugin and the blueprint into the WordPress Playground.

WordPress Playground URLs

Loading the blueprint as URL fragment: https://playground.wordpress.net/#{"landingPage":"/wp-admin/","steps":[{"step":"installPlugin","pluginZipFile":{"resource":"url","url":"https://raw.githubusercontent.com/sejas/playground-plugin-admin-notice/main/playground-plugin-admin-notice.zip"}},{"step":"login","username":"admin","password":"password"}]}

Override notice message using site options

Display a custom message: https://playground.wordpress.net/#{"landingPage":"/wp-admin/","steps":[{"step":"setSiteOptions","options":{"playground_admin_notice":"This is a custom message."}},{"step":"installPlugin","pluginZipFile":{"resource":"url","url":"https://raw.githubusercontent.com/sejas/playground-plugin-admin-notice/main/playground-plugin-admin-notice.zip"}},{"step":"login","username":"admin","password":"password"}]}

Blueprint for displaying a custom message

{
  "landingPage": "/wp-admin/",
  "steps": [
    {
      "step": "setSiteOptions",
      "options": {
        "playground_admin_notice": "This is a custom message."
      }
    },
    {
      "step": "installPlugin",
      "pluginZipFile": {
        "resource": "url",
        "url": "https://raw.githubusercontent.com/sejas/playground-plugin-admin-notice/main/playground-plugin-admin-notice.zip"
      }
    },
    {
      "step": "login",
      "username": "admin",
      "password": "password"
    }
  ]
}