├── .distignore
├── .editorconfig
├── .github
├── FUNDING.yml
├── dependabot.yml
└── workflows
│ ├── continuous-integration-lint-php.yml
│ ├── deploytowp.yml
│ ├── test-unit-php.yml
│ ├── upateassets.yml
│ └── upload-asset-on-release.yml
├── .gitignore
├── .phpcs.xml.dist
├── .wordpress-org
├── banner-1544x500.png
├── banner-772x250.png
├── icon-128x128.png
├── icon-256x256.png
└── screenshot-1.png
├── Gruntfile.js
├── LICENSE
├── bin
└── install-wp-tests.sh
├── composer.json
├── languages
└── wp-rest-blocks.pot
├── package-lock.json
├── package.json
├── phpunit-multisite.xml.dist
├── phpunit.xml.dist
├── readme.md
├── src
├── data.php
├── posts.php
└── widgets.php
├── tests
├── bootstrap.php
└── test-posts.php
└── wp-rest-blocks.php
/.distignore:
--------------------------------------------------------------------------------
1 | # A set of files you probably don't want in your WordPress.org distribution
2 | .distignore
3 | .editorconfig
4 | .git
5 | .gitignore
6 | .gitlab-ci.yml
7 | .travis.yml
8 | .DS_Store
9 | .wordpress-org
10 | composer.json
11 | composer.lock
12 | Thumbs.db
13 | behat.yml
14 | bitbucket-pipelines.yml
15 | bin
16 | .circleci/config.yml
17 | .github
18 | Gruntfile.js
19 | package.json
20 | package-lock.json
21 | phpunit.xml
22 | phpunit.xml.dist
23 | phpunit-multisite.xml.dist
24 | multisite.xml
25 | multisite.xml.dist
26 | .phpcs.xml
27 | phpcs.xml
28 | .phpcs.xml.dist
29 | phpcs.xml.dist
30 | wp-cli.local.yml
31 | yarn.lock
32 | tests
33 | node_modules
34 | *.sql
35 | *.tar.gz
36 | *.zip
37 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | # This file is for unifying the coding style for different editors and IDEs
2 | # editorconfig.org
3 |
4 | # WordPress Coding Standards
5 | # https://make.wordpress.org/core/handbook/coding-standards/
6 |
7 | root = true
8 |
9 | [*]
10 | charset = utf-8
11 | end_of_line = lf
12 | insert_final_newline = true
13 | trim_trailing_whitespace = true
14 | indent_style = tab
15 | indent_size = 4
16 |
17 | [{.jshintrc,*.json,*.yml}]
18 | indent_style = space
19 | indent_size = 2
20 |
21 | [{*.txt,wp-config-sample.php}]
22 | end_of_line = crlf
23 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | github: spacedmonkey
4 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | # To get started with Dependabot version updates, you'll need to specify which
2 | # package ecosystems to update and where the package manifests are located.
3 | # Please see the documentation for all configuration options:
4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5 |
6 | version: 2
7 | updates:
8 | - package-ecosystem: composer
9 | directory: '/'
10 | schedule:
11 | interval: weekly
12 | open-pull-requests-limit: 10
13 | labels:
14 | - Dependencies
15 | - PHP
16 | - package-ecosystem: npm
17 | directory: '/'
18 | schedule:
19 | interval: weekly
20 | open-pull-requests-limit: 15
21 | labels:
22 | - Dependencies
23 | - JavaScript
24 |
--------------------------------------------------------------------------------
/.github/workflows/continuous-integration-lint-php.yml:
--------------------------------------------------------------------------------
1 | name: PHP Lints
2 |
3 | on:
4 | push:
5 | branches:
6 | - master
7 | - release/*
8 | pull_request:
9 |
10 | jobs:
11 | lint-php:
12 | runs-on: ubuntu-latest
13 | steps:
14 | - name: Checkout
15 | uses: actions/checkout@v2
16 |
17 | - name: Setup PHP
18 | uses: shivammathur/setup-php@v2
19 | with:
20 | php-version: '7.4'
21 | coverage: none
22 | tools: composer, cs2pr
23 |
24 | - name: Get Composer cache directory
25 | id: composer-cache
26 | run: echo "::set-output name=dir::$(composer config cache-files-dir)"
27 |
28 | - name: Setup Composer cache
29 | uses: pat-s/always-upload-cache@v2.1.3
30 | with:
31 | path: ${{ steps.composer-cache.outputs.dir }}
32 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
33 | restore-keys: |
34 | ${{ runner.os }}-composer-
35 | ${{ runner.os }}-
36 |
37 | - name: Validate composer.json
38 | run: composer --no-interaction validate --no-check-all
39 |
40 | - name: Install dependencies
41 | run: composer install --prefer-dist --no-suggest --no-progress --no-interaction
42 |
43 | - name: Detect coding standard violations (PHPCS)
44 | run: vendor/bin/phpcs -q --report=checkstyle --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 | cs2pr --graceful-warnings
45 |
--------------------------------------------------------------------------------
/.github/workflows/deploytowp.yml:
--------------------------------------------------------------------------------
1 | name: Deploy to WordPress.org
2 | on:
3 | push:
4 | tags:
5 | - '**'
6 | jobs:
7 | tag:
8 | name: New tag
9 | runs-on: ubuntu-latest
10 | steps:
11 | - uses: actions/checkout@main
12 |
13 | - name: Setup PHP
14 | uses: shivammathur/setup-php@v2
15 | with:
16 | php-version: '7.0'
17 | coverage: none
18 | tools: composer
19 |
20 | - name: Validate composer.json and composer.lock
21 | run: composer validate
22 |
23 | - name: Get Composer Cache Directory
24 | id: composer-cache
25 | run: echo "::set-output name=dir::$(composer config cache-files-dir)"
26 |
27 | - name: Cache Composer vendor directory
28 | uses: actions/cache@v2
29 | with:
30 | path: ${{ steps.composer-cache.outputs.dir }}
31 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
32 | restore-keys: |
33 | ${{ runner.os }}-composer-
34 |
35 | - name: Install PHP Dependencies
36 | run: composer install --prefer-dist --no-progress --no-dev --optimize-autoloader --no-interaction
37 |
38 | - name: WordPress Plugin Deploy
39 | uses: 10up/action-wordpress-plugin-deploy@stable
40 | env:
41 | SLUG: ${{ secrets.SLUG }}
42 | SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
43 | SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
44 | README_NAME: readme.md
45 |
--------------------------------------------------------------------------------
/.github/workflows/test-unit-php.yml:
--------------------------------------------------------------------------------
1 | name: PHP Unit Tests
2 |
3 | on:
4 | push:
5 | # Only run if PHP-related files changed.
6 | paths:
7 | - '**.php'
8 | - 'phpunit.xml.dist'
9 | - 'phpunit-multisite.xml.dist'
10 | - 'composer.json'
11 | - 'composer.lock'
12 | - 'tests/**'
13 | branches:
14 | - master
15 | - release/*
16 | pull_request:
17 | # Only run if PHP-related files changed.
18 | paths:
19 | - '**.php'
20 | - 'phpunit.xml.dist'
21 | - 'phpunit-multisite.xml.dist'
22 | - 'composer.json'
23 | - 'composer.lock'
24 | - 'tests/**'
25 | - '.github/workflows/tests-unit-php.yml'
26 |
27 | jobs:
28 | unit-php:
29 | name: 'PHP ${{ matrix.php }} - WP ${{ matrix.wp }}'
30 | runs-on: ubuntu-latest
31 | timeout-minutes: 60
32 | services:
33 | mysql:
34 | image: mariadb:latest
35 | env:
36 | MARIADB_ALLOW_EMPTY_ROOT_PASSWORD: true
37 | MARIADB_DATABASE: wordpress_test
38 | MARIADB_MYSQL_LOCALHOST_USER: 1
39 | MARIADB_MYSQL_LOCALHOST_GRANTS: USAGE
40 | ports:
41 | - 3306
42 | options: --health-cmd="healthcheck.sh --su-mysql --connect --innodb_initialized" --health-interval=10s --health-timeout=5s --health-retries=3
43 | continue-on-error: ${{ matrix.experimental == true }}
44 | strategy:
45 | matrix:
46 | php: ['7.0', '7.2', '7.4', '8.0']
47 | wp: ['latest']
48 | include:
49 | - php: '7.4'
50 | wp: 'trunk'
51 | experimental: true
52 | - php: '8.1'
53 | wp: 'trunk'
54 | experimental: true
55 | - php: '8.2'
56 | wp: 'trunk'
57 | experimental: true
58 | - php: '8.3'
59 | wp: 'trunk'
60 | experimental: true
61 |
62 | steps:
63 | - name: Checkout
64 | uses: actions/checkout@v2
65 |
66 | - name: Get Composer cache directory
67 | id: composer-cache
68 | run: echo "::set-output name=dir::$(composer config cache-files-dir)"
69 |
70 | - name: Setup Composer cache
71 | uses: pat-s/always-upload-cache@v2.1.3
72 | with:
73 | path: ${{ steps.composer-cache.outputs.dir }}
74 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
75 | restore-keys: |
76 | ${{ runner.os }}-composer-
77 | ${{ runner.os }}-
78 |
79 | - name: Setup PHP 8.0
80 | uses: shivammathur/setup-php@d30ad8b1843ace22e6698ab99bbafaa747b6bd0d
81 | with:
82 | php-version: '8.0'
83 | tools: composer
84 |
85 | - name: Setup PHP
86 | uses: shivammathur/setup-php@v2
87 | with:
88 | php-version: ${{ matrix.php }}
89 | extensions: mysql
90 | tools: composer, cs2pr
91 |
92 | - name: Install dependencies
93 | run: |
94 | composer install --prefer-dist --no-suggest --no-progress --no-interaction --no-scripts
95 | composer dump-autoload --no-interaction
96 |
97 | - name: Shutdown default MySQL service
98 | run: sudo service mysql stop
99 |
100 | - name: Verify MariaDB connection
101 | run: |
102 | while ! mysqladmin ping -h"127.0.0.1" -P"${{ job.services.mysql.ports[3306] }}" --silent; do
103 | sleep 1
104 | done
105 |
106 | - name: Set up tests
107 | run: bash bin/install-wp-tests.sh wordpress_test root '' 127.0.0.1:${{ job.services.mysql.ports['3306'] }} ${{ matrix.wp }} true
108 |
109 | - name: Run tests
110 | run: |
111 | npm run test:php
112 | npm run test:php:multisite
113 |
--------------------------------------------------------------------------------
/.github/workflows/upateassets.yml:
--------------------------------------------------------------------------------
1 | name: Asset update
2 | on:
3 | push:
4 | branches:
5 | - master
6 | jobs:
7 | master:
8 | name: Push to main
9 | runs-on: ubuntu-latest
10 | steps:
11 | - uses: actions/checkout@main
12 | - name: WordPress.org asset update
13 | uses: 10up/action-wordpress-plugin-asset-update@stable
14 | env:
15 | SLUG: ${{ secrets.SLUG }}
16 | SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
17 | SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
18 | README_NAME: readme.md
19 |
--------------------------------------------------------------------------------
/.github/workflows/upload-asset-on-release.yml:
--------------------------------------------------------------------------------
1 | name: Package Plugin
2 |
3 | on:
4 | release:
5 | types:
6 | - created
7 | - updated
8 |
9 | jobs:
10 | build:
11 | name: On Release
12 | runs-on: ubuntu-latest
13 | steps:
14 | - name: Checkout
15 | uses: actions/checkout@v2
16 |
17 | - name: Setup PHP
18 | uses: shivammathur/setup-php@v2
19 | with:
20 | php-version: '7.0'
21 | coverage: none
22 | tools: composer, cs2pr
23 |
24 | - name: Setup Workflow Context
25 | id: workflow
26 | working-directory: ${{ runner.temp }}
27 | env:
28 | REPO: ${{ github.repository }}
29 | run: |
30 | mkdir dist
31 | echo ::set-output name=DIST::${PWD}/dist
32 | echo ::set-output name=PACKAGE::${REPO##*/}
33 |
34 | - name: PHP version
35 | run: php --version
36 |
37 | - name: Validate composer.json and composer.lock
38 | run: composer validate
39 |
40 | - name: Get Composer Cache Directory
41 | id: composer-cache
42 | run: echo "::set-output name=dir::$(composer config cache-files-dir)"
43 |
44 | - name: Cache Composer vendor directory
45 | uses: actions/cache@v2
46 | with:
47 | path: ${{ steps.composer-cache.outputs.dir }}
48 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
49 | restore-keys: |
50 | ${{ runner.os }}-composer-
51 |
52 | - name: Install PHP Dependencies
53 | run: composer install --no-progress --no-dev --optimize-autoloader
54 |
55 | - name: Prepare files
56 | run: rsync -r --exclude-from=.distignore . ${{ steps.workflow.outputs.DIST }}/${{ steps.workflow.outputs.PACKAGE }}
57 |
58 | - name: List Files
59 | working-directory: ${{ steps.workflow.outputs.DIST }}
60 | run: find .
61 |
62 | - name: Create Zip
63 | working-directory: ${{ steps.workflow.outputs.DIST }}
64 | run: zip -r ${{ steps.workflow.outputs.PACKAGE }}.zip .
65 |
66 | - name: Upload Release Asset
67 | uses: actions/upload-release-asset@v1
68 | env:
69 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
70 | with:
71 | upload_url: https://uploads.github.com/repos/${{ github.repository }}/releases/${{ github.event.release.id }}/assets{?name,label}
72 | asset_path: ${{ steps.workflow.outputs.DIST }}/${{ steps.workflow.outputs.PACKAGE }}.zip
73 | asset_name: ${{ steps.workflow.outputs.PACKAGE }}.zip
74 | asset_content_type: application/zip
75 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | phpcs.xml
3 | phpunit.xml
4 | Thumbs.db
5 | wp-cli.local.yml
6 | composer.lock
7 | node_modules/
8 | vendor/
9 | .idea/
10 | *.sql
11 | *.tar.gz
12 | *.zip
13 |
--------------------------------------------------------------------------------
/.phpcs.xml.dist:
--------------------------------------------------------------------------------
1 |
2 |
3 | Generally-applicable sniffs for WordPress plugins.
4 |
5 |
6 | .
7 | /vendor/
8 | /node_modules/
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 | tests
29 |
30 |
31 |
32 | tests
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 | tests/*
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 | test
51 |
52 |
53 |
54 | test
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
--------------------------------------------------------------------------------
/.wordpress-org/banner-1544x500.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/spacedmonkey/wp-rest-blocks/bafb87a86d723b5ec54440e6fd6feb7fd94d6879/.wordpress-org/banner-1544x500.png
--------------------------------------------------------------------------------
/.wordpress-org/banner-772x250.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/spacedmonkey/wp-rest-blocks/bafb87a86d723b5ec54440e6fd6feb7fd94d6879/.wordpress-org/banner-772x250.png
--------------------------------------------------------------------------------
/.wordpress-org/icon-128x128.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/spacedmonkey/wp-rest-blocks/bafb87a86d723b5ec54440e6fd6feb7fd94d6879/.wordpress-org/icon-128x128.png
--------------------------------------------------------------------------------
/.wordpress-org/icon-256x256.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/spacedmonkey/wp-rest-blocks/bafb87a86d723b5ec54440e6fd6feb7fd94d6879/.wordpress-org/icon-256x256.png
--------------------------------------------------------------------------------
/.wordpress-org/screenshot-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/spacedmonkey/wp-rest-blocks/bafb87a86d723b5ec54440e6fd6feb7fd94d6879/.wordpress-org/screenshot-1.png
--------------------------------------------------------------------------------
/Gruntfile.js:
--------------------------------------------------------------------------------
1 | module.exports = function ( grunt ) {
2 | 'use strict';
3 |
4 | // Project configuration
5 | grunt.initConfig( {
6 | pkg: grunt.file.readJSON( 'package.json' ),
7 |
8 | addtextdomain: {
9 | options: {
10 | textdomain: 'wp-rest-blocks',
11 | },
12 | update_all_domains: {
13 | options: {
14 | updateDomains: true,
15 | },
16 | src: [
17 | '*.php',
18 | '**/*.php',
19 | '!.git/**/*',
20 | '!bin/**/*',
21 | '!node_modules/**/*',
22 | '!tests/**/*',
23 | ],
24 | },
25 | },
26 |
27 | wp_readme_to_markdown: {
28 | your_target: {
29 | files: {
30 | 'README.md': 'readme.txt',
31 | },
32 | },
33 | },
34 |
35 | makepot: {
36 | target: {
37 | options: {
38 | domainPath: '/languages',
39 | exclude: [ '.git/*', 'bin/*', 'node_modules/*', 'tests/*' ],
40 | mainFile: 'wp-rest-blocks.php',
41 | potFilename: 'wp-rest-blocks.pot',
42 | potHeaders: {
43 | poedit: true,
44 | 'x-poedit-keywordslist': true,
45 | },
46 | type: 'wp-plugin',
47 | updateTimestamp: true,
48 | },
49 | },
50 | },
51 | } );
52 |
53 | grunt.loadNpmTasks( 'grunt-wp-i18n' );
54 | grunt.loadNpmTasks( 'grunt-wp-readme-to-markdown' );
55 | grunt.registerTask( 'default', [ 'i18n', 'readme' ] );
56 | grunt.registerTask( 'i18n', [ 'addtextdomain', 'makepot' ] );
57 | grunt.registerTask( 'readme', [ 'wp_readme_to_markdown' ] );
58 |
59 | grunt.util.linefeed = '\n';
60 | };
61 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/bin/install-wp-tests.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | if [ $# -lt 3 ]; then
4 | echo "usage: $0 [db-host] [wp-version] [skip-database-creation]"
5 | exit 1
6 | fi
7 |
8 | DB_NAME=$1
9 | DB_USER=$2
10 | DB_PASS=$3
11 | DB_HOST=${4-localhost}
12 | WP_VERSION=${5-latest}
13 | SKIP_DB_CREATE=${6-false}
14 |
15 | TMPDIR=${TMPDIR-/tmp}
16 | TMPDIR=$(echo $TMPDIR | sed -e "s/\/$//")
17 | WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
18 | WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/}
19 |
20 | download() {
21 | if [ `which curl` ]; then
22 | curl -s "$1" > "$2";
23 | elif [ `which wget` ]; then
24 | wget -nv -O "$2" "$1"
25 | fi
26 | }
27 |
28 | if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+\-(beta|RC)[0-9]+$ ]]; then
29 | WP_BRANCH=${WP_VERSION%\-*}
30 | WP_TESTS_TAG="branches/$WP_BRANCH"
31 |
32 | elif [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
33 | WP_TESTS_TAG="branches/$WP_VERSION"
34 | elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
35 | if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
36 | # version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
37 | WP_TESTS_TAG="tags/${WP_VERSION%??}"
38 | else
39 | WP_TESTS_TAG="tags/$WP_VERSION"
40 | fi
41 | elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
42 | WP_TESTS_TAG="trunk"
43 | else
44 | # http serves a single offer, whereas https serves multiple. we only want one
45 | download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
46 | grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
47 | LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
48 | if [[ -z "$LATEST_VERSION" ]]; then
49 | echo "Latest WordPress version could not be found"
50 | exit 1
51 | fi
52 | WP_TESTS_TAG="tags/$LATEST_VERSION"
53 | fi
54 | set -ex
55 |
56 | install_wp() {
57 |
58 | if [ -d $WP_CORE_DIR ]; then
59 | return;
60 | fi
61 |
62 | mkdir -p $WP_CORE_DIR
63 |
64 | if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
65 | mkdir -p $TMPDIR/wordpress-nightly
66 | download https://wordpress.org/nightly-builds/wordpress-latest.zip $TMPDIR/wordpress-nightly/wordpress-nightly.zip
67 | unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
68 | mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
69 | else
70 | if [ $WP_VERSION == 'latest' ]; then
71 | local ARCHIVE_NAME='latest'
72 | elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then
73 | # https serves multiple offers, whereas http serves single.
74 | download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
75 | if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
76 | # version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
77 | LATEST_VERSION=${WP_VERSION%??}
78 | else
79 | # otherwise, scan the releases and get the most up to date minor version of the major release
80 | local VERSION_ESCAPED=`echo $WP_VERSION | sed 's/\./\\\\./g'`
81 | LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
82 | fi
83 | if [[ -z "$LATEST_VERSION" ]]; then
84 | local ARCHIVE_NAME="wordpress-$WP_VERSION"
85 | else
86 | local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
87 | fi
88 | else
89 | local ARCHIVE_NAME="wordpress-$WP_VERSION"
90 | fi
91 | download https://wordpress.org/${ARCHIVE_NAME}.tar.gz $TMPDIR/wordpress.tar.gz
92 | tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR
93 | fi
94 |
95 | download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php
96 | }
97 |
98 | install_test_suite() {
99 | # portable in-place argument for both GNU sed and Mac OSX sed
100 | if [[ $(uname -s) == 'Darwin' ]]; then
101 | local ioption='-i.bak'
102 | else
103 | local ioption='-i'
104 | fi
105 |
106 | # set up testing suite if it doesn't yet exist
107 | if [ ! -d $WP_TESTS_DIR ]; then
108 | # set up testing suite
109 | mkdir -p $WP_TESTS_DIR
110 | svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
111 | svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data
112 | fi
113 |
114 | if [ ! -f wp-tests-config.php ]; then
115 | download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
116 | # remove all forward slashes in the end
117 | WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
118 | sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
119 | sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
120 | sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
121 | sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
122 | sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
123 | fi
124 |
125 | }
126 |
127 | install_db() {
128 |
129 | if [ ${SKIP_DB_CREATE} = "true" ]; then
130 | return 0
131 | fi
132 |
133 | # parse DB_HOST for port or socket references
134 | local PARTS=(${DB_HOST//\:/ })
135 | local DB_HOSTNAME=${PARTS[0]};
136 | local DB_SOCK_OR_PORT=${PARTS[1]};
137 | local EXTRA=""
138 |
139 | if ! [ -z $DB_HOSTNAME ] ; then
140 | if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then
141 | EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
142 | elif ! [ -z $DB_SOCK_OR_PORT ] ; then
143 | EXTRA=" --socket=$DB_SOCK_OR_PORT"
144 | elif ! [ -z $DB_HOSTNAME ] ; then
145 | EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
146 | fi
147 | fi
148 |
149 | # create database
150 | mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
151 | }
152 |
153 | install_wp
154 | install_test_suite
155 | install_db
156 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "spacedmonkey/wp-rest-blocks",
3 | "description": "Add gutenberg blocks data into post / page / widget REST API endpoints.",
4 | "license": "GPL-3.0-or-later",
5 | "type": "wordpress-plugin",
6 | "authors": [
7 | {
8 | "name": "Jonny Harris",
9 | "homepage": "https://www.spacedmonkey.com/"
10 | }
11 | ],
12 | "homepage": "http://wp-api.org/",
13 | "support": {
14 | "issues": "https://github.com/spacedmonkey/wp-rest-blocks/issues"
15 | },
16 | "require": {
17 | "php": "^7.0 || ^8.0",
18 | "composer/installers": "^1.10",
19 | "tburry/pquery": "^1.1"
20 | },
21 | "require-dev": {
22 | "phpcompatibility/phpcompatibility-wp": "^2.1",
23 | "sirbrillig/phpcs-variable-analysis": "^2.11",
24 | "wp-coding-standards/wpcs": "^3.0",
25 | "yoast/wp-test-utils": "^1.2.0"
26 | },
27 | "config": {
28 | "allow-plugins": {
29 | "composer/installers": true,
30 | "dealerdirect/phpcodesniffer-composer-installer": true
31 | },
32 | "discard-changes": true,
33 | "sort-packages": true
34 | },
35 | "scripts": {
36 | "phpcbf": "phpcbf",
37 | "phpcs": "phpcs",
38 | "test": "phpunit"
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/languages/wp-rest-blocks.pot:
--------------------------------------------------------------------------------
1 | # Copyright (C) 2021 Jonathan Harris
2 | # This file is distributed under the same license as the REST API Blocks plugin.
3 | msgid ""
4 | msgstr ""
5 | "Project-Id-Version: REST API Blocks 0.4.0\n"
6 | "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/wp-rest-blocks\n"
7 | "Last-Translator: FULL NAME \n"
8 | "Language-Team: LANGUAGE \n"
9 | "MIME-Version: 1.0\n"
10 | "Content-Type: text/plain; charset=UTF-8\n"
11 | "Content-Transfer-Encoding: 8bit\n"
12 | "POT-Creation-Date: 2021-09-06T22:57:02+00:00\n"
13 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14 | "X-Generator: WP-CLI 2.5.0\n"
15 | "X-Domain: wp-rest-blocks\n"
16 |
17 | #. Plugin Name of the plugin
18 | msgid "REST API Blocks"
19 | msgstr ""
20 |
21 | #. Plugin URI of the plugin
22 | msgid "https://github.com/spacedmonkey/wp-rest-blocks"
23 | msgstr ""
24 |
25 | #. Description of the plugin
26 | msgid "Add gutenberg blocks data into post / page / widget REST API endpoints."
27 | msgstr ""
28 |
29 | #. Author of the plugin
30 | msgid "Jonathan Harris"
31 | msgstr ""
32 |
33 | #. Author URI of the plugin
34 | msgid "https://www.spacedmonkey.com/"
35 | msgstr ""
36 |
37 | #: src/posts.php:55
38 | #: src/widgets.php:38
39 | msgid "Has blocks."
40 | msgstr ""
41 |
42 | #: src/posts.php:70
43 | #: src/widgets.php:53
44 | msgid "Blocks."
45 | msgstr ""
46 |
47 | #. translators: %s: build commands.
48 | #: wp-rest-blocks.php:35
49 | msgid " Please run %s to finish installation."
50 | msgstr ""
51 |
52 | #: wp-rest-blocks.php:40
53 | msgid "REST API Blocks plugin could not be initialized."
54 | msgstr ""
55 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "wp-rest-blocks",
3 | "version": "1.0.0",
4 | "main": "Gruntfile.js",
5 | "author": "Jonathan Harris",
6 | "devDependencies": {
7 | "@wordpress/scripts": "^28.2.0",
8 | "grunt": "~1.6.1",
9 | "grunt-wp-i18n": "^1.0.3",
10 | "grunt-wp-readme-to-markdown": "~2.1.0",
11 | "js-yaml": "^4.1.0",
12 | "lodash": "^4.17.21",
13 | "minimatch": "^9.0.5",
14 | "underscore.string": "^3.3.6"
15 | },
16 | "scripts": {
17 | "lint:php": "composer phpcs",
18 | "lint:php:fix": "composer phpcbf",
19 | "test:php": "composer test",
20 | "test:php:multisite": "composer test -- -c phpunit-multisite.xml.dist",
21 | "test:php:help": "composer test --help",
22 | "format": "wp-scripts format",
23 | "lint:css": "wp-scripts lint-style",
24 | "lint:js": "wp-scripts lint-js",
25 | "lint:md:docs": "wp-scripts lint-md-docs",
26 | "lint:pkg-json": "wp-scripts lint-pkg-json",
27 | "packages-update": "wp-scripts packages-update"
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/phpunit-multisite.xml.dist:
--------------------------------------------------------------------------------
1 |
2 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 | ./tests/
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
1 |
2 |
10 |
11 |
12 | ./tests/
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | # REST API blocks
2 | Contributors: spacedmonkey
3 | Donate link: https://github.com/sponsors/spacedmonkey
4 | Tags: blocks, gutenberg, api, wp-json, rest-api
5 | Requires at least: 5.5
6 | Tested up to: 6.5
7 | Requires PHP: 7.0.0
8 | Stable tag: 1.0.2
9 | License: GPLv3 or later
10 | License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
11 |
12 | 
13 |
14 | Add gutenberg blocks data into the post / page REST API endpoints.
15 |
16 | [](https://travis-ci.com/spacedmonkey/wp-rest-blocks)
17 |
18 | ## Description
19 |
20 | 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`.
21 | For example output.
22 | ```
23 | "has_blocks": true,
24 | "block_data": [
25 | {
26 | "blockName": "core/image",
27 | "attrs": {
28 | "url": "https://www.spacedmonkey.com/wp-content/uploads/2018/12/test-image.jpg",
29 | "alt": "Terminal de aeropuerto",
30 | "caption": "fsfsdfdsfdssfd",
31 | "href": "https://www.spacedmonkey.com/test-image",
32 | "rel": "noreferrer noopener",
33 | "linkClass": "jonny-123",
34 | "linkTarget": "_blank",
35 | "id": 147355,
36 | "width": 582,
37 | "height": 327,
38 | "linkDestination": "attachment"
39 | },
40 | "innerBlocks": [
41 | ],
42 | "innerHTML": "\nfsfsdfdsfdssfd\n",
43 | "innerContent": [
44 | "\nfsfsdfdsfdssfd\n"
45 | ],
46 | "rendered": "\nfsfsdfdsfdssfd\n"
47 | }
48 | ],
49 | ```
50 |
51 | ### Technical Notes
52 |
53 | * Requires PHP 5.6+.
54 | * Requires WordPress 5.5+.
55 | * Issues and Pull requests welcome on the GitHub repository: https://github.com/spacedmonkey/wp-rest-blocks
56 |
57 | ## Installation
58 |
59 | ### Using The WordPress Dashboard
60 |
61 | 1. Navigate to the 'Add New' in the plugins dashboard
62 | 2. Search for 'wp-rest-blocks'
63 | 3. Click 'Install Now'
64 | 4. Activate the plugin on the Plugin dashboard
65 |
66 | ### Uploading in WordPress Dashboard
67 |
68 | 1. Navigate to the 'Add New' in the plugins dashboard
69 | 2. Navigate to the 'Upload' area
70 | 3. Select `wp-rest-blocks.zip` from your computer
71 | 4. Click 'Install Now'
72 | 5. Activate the plugin in the Plugin dashboard
73 |
74 | ### Using FTP
75 | 1. Download `wp-rest-blocks.zip`
76 | 2. Extract the `wp-rest-blocks` directory to your computer
77 | 3. Upload the `wp-rest-blocks` directory to the `/wp-content/plugins/` directory
78 | 4. Activate the plugin in the Plugin dashboard
79 |
80 | ## Screenshots
81 |
82 | 1. Add fields to the rest api.
83 |
84 | ## Changelog ##
85 |
86 | ### 1.0.2 ###
87 | * Fix issue with WordPress 6.5
88 | * Update coding standards to WP coding standards 3.1.0
89 | * Mark tested up to WP 6.5
90 |
91 | ### 1.0.1 ###
92 | * Update coding standards to WP coding standards 3.0.1
93 | * Mark tested up to WP 6.4
94 |
95 | ### 1.0.0 ###
96 | Breaking change!
97 | The field in the REST API is changed from `blocks` to `block_data`.
98 |
99 | ### 0.5.0 ###
100 | * Add support for new post types added in WordPress 5.9.
101 |
102 | ### 0.4.0 ###
103 | * Added support for block based widget, added in WordPress 5.8. Block data is added to the /wp/v2/widgets endpoint.
104 |
105 | ### 0.3.2 ###
106 | * Update translations
107 |
108 | ### 0.3.1 ###
109 | * Hot fix.
110 |
111 | ### 0.3.0 ###
112 | * Improve support for block that have attributes that use query source type.
113 | * Improve error handling for those that install this plugin without using composer.
114 |
115 | ### 0.2.1 ###
116 | * Update dependency.
117 |
118 | ### 0.2.0 ###
119 | * Breaking change. Field names have changed and required WordPress 5.5+
120 |
121 | ### 0.1.0 ###
122 | * First version.
123 |
--------------------------------------------------------------------------------
/src/data.php:
--------------------------------------------------------------------------------
1 | block_type ) {
51 | $attributes = $block_object->block_type->attributes;
52 | $supports = $block_object->block_type->supports;
53 | if ( $supports && isset( $supports['anchor'] ) && $supports['anchor'] ) {
54 | $attributes['anchor'] = [
55 | 'type' => 'string',
56 | 'source' => 'attribute',
57 | 'attribute' => 'id',
58 | 'selector' => '*',
59 | 'default' => '',
60 | ];
61 | }
62 |
63 | if ( $attributes ) {
64 | foreach ( $attributes as $key => $attribute ) {
65 | if ( ! isset( $attr[ $key ] ) ) {
66 | $attr[ $key ] = get_attribute( $attribute, $block_object->inner_html, $post_id );
67 | }
68 | }
69 | }
70 | }
71 |
72 | $block['rendered'] = $block_object->render();
73 | $block['rendered'] = do_shortcode( $block['rendered'] );
74 | $block['attrs'] = $attr;
75 | if ( ! empty( $block['innerBlocks'] ) ) {
76 | $inner_blocks = $block['innerBlocks'];
77 | $block['innerBlocks'] = [];
78 | foreach ( $inner_blocks as $_block ) {
79 | $block['innerBlocks'][] = handle_do_block( $_block, $post_id );
80 | }
81 | }
82 |
83 | return $block;
84 | }
85 |
86 | /**
87 | * Get attribute.
88 | *
89 | * @param array $attribute Attributes.
90 | * @param string $html HTML string.
91 | * @param int $post_id Post Number. Deafult 0.
92 | *
93 | * @return mixed
94 | */
95 | function get_attribute( $attribute, $html, $post_id = 0 ) {
96 | $value = null;
97 | $dom = pQuery::parseStr( trim( $html ) );
98 | $node = isset( $attribute['selector'] ) ? $dom->query( $attribute['selector'] ) : $dom->query();
99 |
100 | if ( isset( $attribute['source'] ) ) {
101 | switch ( $attribute['source'] ) {
102 | case 'attribute':
103 | $value = $node->attr( $attribute['attribute'] );
104 | break;
105 | case 'html':
106 | case 'rich-text':
107 | $value = $node->html();
108 | break;
109 | case 'text':
110 | $value = $node->text();
111 | break;
112 | case 'query':
113 | if ( isset( $attribute['query'] ) ) {
114 | $counter = 0;
115 | $nodes = $node->getIterator();
116 | foreach ( $nodes as $v_node ) {
117 | foreach ( $attribute['query'] as $key => $current_attribute ) {
118 | $current_value = get_attribute( $current_attribute, $v_node->toString(), $post_id );
119 | if ( null !== $current_value ) {
120 | $value[ $counter ][ $key ] = $current_value;
121 | }
122 | }
123 | ++$counter;
124 | }
125 | }
126 | break;
127 | case 'meta':
128 | if ( $post_id && isset( $attribute['meta'] ) ) {
129 | $value = get_post_meta( $post_id, $attribute['meta'], true );
130 | }
131 | break;
132 | }
133 | }
134 |
135 | // Assign default value if value is null and a default exists.
136 | if ( is_null( $value ) && isset( $attribute['default'] ) ) {
137 | $value = $attribute['default'];
138 | }
139 |
140 | $allowed_types = [ 'array', 'object', 'string', 'number', 'integer', 'boolean', 'null' ];
141 | // If attribute type is set and valid, sanitize value.
142 | if ( isset( $attribute['type'] ) && in_array( $attribute['type'], $allowed_types, true ) && rest_validate_value_from_schema( $value, $attribute ) ) {
143 | $value = rest_sanitize_value_from_schema( $value, $attribute );
144 | }
145 |
146 | return $value;
147 | }
148 |
--------------------------------------------------------------------------------
/src/posts.php:
--------------------------------------------------------------------------------
1 | true ], 'names' );
28 | $post_types = array_values( $post_types );
29 |
30 | if ( ! function_exists( 'use_block_editor_for_post_type' ) ) {
31 | require_once ABSPATH . 'wp-admin/includes/post.php';
32 | }
33 | $post_types = array_filter( $post_types, 'use_block_editor_for_post_type' );
34 | $post_types[] = 'wp_navigation';
35 | $post_types = array_filter( $post_types, 'post_type_exists' );
36 |
37 | return $post_types;
38 | }
39 |
40 | /**
41 | * Add rest api fields.
42 | *
43 | * @return void
44 | */
45 | function wp_rest_blocks_init() {
46 | $types = get_post_types_with_editor();
47 | if ( ! $types ) {
48 | return;
49 | }
50 |
51 | register_rest_field(
52 | $types,
53 | 'has_blocks',
54 | [
55 | 'get_callback' => __NAMESPACE__ . '\\has_blocks_get_callback',
56 | 'update_callback' => null,
57 | 'schema' => [
58 | 'description' => __( 'Has blocks.', 'wp-rest-blocks' ),
59 | 'type' => 'boolean',
60 | 'context' => [ 'embed', 'view', 'edit' ],
61 | 'readonly' => true,
62 | ],
63 | ]
64 | );
65 |
66 | register_rest_field(
67 | $types,
68 | 'block_data',
69 | [
70 | 'get_callback' => __NAMESPACE__ . '\\blocks_get_callback',
71 | 'update_callback' => null,
72 | 'schema' => [
73 | 'description' => __( 'Blocks.', 'wp-rest-blocks' ),
74 | 'type' => 'object',
75 | 'context' => [ 'embed', 'view', 'edit' ],
76 | 'readonly' => true,
77 | ],
78 | ]
79 | );
80 | }
81 |
82 | /**
83 | * Callback to get if post content has block data.
84 | *
85 | * @param array $data_object Array of data rest api request.
86 | *
87 | * @return bool
88 | */
89 | function has_blocks_get_callback( array $data_object ) {
90 | if ( isset( $data_object['content']['raw'] ) ) {
91 | return has_blocks( $data_object['content']['raw'] );
92 | }
93 | $id = ! empty( $data_object['wp_id'] ) ? $data_object['wp_id'] : $data_object['id'];
94 | $post = get_post( $id );
95 | if ( ! $post ) {
96 | return false;
97 | }
98 |
99 | return has_blocks( $post );
100 | }
101 |
102 | /**
103 | * Loop around all blocks and get block data.
104 | *
105 | * @param array $data_object Array of data rest api request.
106 | *
107 | * @return array
108 | */
109 | function blocks_get_callback( array $data_object ) {
110 | $id = ! empty( $data_object['wp_id'] ) ? $data_object['wp_id'] : $data_object['id'];
111 | if ( isset( $data_object['content']['raw'] ) ) {
112 | return get_blocks( $data_object['content']['raw'], $id );
113 | }
114 | $id = ! empty( $data_object['wp_id'] ) ? $data_object['wp_id'] : $data_object['id'];
115 | $post = get_post( $id );
116 | $output = [];
117 | if ( ! $post ) {
118 | return $output;
119 | }
120 |
121 | return get_blocks( $post->post_content, $post->ID );
122 | }
123 |
--------------------------------------------------------------------------------
/src/widgets.php:
--------------------------------------------------------------------------------
1 | __NAMESPACE__ . '\\has_blocks_widget_get_callback',
36 | 'update_callback' => null,
37 | 'schema' => [
38 | 'description' => __( 'Has blocks.', 'wp-rest-blocks' ),
39 | 'type' => 'boolean',
40 | 'context' => [ 'embed', 'view', 'edit' ],
41 | 'readonly' => true,
42 | ],
43 | ]
44 | );
45 |
46 | register_rest_field(
47 | 'widget',
48 | 'block_data',
49 | [
50 | 'get_callback' => __NAMESPACE__ . '\\blocks_widget_get_callback',
51 | 'update_callback' => null,
52 | 'schema' => [
53 | 'description' => __( 'Blocks.', 'wp-rest-blocks' ),
54 | 'type' => 'object',
55 | 'context' => [ 'embed', 'view', 'edit' ],
56 | 'readonly' => true,
57 | ],
58 | ]
59 | );
60 | }
61 |
62 | /**
63 | * Get widget
64 | *
65 | * @param array $data_object Object data.
66 | *
67 | * @return mixed
68 | */
69 | function get_widget( array $data_object ) {
70 | global $wp_widget_factory;
71 |
72 | $widget_object = $wp_widget_factory->get_widget_object( $data_object['id_base'] );
73 | $parsed_id = wp_parse_widget_id( $data_object['id'] );
74 | $all_instances = $widget_object->get_settings();
75 |
76 | return $all_instances[ $parsed_id['number'] ];
77 | }
78 |
79 | /**
80 | * Callback to get if post content has block data.
81 | *
82 | * @param array $data_object Array of data rest api request.
83 | *
84 | * @return bool
85 | */
86 | function has_blocks_widget_get_callback( array $data_object ) {
87 | if ( ! isset( $data_object['id_base'] ) || 'block' !== $data_object['id_base'] ) {
88 | return false;
89 | }
90 |
91 | $instance = get_widget( $data_object );
92 | if ( ! isset( $instance['content'] ) || ! $instance['content'] ) {
93 | return false;
94 | }
95 |
96 | return has_blocks( $instance['content'] );
97 | }
98 |
99 | /**
100 | * Loop around all blocks and get block data.
101 | *
102 | * @param array $data_object Array of data rest api request.
103 | *
104 | * @return array
105 | */
106 | function blocks_widget_get_callback( array $data_object ) {
107 | if ( ! has_blocks_widget_get_callback( $data_object ) ) {
108 | return [];
109 | }
110 |
111 | $instance = get_widget( $data_object );
112 |
113 | return get_blocks( $instance['content'] );
114 | }
115 |
--------------------------------------------------------------------------------
/tests/bootstrap.php:
--------------------------------------------------------------------------------
1 | post->create(
32 | [
33 | 'post_content' => '',
34 | ]
35 | );
36 |
37 | $mixed_post_content = 'before' .
38 | '' .
39 | '' .
40 | '
41 |
![\"Terminal](\"https://www.spacedmonkey.com/wp-content/uploads/2018/12/test-image.jpg\")
