Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/BWibrew/WP-Site-Monitor

A WordPress plugin to extend the WP REST API to help manage sites remotely.
https://github.com/BWibrew/WP-Site-Monitor

rest-api wordpress wordpress-plugin wordpress-rest-api

Last synced: about 1 month ago
JSON representation

A WordPress plugin to extend the WP REST API to help manage sites remotely.

Awesome Lists containing this project

README

        

# WP REST API endpoints to help manage sites remotely

[![Build Status](https://img.shields.io/travis/BWibrew/WP-Site-Monitor.svg?branch=master&style=flat-square)](https://travis-ci.org/BWibrew/WP-Site-Monitor)
[![StyleCI](https://styleci.io/repos/100482455/shield?branch=master)](https://styleci.io/repos/100482455)
[![Scrutinizer](https://img.shields.io/scrutinizer/g/BWibrew/WP-Site-Monitor.svg?style=flat-square)](https://scrutinizer-ci.com/g/BWibrew/WP-Site-Monitor)
[![Scrutinizer Coverage](https://img.shields.io/scrutinizer/coverage/g/BWibrew/WP-Site-Monitor.svg?style=flat-square)](https://scrutinizer-ci.com/g/BWibrew/WP-Site-Monitor)

All additional endpoints are under the `wp-site-monitor/v1/` namespace.
e.g. `https://example.com/wp-json/wp-site-monitor/v1/wp-version`

## Additional endpoints
- `wp-version` returns the current version of wordpress as a string.

Example output: `"4.9.2"`
- `plugins` returns a JSON object listing installed plugins with the plugin details.

Example output:
```json
{
"wp-super-cache/wp-cache.php": {
"Name": "WP Super Cache",
"PluginURI": "https://wordpress.org/plugins/wp-super-cache/",
"Version": "1.5.9",
"Description": "Very fast caching plugin for WordPress.",
"Author": "Automattic",
"AuthorURI": "https://automattic.com/",
"TextDomain": "wp-super-cache",
"DomainPath": "",
"Network": false,
"Title": "WP Super Cache",
"AuthorName": "Automattic",
"Active": true
},
"wordpress-seo/wp-seo.php": {
"Name": "Yoast SEO",
"PluginURI": "https://yoa.st/1uj",
"Version": "6.1.1",
"Description": "The first true all-in-one SEO solution for WordPress, including on-page content analysis, XML sitemaps and much more.",
"Author": "Team Yoast",
"AuthorURI": "https://yoa.st/1uk",
"TextDomain": "wordpress-seo",
"DomainPath": "/languages/",
"Network": false,
"Title": "Yoast SEO",
"AuthorName": "Team Yoast",
"Active": true
}
}
```

Options are provided in the WP Site Monitor settings menu to toggle individual endpoints.

## Installation

1. Upload the plugin files to the `/wp-content/plugins/wp-site-monitor` directory, or install the plugin through the
WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Use the Settings->WP Site Monitor screen to configure the plugin.

## Frequently Asked Questions
### How does authentication work with this plugin?
Because this plugin just extends the official REST API, you can use any authentication method the REST API supports.
You may want to use a another plugin to add extra authentication methods such as
[WordPress REST API – OAuth 1.0a Server](https://wordpress.org/plugins/rest-api-oauth1/) or
[JWT Authentication for WP REST API](https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/)