<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[50419] trunk/src/wp-includes: Docs: Improve documentation for `WP_Block_Type` properties.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/50419">50419</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/50419","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-02-23 19:16:26 +0000 (Tue, 23 Feb 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve documentation for `WP_Block_Type` properties.
Add a reference to `WP_Block_Type::__construct()` for information on accepted arguments in `register_block_type()`.
Synchronize the documentation between several places, use `WP_Block_Type::__construct()` as the canonical source.
Props ediamin, audrasjb, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/48640">#48640</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunksrcwpincludesclasswpblocktyperegistryphp">trunk/src/wp-includes/class-wp-block-type-registry.php</a></li>
<li><a href="#trunksrcwpincludesclasswpblocktypephp">trunk/src/wp-includes/class-wp-block-type.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/blocks.php 2021-02-23 18:39:13 UTC (rev 50418)
+++ trunk/src/wp-includes/blocks.php 2021-02-23 19:16:26 UTC (rev 50419)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,13 +15,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|WP_Block_Type $name Block type name including namespace, or alternatively
</span><span class="cx" style="display: block; padding: 0 10px"> * a complete WP_Block_Type instance. In case a WP_Block_Type
</span><span class="cx" style="display: block; padding: 0 10px"> * is provided, the $args parameter will be ignored.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args {
- * Optional. Array of block type arguments. Accepts any public property of `WP_Block_Type`.
- * Any arguments may be defined, however the ones described below are supported by default.
- * Default empty array.
- *
- * @type callable $render_callback Callback used to render blocks of this block type.
- * }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Array of block type arguments. Accepts any public property
+ * of `WP_Block_Type`. See WP_Block_Type::__construct() for information
+ * on accepted arguments. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Block_Type|false The registered block type on success, or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function register_block_type( $name, $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -190,13 +186,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $file_or_folder Path to the JSON file with metadata definition for
</span><span class="cx" style="display: block; padding: 0 10px"> * the block or path to the folder where the `block.json` file is located.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args {
- * Optional. Array of block type arguments. Accepts any public property of `WP_Block_Type`.
- * Any arguments may be defined, however the ones described below are supported by default.
- * Default empty array.
- *
- * @type callable $render_callback Callback used to render blocks of this block type.
- * }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Array of block type arguments. Accepts any public property
+ * of `WP_Block_Type`. See WP_Block_Type::__construct() for information
+ * on accepted arguments. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Block_Type|false The registered block type on success, or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function register_block_type_from_metadata( $file_or_folder, $args = array() ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpblocktyperegistryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-block-type-registry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-type-registry.php 2021-02-23 18:39:13 UTC (rev 50418)
+++ trunk/src/wp-includes/class-wp-block-type-registry.php 2021-02-23 19:16:26 UTC (rev 50419)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,17 +34,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see WP_Block_Type::__construct()
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string|WP_Block_Type $name Block type name including namespace, or alternatively
</span><span class="cx" style="display: block; padding: 0 10px"> * a complete WP_Block_Type instance. In case a WP_Block_Type
</span><span class="cx" style="display: block; padding: 0 10px"> * is provided, the $args parameter will be ignored.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args {
- * Optional. Array of block type arguments. Accepts any public property of `WP_Block_Type`.
- * Any arguments may be defined, however the ones described below are supported by default.
- * Default empty array.
- *
- * @type callable $render_callback Callback used to render blocks of this block type.
- * @type array $attributes Block attributes mapping, property name to schema.
- * }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Array of block type arguments. Accepts any public property
+ * of `WP_Block_Type`. See WP_Block_Type::__construct() for information
+ * on accepted arguments. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Block_Type|false The registered block type on success, or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register( $name, $args = array() ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpblocktypephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-block-type.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-type.php 2021-02-23 18:39:13 UTC (rev 50418)
+++ trunk/src/wp-includes/class-wp-block-type.php 2021-02-23 19:16:26 UTC (rev 50419)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,6 +33,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $name;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Human-readable block type label.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,6 +41,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $title = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Block type category classification, used in search interfaces
+ * to arrange block types by category.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,6 +50,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $category = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Setting parent lets a block require that it is only available
+ * when nested within the specified blocks.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,6 +59,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $parent = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Block type icon.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,6 +67,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $icon = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A detailed block type description.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,6 +75,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $description = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Additional keywords to produce block type as result
+ * in search interfaces.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,6 +84,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $keywords = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The translation textdomain.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,6 +92,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $textdomain = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Alternative block styles.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,6 +100,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $styles = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Supported features.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,6 +108,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $supports = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Structured data for the block preview.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,8 +189,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see register_block_type()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $block_type Block type name including namespace.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array|string $args Optional. Array or string of arguments for registering a block type.
- * Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array|string $args {
+ * Optional. Array or string of arguments for registering a block type. Any arguments may be defined,
+ * however the ones described below are supported by default. Default empty array.
+ *
+ *
+ * @type string $title Human-readable block type label.
+ * @type string|null $category Block type category classification, used in
+ * search interfaces to arrange block types by category.
+ * @type array|null $parent Setting parent lets a block require that it is only
+ * available when nested within the specified blocks.
+ * @type string|null $icon Block type icon.
+ * @type string $description A detailed block type description.
+ * @type array $keywords Additional keywords to produce block type as
+ * result in search interfaces.
+ * @type string|null $textdomain The translation textdomain.
+ * @type array $styles Alternative block styles.
+ * @type array|null $supports Supported features.
+ * @type array|null $example Structured data for the block preview.
+ * @type callable|null $render_callback Block type render callback.
+ * @type array|null $attributes Block type attributes property schemas.
+ * @type array $uses_context Context values inherited by blocks of this type.
+ * @type array|null $provides_context Context provided by blocks of this type.
+ * @type string|null $editor_script Block type editor script handle.
+ * @type string|null $script Block type front end script handle.
+ * @type string|null $editor_style Block type editor style handle.
+ * @type string|null $style Block type front end style handle.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $block_type, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->name = $block_type;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -259,6 +307,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args Array or string of arguments for registering a block type.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * See WP_Block_Type::__construct() for information on accepted arguments.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function set_props( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args(
</span></span></pre>
</div>
</div>
</body>
</html>