# REST API blocks
Contributors: spacedmonkey
Donate link: https://github.com/sponsors/spacedmonkey
Tags: blocks, gutenberg, api, wp-json, rest-api
Requires at least: 5.9
Tested up to: 6.9
Requires PHP: 7.4.0
Stable tag: 2.0.0
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
Add gutenberg blocks data into the post / page REST API endpoints.
[](https://travis-ci.com/spacedmonkey/wp-rest-blocks)
## Description
A simple plugin to add block data in json format into the rest api. Once installed, there will be two new fields added to the rest api, `has_blocks` and `blocks`.
For example output.
```
"has_blocks": true,
"block_data": [
{
"blockName": "core/image",
"attrs": {
"url": "https://www.spacedmonkey.com/wp-content/uploads/2018/12/test-image.jpg",
"alt": "Terminal de aeropuerto",
"caption": "fsfsdfdsfdssfd",
"href": "https://www.spacedmonkey.com/test-image",
"rel": "noreferrer noopener",
"linkClass": "jonny-123",
"linkTarget": "_blank",
"id": 147355,
"width": 582,
"height": 327,
"linkDestination": "attachment"
},
"innerBlocks": [
],
"innerHTML": "\nfsfsdfdsfdssfd\n",
"innerContent": [
"\nfsfsdfdsfdssfd\n"
],
"rendered": "\nfsfsdfdsfdssfd\n"
}
],
```
### Technical Notes
* Requires PHP 5.6+.
* Requires WordPress 5.5+.
* Issues and Pull requests welcome on the GitHub repository: https://github.com/spacedmonkey/wp-rest-blocks
## Development
This plugin uses `@wordpress/env` for local development and testing.
### Prerequisites
- Node.js 20+ and npm
- Docker Desktop (must be installed and running)
### Setup
1. Clone the repository
2. Install dependencies:
```bash
npm install
composer install
```
3. Start the WordPress environment:
```bash
npm run env:start
```
This will start a local WordPress instance at `http://localhost:8888` (admin: `http://localhost:8888/wp-admin` with username `admin` and password `password`)
**Note:** Docker must be running for this to work. The first time you run this, it will download WordPress and set up the database, which may take a few minutes.
### Available Commands
- `npm run env:start` - Start the WordPress environment
- `npm run env:stop` - Stop the WordPress environment
- `npm run env:reset` - Reset the environment (clean database)
- `npm run env:destroy` - Destroy the environment completely
- `npm run test:php` - Run PHPUnit tests
- `npm run test:php:multisite` - Run PHPUnit tests in multisite mode
- `npm run lint:php` - Run PHP CodeSniffer
- `npm run lint:php:fix` - Fix PHP coding standards issues automatically
### Running Tests
After starting the environment with `npm run env:start`, you can run the tests:
```bash
npm run test:php
```
For multisite tests:
```bash
npm run test:php:multisite
```
### Accessing the Site
- **Development site**: http://localhost:8888
- **Admin dashboard**: http://localhost:8888/wp-admin (admin/password)
- **Test site**: http://localhost:8889
- **Test admin**: http://localhost:8889/wp-admin (admin/password)
## Installation
### Using The WordPress Dashboard
1. Navigate to the 'Add New' in the plugins dashboard
2. Search for 'wp-rest-blocks'
3. Click 'Install Now'
4. Activate the plugin on the Plugin dashboard
### Uploading in WordPress Dashboard
1. Navigate to the 'Add New' in the plugins dashboard
2. Navigate to the 'Upload' area
3. Select `wp-rest-blocks.zip` from your computer
4. Click 'Install Now'
5. Activate the plugin in the Plugin dashboard
### Using FTP
1. Download `wp-rest-blocks.zip`
2. Extract the `wp-rest-blocks` directory to your computer
3. Upload the `wp-rest-blocks` directory to the `/wp-content/plugins/` directory
4. Activate the plugin in the Plugin dashboard
## Screenshots
1. Add fields to the rest api.
## Changelog ##
### 1.0.2 ###
* Fix issue with WordPress 6.5
* Update coding standards to WP coding standards 3.1.0
* Mark tested up to WP 6.5
### 1.0.1 ###
* Update coding standards to WP coding standards 3.0.1
* Mark tested up to WP 6.4
### 1.0.0 ###
Breaking change!
The field in the REST API is changed from `blocks` to `block_data`.
### 0.5.0 ###
* Add support for new post types added in WordPress 5.9.
### 0.4.0 ###
* Added support for block based widget, added in WordPress 5.8. Block data is added to the /wp/v2/widgets endpoint.
### 0.3.2 ###
* Update translations
### 0.3.1 ###
* Hot fix.
### 0.3.0 ###
* Improve support for block that have attributes that use query source type.
* Improve error handling for those that install this plugin without using composer.
### 0.2.1 ###
* Update dependency.
### 0.2.0 ###
* Breaking change. Field names have changed and required WordPress 5.5+
### 0.1.0 ###
* First version.
![\"Terminal](\"https://www.spacedmonkey.com/wp-content/uploads/2018/12/test-image.jpg\")