├── .editorconfig ├── .gitattributes ├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── composer.json ├── composer.lock ├── phpcs.xml └── src └── BlockLoader.php /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | insert_final_newline = true 7 | trim_trailing_whitespace = true 8 | indent_style = tab 9 | 10 | [{*.txt,wp-config-sample.php}] 11 | end_of_line = crlf 12 | 13 | [*.yml] 14 | indent_style = space 15 | indent_size = 2 16 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Project ### 2 | *.log 3 | /vendor/ 4 | 5 | ### Windows ### 6 | # Windows image file caches 7 | Thumbs.db 8 | ehthumbs.db 9 | 10 | # Folder config file 11 | Desktop.ini 12 | 13 | # Recycle Bin used on file shares 14 | $RECYCLE.BIN/ 15 | 16 | # Windows Installer files 17 | *.cab 18 | *.msi 19 | *.msm 20 | *.msp 21 | 22 | # Windows shortcuts 23 | *.lnk 24 | 25 | 26 | ### macOS ### 27 | *.DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Icon must end with two \r 32 | Icon 33 | 34 | 35 | # Thumbnails 36 | ._* 37 | 38 | # Files that might appear in the root of a volume 39 | .DocumentRevisions-V100 40 | .fseventsd 41 | .Spotlight-V100 42 | .TemporaryItems 43 | .Trashes 44 | .VolumeIcon.icns 45 | .com.apple.timemachine.donotpresent 46 | 47 | # Directories potentially created on remote AFP share 48 | .AppleDB 49 | .AppleDesktop 50 | Network Trash Folder 51 | Temporary Items 52 | .apdisk 53 | 54 | 55 | ### Sass ### 56 | .sass-cache/ 57 | *.css.map 58 | 59 | 60 | ### SublimeText ### 61 | # cache files for sublime text 62 | *.tmlanguage.cache 63 | *.tmPreferences.cache 64 | *.stTheme.cache 65 | 66 | # workspace files are user-specific 67 | *.sublime-workspace 68 | .vscode 69 | 70 | # project files should be checked into the repository, unless a significant 71 | # proportion of contributors will probably not be using SublimeText 72 | # *.sublime-project 73 | 74 | # sftp configuration file 75 | sftp-config.json 76 | 77 | # postcss sorting config file 78 | settings.json 79 | 80 | # Package control specific files 81 | Package Control.last-run 82 | Package Control.ca-list 83 | Package Control.ca-bundle 84 | Package Control.system-ca-bundle 85 | Package Control.cache/ 86 | Package Control.ca-certs/ 87 | bh_unicode_properties.cache 88 | 89 | # Sublime-github package stores a github token in this file 90 | # https://packagecontrol.io/packages/sublime-github 91 | GitHub.sublime-settings 92 | 93 | 94 | ### Vim ### 95 | # swap 96 | [._]*.s[a-w][a-z] 97 | [._]s[a-w][a-z] 98 | # session 99 | Session.vim 100 | # temporary 101 | .netrwhist 102 | *~ 103 | # auto-generated tag files 104 | tags 105 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | ## 1.0.7 5 | 6 | * [Added] Render block wrapper attributes 7 | * [Added] Support for block spacing 8 | 9 | ## 1.0.6 10 | 11 | * [Removed] `block_categories` deprecated filter 12 | * [Changed] Updated Composer dependencies 13 | 14 | ## 1.0.5 15 | 16 | * [Fixed] Deprecated filter name being used 17 | * [Fixed] Falsey values being casted to `true`, thanks to @dafydd-orphans 18 | 19 | ## 1.0.4 20 | 21 | * [Added] Possibility to load blocks from subfolders (block-name/template.php instead of the default block-name.php) 22 | * [Fixed] Error with invalid array key if file didn't have a block header 23 | * [Fixed] Hardcoded default blocks path 24 | * [Fixed] Missing Filesystem dependency, thanks to @joshuafredrickson 25 | 26 | ## 1.0.3 27 | 28 | * [Added] Filters for config 29 | * [Added] Possibility to load block from multiple locations 30 | 31 | ## 1.0.2 32 | 33 | * [Fixed] Invalid variable name 34 | 35 | ## 1.0.1 36 | 37 | * [Fixed] Block slug is nw properly used as html id attribute if no ACF field specified. 38 | * [Added] html_anchor field added to the top of the list of fields which can be used as html id attribute. 39 | 40 | ## 1.0.0 41 | 42 | Initial release 43 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Block Loader 2 | 3 | [![BracketSpace Micropackage](https://img.shields.io/badge/BracketSpace-Micropackage-brightgreen)](https://bracketspace.com) 4 | [![Latest Stable Version](https://poser.pugx.org/micropackage/block-loader/v/stable)](https://packagist.org/packages/micropackage/block-loader) 5 | [![PHP from Packagist](https://img.shields.io/packagist/php-v/micropackage/block-loader.svg)](https://packagist.org/packages/micropackage/block-loader) 6 | [![Total Downloads](https://poser.pugx.org/micropackage/block-loader/downloads)](https://packagist.org/packages/micropackage/block-loader) 7 | [![License](https://poser.pugx.org/micropackage/block-loader/license)](https://packagist.org/packages/micropackage/block-loader) 8 | 9 |

10 | Micropackage logo 11 |

12 | 13 | Requires WordPress >=5.8.0. 14 | 15 | ## 🧬 About Block Loader 16 | 17 | Block Loader loads the Gutenberg Block configuration directly out of the block template file. It parses the file header comment figuring out hwo to register the Block. 18 | 19 | Basically instead doing this: 20 | 21 | ```php 22 | acf_register_block_type( [ 23 | 'name' => 'sample-block', 24 | 'title' => __('Sample Block'), 25 | 'render_template' => 'blocks/sample-block.php', 26 | ] ); 27 | ``` 28 | 29 | You can do initialize the loader once: 30 | 31 | ```php 32 | Micropackage\BlockLoader\BlockLoader::init( [ 33 | 'dir' => 'blocks', 34 | ] ); 35 | ``` 36 | 37 | And define the block config directly in the template (`blocks/sample-block.php`): 38 | 39 | ``` 40 | 'blocks', 69 | 'categories' => [], 70 | 'wrap' => '
%1$s
', // ACF only 71 | ] ); 72 | ``` 73 | 74 | Blocks are based on the template files located by default in `blocks` folder in your theme (you can change that). 75 | 76 | There are two steps to create a block: 77 | 1. Create block template file in the `blocks` folder 78 | 2. Define custom fields for your block using ACF or Meta Box. 79 | 80 | Block template file needs to have a comment header containing block parameters. 81 | 82 | ``` 83 | 'some-block', 121 | 'type' => 'block', 122 | 'fields' => [ 123 | // ...fields configuration 124 | ], 125 | ]; 126 | 127 | return $meta_boxes; 128 | } ); 129 | ``` 130 | 131 | All block parameters will be fetched from template header comment and merged with your fields configuration. 132 | 133 | ## ⚙️ Configuration 134 | All parameters are optional. 135 | 136 | | Parameter | Type | Description | 137 | | -------------------------- | ----------------- | ------------------------------------------------------------ | 138 | | **dir** | (*string*) | This is a directory within your theme where block templates are located. Relative path.
**Default:** `'blocks'` | 139 | | **categories** | (*array*) | Array of custom block categories passed directly to [`block_categories_all`](https://developer.wordpress.org/reference/hooks/block_categories_all/) filter.
If only one category will be configured, it will be used as default category for all custom blocks.
**Default:** `[]` (empty array) | 140 | | **wrap** | (*false\|string*) | Wrapper to each block. If set to false, the block content will be just the template file content.
Works only for ACF due to the differences in block rendering mechanisms.
**Default:** `'
%1$s
'` | 141 | | `...$block_creator_params` | - | Additional parameters passed to [ACF Block Creator](https://github.com/micropackage/acf-block-creator/) | 142 | 143 | ### Categories definition 144 | 145 | This is how to define the categories array. 146 | 147 | ```php 148 | ... 149 | 'categories' => [ 150 | [ 151 | 'slug' => 'custom-cat', 152 | 'title' => __( 'Custom Category', 'textdomain' ), 153 | 'icon' => 'book-alt', 154 | ], 155 | ... 156 | ], 157 | ... 158 | ``` 159 | 160 | ### Wrap template 161 | 162 | Parameters used in internal `sprintf`: 163 | 164 | 1. block content from template file, which should be wrapped 165 | 2. block classes string 166 | 3. unique block id 167 | 168 | Example: `'
%1$s
'` 169 | 170 | ## 📦 About the Micropackage project 171 | 172 | Micropackages - as the name suggests - are micro packages with a tiny bit of reusable code, helpful particularly in WordPress development. 173 | 174 | The aim is to have multiple packages which can be put together to create something bigger by defining only the structure. 175 | 176 | Micropackages are maintained by [BracketSpace](https://bracketspace.com). 177 | 178 | ## 📖 Changelog 179 | 180 | [See the changelog file](./CHANGELOG.md). 181 | 182 | ## 📃 License 183 | 184 | GNU General Public License (GPL) v3.0. See the [LICENSE](./LICENSE) file for more information. 185 | 186 | ## © Credits 187 | 188 | The Loader engine is based on the [palmiak](https://github.com/palmiak)'s [Timber ACF WP Blocks](https://github.com/palmiak/timber-acf-wp-blocks). 189 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "micropackage/block-loader", 3 | "description": "Block Loader - automatic Gutenberg blocks from template files.", 4 | "license": "GPL-3.0-or-later", 5 | "authors": [ 6 | { 7 | "name": "Jakub Mikita", 8 | "email": "jakub@bracketspace.com" 9 | }, 10 | { 11 | "name": "Wojtek Szałkiewicz", 12 | "email": "wojtek@szalkiewicz.pl" 13 | } 14 | ], 15 | "scripts": { 16 | "phpcs": "phpcs", 17 | "phpcbf": "phpcbf" 18 | }, 19 | "require": { 20 | "php": ">=5.6", 21 | "micropackage/singleton": "^1.1", 22 | "micropackage/dochooks": "^1.0", 23 | "micropackage/filesystem": "^1.1" 24 | }, 25 | "require-dev": { 26 | "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0", 27 | "phpcompatibility/php-compatibility": "^9.1", 28 | "wp-coding-standards/wpcs": "^2.0" 29 | }, 30 | "autoload": { 31 | "psr-4" : { 32 | "Micropackage\\BlockLoader\\" : "src" 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /composer.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_readme": [ 3 | "This file locks the dependencies of your project to a known state", 4 | "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", 5 | "This file is @generated automatically" 6 | ], 7 | "content-hash": "6b0f6312ea46daca0a8c025d268f0aba", 8 | "packages": [ 9 | { 10 | "name": "micropackage/dochooks", 11 | "version": "1.1.1", 12 | "source": { 13 | "type": "git", 14 | "url": "https://github.com/micropackage/dochooks.git", 15 | "reference": "b214c86e334d1ac2680d2c2dfba81425999d8622" 16 | }, 17 | "dist": { 18 | "type": "zip", 19 | "url": "https://api.github.com/repos/micropackage/dochooks/zipball/b214c86e334d1ac2680d2c2dfba81425999d8622", 20 | "reference": "b214c86e334d1ac2680d2c2dfba81425999d8622", 21 | "shasum": "" 22 | }, 23 | "require": { 24 | "micropackage/singleton": "^1.1", 25 | "php": ">=5.6" 26 | }, 27 | "require-dev": { 28 | "dealerdirect/phpcodesniffer-composer-installer": "^0.7", 29 | "phpcompatibility/php-compatibility": "^9.3", 30 | "wp-coding-standards/wpcs": "^2.3" 31 | }, 32 | "bin": [ 33 | "bin/dump-hooks" 34 | ], 35 | "type": "library", 36 | "autoload": { 37 | "psr-4": { 38 | "Micropackage\\DocHooks\\": "src" 39 | } 40 | }, 41 | "notification-url": "https://packagist.org/downloads/", 42 | "license": [ 43 | "GPL-3.0-or-later" 44 | ], 45 | "authors": [ 46 | { 47 | "name": "Jakub Mikita", 48 | "email": "jakub@bracketspace.com" 49 | } 50 | ], 51 | "description": "DocHooks - annotated WordPress hooks", 52 | "support": { 53 | "issues": "https://github.com/micropackage/dochooks/issues", 54 | "source": "https://github.com/micropackage/dochooks/tree/1.1.1" 55 | }, 56 | "time": "2021-07-22T13:40:45+00:00" 57 | }, 58 | { 59 | "name": "micropackage/filesystem", 60 | "version": "1.1.4", 61 | "source": { 62 | "type": "git", 63 | "url": "https://github.com/micropackage/filesystem.git", 64 | "reference": "fb643749ff282bf9d057caf9903ab17c5deceb33" 65 | }, 66 | "dist": { 67 | "type": "zip", 68 | "url": "https://api.github.com/repos/micropackage/filesystem/zipball/fb643749ff282bf9d057caf9903ab17c5deceb33", 69 | "reference": "fb643749ff282bf9d057caf9903ab17c5deceb33", 70 | "shasum": "" 71 | }, 72 | "require": { 73 | "php": ">=5.6" 74 | }, 75 | "require-dev": { 76 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 77 | "phpcompatibility/php-compatibility": "^9.1", 78 | "phpunit/phpunit": "^6.5.5", 79 | "wp-coding-standards/wpcs": "^2.0" 80 | }, 81 | "type": "library", 82 | "autoload": { 83 | "psr-4": { 84 | "Micropackage\\Filesystem\\": "src" 85 | } 86 | }, 87 | "notification-url": "https://packagist.org/downloads/", 88 | "license": [ 89 | "GPL-3.0-or-later" 90 | ], 91 | "authors": [ 92 | { 93 | "name": "Jakub Mikita", 94 | "email": "jakub@bracketspace.com" 95 | } 96 | ], 97 | "description": "Wrapper for WordPress' Filesystem for easier file manipulations.", 98 | "support": { 99 | "issues": "https://github.com/micropackage/filesystem/issues", 100 | "source": "https://github.com/micropackage/filesystem/tree/1.1.4" 101 | }, 102 | "time": "2021-10-29T14:01:09+00:00" 103 | }, 104 | { 105 | "name": "micropackage/singleton", 106 | "version": "1.1.1", 107 | "source": { 108 | "type": "git", 109 | "url": "https://github.com/micropackage/singleton.git", 110 | "reference": "594b5a857ee42149e6b01e8a353e5aaee52e726d" 111 | }, 112 | "dist": { 113 | "type": "zip", 114 | "url": "https://api.github.com/repos/micropackage/singleton/zipball/594b5a857ee42149e6b01e8a353e5aaee52e726d", 115 | "reference": "594b5a857ee42149e6b01e8a353e5aaee52e726d", 116 | "shasum": "" 117 | }, 118 | "require": { 119 | "php": ">=5.6" 120 | }, 121 | "require-dev": { 122 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 123 | "phpcompatibility/php-compatibility": "^9.1", 124 | "wp-coding-standards/wpcs": "^2.0" 125 | }, 126 | "type": "library", 127 | "autoload": { 128 | "psr-4": { 129 | "Micropackage\\Singleton\\": "src" 130 | } 131 | }, 132 | "notification-url": "https://packagist.org/downloads/", 133 | "license": [ 134 | "GPL-3.0-or-later" 135 | ], 136 | "authors": [ 137 | { 138 | "name": "Jakub Mikita", 139 | "email": "jakub@bracketspace.com" 140 | } 141 | ], 142 | "description": "Singleton implementation", 143 | "support": { 144 | "issues": "https://github.com/micropackage/singleton/issues", 145 | "source": "https://github.com/micropackage/singleton/tree/1.1.1" 146 | }, 147 | "time": "2022-01-25T19:59:48+00:00" 148 | } 149 | ], 150 | "packages-dev": [ 151 | { 152 | "name": "dealerdirect/phpcodesniffer-composer-installer", 153 | "version": "v0.7.2", 154 | "source": { 155 | "type": "git", 156 | "url": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer.git", 157 | "reference": "1c968e542d8843d7cd71de3c5c9c3ff3ad71a1db" 158 | }, 159 | "dist": { 160 | "type": "zip", 161 | "url": "https://api.github.com/repos/Dealerdirect/phpcodesniffer-composer-installer/zipball/1c968e542d8843d7cd71de3c5c9c3ff3ad71a1db", 162 | "reference": "1c968e542d8843d7cd71de3c5c9c3ff3ad71a1db", 163 | "shasum": "" 164 | }, 165 | "require": { 166 | "composer-plugin-api": "^1.0 || ^2.0", 167 | "php": ">=5.3", 168 | "squizlabs/php_codesniffer": "^2.0 || ^3.1.0 || ^4.0" 169 | }, 170 | "require-dev": { 171 | "composer/composer": "*", 172 | "php-parallel-lint/php-parallel-lint": "^1.3.1", 173 | "phpcompatibility/php-compatibility": "^9.0" 174 | }, 175 | "type": "composer-plugin", 176 | "extra": { 177 | "class": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin" 178 | }, 179 | "autoload": { 180 | "psr-4": { 181 | "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/" 182 | } 183 | }, 184 | "notification-url": "https://packagist.org/downloads/", 185 | "license": [ 186 | "MIT" 187 | ], 188 | "authors": [ 189 | { 190 | "name": "Franck Nijhof", 191 | "email": "franck.nijhof@dealerdirect.com", 192 | "homepage": "http://www.frenck.nl", 193 | "role": "Developer / IT Manager" 194 | }, 195 | { 196 | "name": "Contributors", 197 | "homepage": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer/graphs/contributors" 198 | } 199 | ], 200 | "description": "PHP_CodeSniffer Standards Composer Installer Plugin", 201 | "homepage": "http://www.dealerdirect.com", 202 | "keywords": [ 203 | "PHPCodeSniffer", 204 | "PHP_CodeSniffer", 205 | "code quality", 206 | "codesniffer", 207 | "composer", 208 | "installer", 209 | "phpcbf", 210 | "phpcs", 211 | "plugin", 212 | "qa", 213 | "quality", 214 | "standard", 215 | "standards", 216 | "style guide", 217 | "stylecheck", 218 | "tests" 219 | ], 220 | "support": { 221 | "issues": "https://github.com/dealerdirect/phpcodesniffer-composer-installer/issues", 222 | "source": "https://github.com/dealerdirect/phpcodesniffer-composer-installer" 223 | }, 224 | "time": "2022-02-04T12:51:07+00:00" 225 | }, 226 | { 227 | "name": "phpcompatibility/php-compatibility", 228 | "version": "9.3.5", 229 | "source": { 230 | "type": "git", 231 | "url": "https://github.com/PHPCompatibility/PHPCompatibility.git", 232 | "reference": "9fb324479acf6f39452e0655d2429cc0d3914243" 233 | }, 234 | "dist": { 235 | "type": "zip", 236 | "url": "https://api.github.com/repos/PHPCompatibility/PHPCompatibility/zipball/9fb324479acf6f39452e0655d2429cc0d3914243", 237 | "reference": "9fb324479acf6f39452e0655d2429cc0d3914243", 238 | "shasum": "" 239 | }, 240 | "require": { 241 | "php": ">=5.3", 242 | "squizlabs/php_codesniffer": "^2.3 || ^3.0.2" 243 | }, 244 | "conflict": { 245 | "squizlabs/php_codesniffer": "2.6.2" 246 | }, 247 | "require-dev": { 248 | "phpunit/phpunit": "~4.5 || ^5.0 || ^6.0 || ^7.0" 249 | }, 250 | "suggest": { 251 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.", 252 | "roave/security-advisories": "dev-master || Helps prevent installing dependencies with known security issues." 253 | }, 254 | "type": "phpcodesniffer-standard", 255 | "notification-url": "https://packagist.org/downloads/", 256 | "license": [ 257 | "LGPL-3.0-or-later" 258 | ], 259 | "authors": [ 260 | { 261 | "name": "Wim Godden", 262 | "homepage": "https://github.com/wimg", 263 | "role": "lead" 264 | }, 265 | { 266 | "name": "Juliette Reinders Folmer", 267 | "homepage": "https://github.com/jrfnl", 268 | "role": "lead" 269 | }, 270 | { 271 | "name": "Contributors", 272 | "homepage": "https://github.com/PHPCompatibility/PHPCompatibility/graphs/contributors" 273 | } 274 | ], 275 | "description": "A set of sniffs for PHP_CodeSniffer that checks for PHP cross-version compatibility.", 276 | "homepage": "http://techblog.wimgodden.be/tag/codesniffer/", 277 | "keywords": [ 278 | "compatibility", 279 | "phpcs", 280 | "standards" 281 | ], 282 | "support": { 283 | "issues": "https://github.com/PHPCompatibility/PHPCompatibility/issues", 284 | "source": "https://github.com/PHPCompatibility/PHPCompatibility" 285 | }, 286 | "time": "2019-12-27T09:44:58+00:00" 287 | }, 288 | { 289 | "name": "squizlabs/php_codesniffer", 290 | "version": "3.6.2", 291 | "source": { 292 | "type": "git", 293 | "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", 294 | "reference": "5e4e71592f69da17871dba6e80dd51bce74a351a" 295 | }, 296 | "dist": { 297 | "type": "zip", 298 | "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/5e4e71592f69da17871dba6e80dd51bce74a351a", 299 | "reference": "5e4e71592f69da17871dba6e80dd51bce74a351a", 300 | "shasum": "" 301 | }, 302 | "require": { 303 | "ext-simplexml": "*", 304 | "ext-tokenizer": "*", 305 | "ext-xmlwriter": "*", 306 | "php": ">=5.4.0" 307 | }, 308 | "require-dev": { 309 | "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" 310 | }, 311 | "bin": [ 312 | "bin/phpcs", 313 | "bin/phpcbf" 314 | ], 315 | "type": "library", 316 | "extra": { 317 | "branch-alias": { 318 | "dev-master": "3.x-dev" 319 | } 320 | }, 321 | "notification-url": "https://packagist.org/downloads/", 322 | "license": [ 323 | "BSD-3-Clause" 324 | ], 325 | "authors": [ 326 | { 327 | "name": "Greg Sherwood", 328 | "role": "lead" 329 | } 330 | ], 331 | "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", 332 | "homepage": "https://github.com/squizlabs/PHP_CodeSniffer", 333 | "keywords": [ 334 | "phpcs", 335 | "standards" 336 | ], 337 | "support": { 338 | "issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues", 339 | "source": "https://github.com/squizlabs/PHP_CodeSniffer", 340 | "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki" 341 | }, 342 | "time": "2021-12-12T21:44:58+00:00" 343 | }, 344 | { 345 | "name": "wp-coding-standards/wpcs", 346 | "version": "2.3.0", 347 | "source": { 348 | "type": "git", 349 | "url": "https://github.com/WordPress/WordPress-Coding-Standards.git", 350 | "reference": "7da1894633f168fe244afc6de00d141f27517b62" 351 | }, 352 | "dist": { 353 | "type": "zip", 354 | "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/7da1894633f168fe244afc6de00d141f27517b62", 355 | "reference": "7da1894633f168fe244afc6de00d141f27517b62", 356 | "shasum": "" 357 | }, 358 | "require": { 359 | "php": ">=5.4", 360 | "squizlabs/php_codesniffer": "^3.3.1" 361 | }, 362 | "require-dev": { 363 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || ^0.6", 364 | "phpcompatibility/php-compatibility": "^9.0", 365 | "phpcsstandards/phpcsdevtools": "^1.0", 366 | "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" 367 | }, 368 | "suggest": { 369 | "dealerdirect/phpcodesniffer-composer-installer": "^0.6 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically." 370 | }, 371 | "type": "phpcodesniffer-standard", 372 | "notification-url": "https://packagist.org/downloads/", 373 | "license": [ 374 | "MIT" 375 | ], 376 | "authors": [ 377 | { 378 | "name": "Contributors", 379 | "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors" 380 | } 381 | ], 382 | "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions", 383 | "keywords": [ 384 | "phpcs", 385 | "standards", 386 | "wordpress" 387 | ], 388 | "support": { 389 | "issues": "https://github.com/WordPress/WordPress-Coding-Standards/issues", 390 | "source": "https://github.com/WordPress/WordPress-Coding-Standards", 391 | "wiki": "https://github.com/WordPress/WordPress-Coding-Standards/wiki" 392 | }, 393 | "time": "2020-05-13T23:57:56+00:00" 394 | } 395 | ], 396 | "aliases": [], 397 | "minimum-stability": "stable", 398 | "stability-flags": [], 399 | "prefer-stable": false, 400 | "prefer-lowest": false, 401 | "platform": { 402 | "php": ">=5.6" 403 | }, 404 | "platform-dev": [], 405 | "plugin-api-version": "2.0.0" 406 | } 407 | -------------------------------------------------------------------------------- /phpcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | . 37 | 38 | 39 | 40 | 41 | tests/* 42 | vendor/* 43 | 44 | -------------------------------------------------------------------------------- /src/BlockLoader.php: -------------------------------------------------------------------------------- 1 | 'Block Name', 45 | 'description' => 'Description', 46 | 'category' => 'Category', 47 | 'icon' => 'Icon', 48 | 'keywords' => 'Keywords', 49 | 'post_types' => 'Post Types', 50 | 'mode' => 'Mode', 51 | 'align' => 'Align', 52 | 'context' => 'Context', 53 | 'enqueue_style' => 'Enqueue Style', 54 | 'enqueue_script' => 'Enqueue Script', 55 | 'enqueue_assets' => 'Enqueue Assets', 56 | 'supports_align' => 'Supports Align', 57 | 'supports_anchor' => 'Supports Anchor', 58 | 'supports_customClassName' => 'Supports Custom Class Name', 59 | 'supports_mode' => 'Supports Mode', 60 | 'supports_multiple' => 'Supports Multiple', 61 | 'supports_reusable' => 'Supports Reusable', 62 | 'supports_spacing' => 'Supports Spacing', 63 | ]; 64 | 65 | /** 66 | * Block IDs 67 | * 68 | * @var array 69 | */ 70 | private $block_ids = []; 71 | 72 | /** 73 | * Root directory 74 | * 75 | * @var string 76 | */ 77 | private $root_dir; 78 | 79 | /** 80 | * Constructs Block Loader 81 | * 82 | * @since 1.0.0 83 | * @param array $config Configuration array. 84 | */ 85 | protected function __construct( $config ) { 86 | $this->config = apply_filters( 87 | 'micropackage/block-loader/config', 88 | wp_parse_args( $config, [ 89 | 'dir' => 'blocks', 90 | 'categories' => [], 91 | 'wrap' => $this->supports_block_wrapper_attributes() 92 | ? '
%1$s
' 93 | : '
%1$s
', 94 | 'default_category' => false, 95 | 'root_dir' => get_stylesheet_directory(), 96 | ] ) 97 | ); 98 | 99 | $this->root_dir = apply_filters( 'micropackage/block-loader/root-dir', $this->config['root_dir'] ); 100 | 101 | if ( false === $this->config['default_category'] && 102 | is_array( $this->categories ) && 103 | 1 === count( $this->categories ) && isset( $this->categories[0]['slug'] ) 104 | ) { 105 | $this->default_category = $this->categories[0]['slug']; 106 | } 107 | 108 | if ( class_exists( ACFBlockCreator::class ) ) { 109 | $block_creator_config = array_filter( $this->config, function( $value, $key ) { 110 | return in_array( $key, [ 111 | 'blocks_dir', 112 | 'scss_dir', 113 | 'block_container_class', 114 | 'default_category', 115 | 'package', 116 | 'license', 117 | 'root_dir', 118 | ], true ); 119 | }, ARRAY_FILTER_USE_BOTH ); 120 | 121 | ACFBlockCreator::init( $block_creator_config ); 122 | } 123 | 124 | Helper::hook( $this ); 125 | } 126 | 127 | /** 128 | * Registers ACF blocks 129 | * 130 | * @action acf/init 131 | * 132 | * @since 1.0.0 133 | * @return void 134 | */ 135 | public function register_acf_blocks() { 136 | if ( ! function_exists( 'acf_register_block_type' ) ) { 137 | return; 138 | } 139 | 140 | foreach ( $this->get_blocks() as $block ) { 141 | $block['render_callback'] = [ $this, 'render_block' ]; 142 | 143 | if ( ! isset( $block['mode'] ) ) { 144 | $block['mode'] = 'edit'; 145 | } 146 | 147 | acf_register_block_type( $block ); 148 | } 149 | } 150 | 151 | /** 152 | * Registers Meta Box blocks 153 | * 154 | * @filter rwmb_meta_boxes 100 155 | * 156 | * @since 1.0.0 157 | * @param array $meta_boxes Meta Boxes config. 158 | * @return array 159 | */ 160 | public function register_metabox_blocks( $meta_boxes ) { 161 | if ( function_exists( 'acf_register_block_type' ) || ! function_exists( 'mb_blocks_load' ) ) { 162 | return $meta_boxes; 163 | } 164 | 165 | $blocks = $this->get_blocks(); 166 | 167 | foreach ( $meta_boxes as &$meta_box ) { 168 | if ( ! isset( $meta_box['type'] ) || 'block' !== $meta_box['type'] ) { 169 | continue; 170 | } 171 | 172 | if ( isset( $meta_box['id'] ) && isset( $blocks[ $meta_box['id'] ] ) ) { 173 | $block = $blocks[ $meta_box['id'] ]; 174 | $block['render_template'] = $block['template_file']; 175 | $meta_box = array_merge( $meta_box, $block ); 176 | } 177 | } 178 | 179 | return $meta_boxes; 180 | } 181 | 182 | /** 183 | * Gets blocks list 184 | * 185 | * @since 1.0.0 186 | * @return array 187 | */ 188 | public function get_blocks() { 189 | $paths = apply_filters( 190 | 'micropackage/block-loader/paths', 191 | [ wp_normalize_path( "{$this->root_dir}/{$this->config['dir']}" ) ] 192 | ); 193 | 194 | $blocks = []; 195 | 196 | foreach ( $paths as $path ) { 197 | $blocks = array_merge( $blocks, $this->get_blocks_from_path( $path ) ); 198 | } 199 | 200 | return $blocks; 201 | } 202 | 203 | /** 204 | * Get blocks list from specified path 205 | * 206 | * @param string $path Path. 207 | * @return array Blocks. 208 | */ 209 | private function get_blocks_from_path( $path ) { 210 | $fs = new Filesystem( $path ); 211 | $files = $fs->dirlist( '/' ); 212 | $blocks = []; 213 | 214 | if ( $files ) { 215 | foreach ( $files as $file ) { 216 | if ( $fs->is_file( $file['name'] ) ) { 217 | $filename = $file['name']; 218 | } elseif ( $fs->is_file( "{$file['name']}/template.php" ) ) { 219 | $filename = "{$file['name']}/template.php"; 220 | } else { 221 | continue; 222 | } 223 | 224 | $filepath = $fs->path( $filename ); 225 | $data = $this->get_block_data( $filepath ); 226 | $slug = basename( $file['name'], '.php' ); 227 | 228 | if ( ! isset( $data['title'] ) ) { 229 | continue; 230 | } 231 | 232 | $data = array_merge( $data, [ 233 | 'name' => $slug, 234 | 'slug' => $slug, 235 | 'template_file' => $filepath, 236 | ] ); 237 | 238 | if ( ! isset( $data['category'] ) && $this->default_category ) { 239 | $data['category'] = $this->default_category; 240 | } 241 | 242 | $blocks[ $slug ] = apply_filters( 'micropackage/block-loader/block-params', $data ); 243 | } 244 | } 245 | 246 | return $blocks; 247 | } 248 | 249 | /** 250 | * Retrives block data from file header 251 | * 252 | * @since 1.0.0 253 | * @param string $file File name. 254 | * @return array 255 | */ 256 | public function get_block_data( $file ) { 257 | $data = array_filter( get_file_data( $file, $this->headers ) ); 258 | $supports = []; 259 | 260 | foreach ( $data as $key => &$value ) { 261 | if ( in_array( $key, [ 'keywords', 'post_types', 'supports_align' ], true ) ) { 262 | $value = $this->parse_coma_separated_list( $value ); 263 | } elseif ( 'supports_spacing' === $key && 'true' === $value ) { 264 | $value = [ 'margin' => true, 'padding' => true ]; 265 | } elseif ( in_array( $value, [ 'true', 'false' ], true ) ) { 266 | $value = ( 'true' === $value ) ? true : false; 267 | } 268 | 269 | if ( 0 === strpos( $key, 'supports_' ) ) { 270 | $new_key = substr( $key, 9 ); 271 | $supports[ $new_key ] = $value; 272 | 273 | unset( $data[ $key ] ); 274 | } 275 | } 276 | 277 | if ( ! empty( $supports ) ) { 278 | $data['supports'] = $supports; 279 | } 280 | 281 | return $data; 282 | } 283 | 284 | /** 285 | * Parses string with coma-separated values into array 286 | * 287 | * @since 1.0.0 288 | * @param string $string Input string. 289 | * @return array 290 | */ 291 | public function parse_coma_separated_list( $string ) { 292 | $array = explode( ',', $string ); 293 | 294 | array_walk( $array, function( &$value ) { 295 | $value = trim( $value ); 296 | } ); 297 | 298 | return $array; 299 | } 300 | 301 | /** 302 | * Creates unique block id 303 | * 304 | * @since 1.0.0 305 | * @param string $id Default block ID. 306 | * @return string 307 | */ 308 | public function get_unique_block_id( $id ) { 309 | $fields = [ 310 | 'html_anchor', 311 | 'title', 312 | 'headline', 313 | 'heading', 314 | 'header', 315 | ]; 316 | 317 | foreach ( $fields as $key ) { 318 | $temp_id = get_field( $key ); 319 | 320 | if ( $temp_id ) { 321 | $id = sanitize_title( $temp_id ); 322 | break; 323 | } 324 | } 325 | 326 | if ( array_key_exists( $id, $this->block_ids ) ) { 327 | $this->block_ids[ $id ]++; 328 | $id = "{$id}-{$this->block_ids[ $id ]}"; 329 | } else { 330 | $this->block_ids[ $id ] = 1; 331 | } 332 | 333 | return $id; 334 | } 335 | 336 | /** 337 | * Registers custom block category. 338 | * 339 | * @filter block_categories_all 340 | * 341 | * @since 1.0.0 342 | * @param array $categories Block categories. 343 | * @param \WP_Block_Editor_Context $context Block editor context. 344 | */ 345 | public function block_categories( $categories, $context ) { 346 | if ( $this->categories ) { 347 | $categories = array_merge( $categories, $this->categories ); 348 | } 349 | 350 | return $categories; 351 | } 352 | 353 | /** 354 | * Block render callback 355 | * 356 | * @since 1.0.0 357 | * @param array $block Block data. 358 | * @return void 359 | */ 360 | public function render_block( $block ) { 361 | if ( ! isset( $block['template_file'] ) || ! is_file( $block['template_file'] ) ) { 362 | return; 363 | } 364 | 365 | ob_start(); 366 | 367 | include $block['template_file']; 368 | 369 | $block_content = ob_get_clean(); 370 | 371 | $wrap = apply_filters( 'micropackage/block-loader/block-wrap', (bool) $this->wrap, $block ); 372 | 373 | if ( false !== $wrap ) { 374 | $classes = [ 375 | 'block', 376 | $block['slug'], 377 | ]; 378 | 379 | if ( $block['align'] ) { 380 | $classes[] = "align{$block['align']}"; 381 | } 382 | 383 | if ( isset( $block['className'] ) ) { 384 | $classes[] = $block['className']; 385 | } 386 | 387 | $class = implode( ' ', apply_filters( 'micropackage/block-loader/block-classes', $classes, $block ) ); 388 | $wrap_html = apply_filters( 'micropackage/block-loader/block-wrap-html', $this->wrap, $block ); 389 | 390 | // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped 391 | printf( 392 | $wrap_html, 393 | $block_content, 394 | esc_attr( $class ), 395 | esc_attr( $this->get_unique_block_id( $block['slug'] ) ), 396 | $this->supports_block_wrapper_attributes() 397 | ? get_block_wrapper_attributes( [ 'class' => $class ] ) 398 | : '' 399 | ); 400 | } else { 401 | echo $block_content; 402 | // phpcs:enable 403 | } 404 | } 405 | 406 | /** 407 | * Checks whether WordPress supports block wrapper attributes. 408 | * 409 | * @since 1.0.7 410 | * @return bool 411 | */ 412 | protected function supports_block_wrapper_attributes() { 413 | return function_exists( 'get_block_wrapper_attributes' ); 414 | } 415 | 416 | /** 417 | * Magic config getter 418 | * 419 | * @since 1.0.0 420 | * @param string $key Key. 421 | * @return mixed 422 | */ 423 | public function __get( $key ) { 424 | if ( isset( $this->config[ $key ] ) ) { 425 | return $this->config[ $key ]; 426 | } 427 | } 428 | 429 | /** 430 | * Magic config setter 431 | * 432 | * @since 1.0.0 433 | * @param string $key Key. 434 | * @param mixed $value Value. 435 | * @return void 436 | */ 437 | public function __set( $key, $value ) { 438 | $this->config[ $key ] = $value; 439 | } 440 | } 441 | --------------------------------------------------------------------------------