diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7cae5d5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +# This file is for unifying the coding style for different editors and IDEs +# editorconfig.org + +# WordPress Coding Standards +# https://make.wordpress.org/core/handbook/coding-standards/ + +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = tab diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7e8c9ea --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Coverage directory used by tools like istanbul +coverage + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Output of 'npm pack' +*.tgz + +# dotenv environment variables file +.env diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e1a7b82 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Starting block +* Contributors: bobbingwide +* Tags: block, starting, scaffold, SSR +* Tested up to: 5.7.0 +* Stable tag: 0.0.0 +* License: GPLv3 +* License URI: https://www.gnu.org/licenses/gpl-2.0.html + +Starting point for a single block server side rendered block. + +## Description +The Starting block plugin is a single block plugin to be used as the starting point for future Server Side Rendered blocks. + +## Installation +The purpose of this plugin is to provide the source code for a Server Side Rendered block +that is copied into an existing plugin where the new SSR logic replaces an existing shortcode. + +You should not need to activate this plugin. If you do, it's just like any other plugin. + +## Screenshots +1. Starting block - rendered +2. Starting block - settings + +## Upgrade Notice +# 0.0.0 +First version to be used to replace any `[your name here]` shortcodes in FSE themes + +## Changelog +# 0.0.0 +* Added: First version of the server side rendered block,[#1](https://github.com/bobbingwide/sb-starting-block/issues/1) +* Tested: With WordPress 5.7.1 and WordPress Multi Site +* Tested: With Gutenberg 10.6.0-rc.1 +* Tested: With PHP 8.0 diff --git a/assets/screenshot-1.jpg b/assets/screenshot-1.jpg new file mode 100644 index 0000000..71a77c7 Binary files /dev/null and b/assets/screenshot-1.jpg differ diff --git a/assets/screenshot-2.jpg b/assets/screenshot-2.jpg new file mode 100644 index 0000000..877e324 Binary files /dev/null and b/assets/screenshot-2.jpg differ diff --git a/block.json b/block.json new file mode 100644 index 0000000..795d484 --- /dev/null +++ b/block.json @@ -0,0 +1,15 @@ +{ + "apiVersion": 2, + "name": "oik-sb/sb-starting-block", + "title": "Starting block", + "category": "widgets", + "icon": "megaphone", + "description": "Starting Server Side Rendered block", + "supports": { + "html": false + }, + "textdomain": "sb-starting-block", + "editorScript": "file:./build/index.js", + "editorStyle": "file:./build/index.css", + "style": "file:./build/style-index.css" +} diff --git a/build/index.asset.php b/build/index.asset.php new file mode 100644 index 0000000..15b6e16 --- /dev/null +++ b/build/index.asset.php @@ -0,0 +1 @@ + array('wp-block-editor', 'wp-blocks', 'wp-editor', 'wp-element', 'wp-i18n', 'wp-polyfill'), 'version' => '0947419f861daa40eedb00de3c2d8443'); \ No newline at end of file diff --git a/build/index.css b/build/index.css new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/build/index.css @@ -0,0 +1 @@ + diff --git a/build/index.js b/build/index.js new file mode 100644 index 0000000..899d21f --- /dev/null +++ b/build/index.js @@ -0,0 +1 @@ +(window.webpackJsonp_sb_starting_block=window.webpackJsonp_sb_starting_block||[]).push([[1],{3:function(t,e,n){}}]),function(t){function e(e){for(var r,u,c=e[0],s=e[1],l=e[2],a=0,f=[];a 'oik_sb_sb_starting_block_dynamic_block']; + register_block_type_from_metadata( __DIR__, $args ); +} + +function oik_sb_sb_starting_block_loaded() { + add_action( 'init', 'oik_sb_sb_starting_block_block_init' ); +} +/** + * Implements post-edit block. + * + * If the user is authorised return a post edit link for the current post. + * + * @param $attrs + * @param $content + * @param $tag + * + * @return string + */ +function oik_sb_sb_starting_block_dynamic_block( $attributes ) { + $classes = ''; + if ( isset( $attributes['textAlign'] ) ) { + $classes .= 'has-text-align-' . $attributes['textAlign']; + } + $wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $classes ) ); + $content = __( 'Starting block.', 'sb-starting-block'); + $html = sprintf( '
%2$s
', $wrapper_attributes, $content ); + // $html=\oik\oik_blocks\oik_blocks_check_server_func( "shortcodes/starting-block.php", "sb-starting-block", "oik_sb_sb_starting_block" ); + return $html; +} + +oik_sb_sb_starting_block_loaded(); diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..f8fc883 --- /dev/null +++ b/src/README.md @@ -0,0 +1,41 @@ +## Build process +The build process is only necessary if you want to build the block yourself. + +- To build the block during development. + +`npm start` or `npm run dev` + +Press Ctrl-C to stop the process. + +- To build the block for production. + +`npm run build` + +The routine should terminate when the build is complete. + +- To build the main file for translation + +`npm run makepot` + +- To create the block editor language files after translation. + +`npm run makejson` + +- To automatically generate language files for: + - UK English ( locale: en_GB ) + - bbboing ( a language used for testing, locale: bb_BB ) + +`npm run l10n` + + +Pre-requisites: + +You need to have `npm` - Node Package Manager - installed. + +For some basic instructions see the Build process section of [oik-blocks summary of blocks README](https://github.com/bobbingwide/oik-blocks/tree/master/blocks) + +Many people run the `npm` command from the command line. + +For `l10n` see [Internationalization for the oik suite of plugins](https://github.com/bobbingwide/oik-i18n) + + diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..bba4e53 --- /dev/null +++ b/src/index.js @@ -0,0 +1 @@ +import './starting-block'; diff --git a/src/starting-block/edit.js b/src/starting-block/edit.js new file mode 100644 index 0000000..d168242 --- /dev/null +++ b/src/starting-block/edit.js @@ -0,0 +1,39 @@ +/** + * Retrieves the translation of text. + * + * @see https://developer.wordpress.org/block-editor/packages/packages-i18n/ + */ +import { __ } from '@wordpress/i18n'; + +/** + * React hook that is used to mark the block wrapper element. + * It provides all the necessary props like the class name. + * + * @see https://developer.wordpress.org/block-editor/packages/packages-block-editor/#useBlockProps + */ +import { useBlockProps } from '@wordpress/block-editor'; + +import { ServerSideRender } from '@wordpress/editor'; +/** + * Lets webpack process CSS, SASS or SCSS files referenced in JavaScript files. + * Those files can contain any CSS code that gets applied to the editor. + * + * @see https://www.npmjs.com/package/@wordpress/scripts#using-css + */ +import './editor.scss'; + +/** + * The edit function describes the structure of your block in the context of the + * editor. This represents what the editor will render when the block is used. + * + * @see https://developer.wordpress.org/block-editor/developers/block-api/block-edit-save/#edit + * + * @return {WPElement} Element to render. + */ +export default function Edit ( { attributes, className, isSelected, setAttributes } ) { + return ( + + ); +} diff --git a/src/starting-block/editor.scss b/src/starting-block/editor.scss new file mode 100644 index 0000000..ca93aab --- /dev/null +++ b/src/starting-block/editor.scss @@ -0,0 +1,9 @@ +/** + * The following styles get applied inside the editor only. + * + * Replace them with your own styles or remove the file completely. + */ + +.wp-block-oik-sb-sb-starting-block { + +} diff --git a/src/starting-block/index.js b/src/starting-block/index.js new file mode 100644 index 0000000..2a61e2a --- /dev/null +++ b/src/starting-block/index.js @@ -0,0 +1,38 @@ +/** + * Registers a new block provided a unique name and an object defining its behavior. + * + * @see https://developer.wordpress.org/block-editor/developers/block-api/#registering-a-block + */ +import { registerBlockType } from '@wordpress/blocks'; + +/** + * Lets webpack process CSS, SASS or SCSS files referenced in JavaScript files. + * All files containing `style` keyword are bundled together. The code used + * gets applied both to the front of your site and to the editor. + * + * @see https://www.npmjs.com/package/@wordpress/scripts#using-css + */ +import './style.scss'; + +/** + * Internal dependencies + */ +import Edit from './edit'; +import save from './save'; + +/** + * Every block starts by registering a new block type definition. + * + * @see https://developer.wordpress.org/block-editor/developers/block-api/#registering-a-block + */ +registerBlockType( 'oik-sb/sb-starting-block', { + /** + * @see ./edit.js + */ + edit: Edit, + + /** + * @see ./save.js + */ + save, +} ); diff --git a/src/starting-block/save.js b/src/starting-block/save.js new file mode 100644 index 0000000..603964b --- /dev/null +++ b/src/starting-block/save.js @@ -0,0 +1,12 @@ +/** + * The save function defines the way in which the different attributes should + * be combined into the final markup, which is then serialized by the block + * editor into `post_content`. + * + * @see https://developer.wordpress.org/block-editor/developers/block-api/block-edit-save/#save + * + * @return {WPElement} Element to render. + */ +export default function save() { + return null; +} diff --git a/src/starting-block/style.scss b/src/starting-block/style.scss new file mode 100644 index 0000000..a3c1c33 --- /dev/null +++ b/src/starting-block/style.scss @@ -0,0 +1,10 @@ +/** + * The following styles get applied both on the front of your site + * and in the editor. + * + * Replace them with your own styles or remove the file completely. + */ + +.wp-block-oik-sb-sb-starting-block { + +}