<!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>[46111] trunk/src: Block Editor: Backport block styles server functions from block editor.</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/46111">46111</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/46111","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorgefilipecosta</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-14 18:20:58 +0000 (Sat, 14 Sep 2019)</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'>Block Editor: Backport block styles server functions from block editor.
This commit backports the block styles functionality added to the block editor in https://github.com/WordPress/gutenberg/pull/16356.
Props: youknowriad, aduth, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/48039">#48039</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpblockstylesregistryphp">trunk/src/wp-includes/class-wp-block-styles-registry.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 2019-09-14 16:46:26 UTC (rev 46110)
+++ trunk/src/wp-includes/blocks.php 2019-09-14 18:20:58 UTC (rev 46111)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -356,3 +356,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function block_version( $content ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return has_blocks( $content ) ? 1 : 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">+
+/**
+ * Registers a new block style.
+ *
+ * @since 5.3.0
+ *
+ * @param string $block_name Block type name including namespace.
+ * @param array $style_properties Array containing the properties of the style name, label, style (name of the stylesheet to be enqueued), inline_style (string containing the CSS to be added).
+ *
+ * @return boolean True if the block style was registered with success and false otherwise.
+ */
+function register_block_style( $block_name, $style_properties ) {
+ return WP_Block_Styles_Registry::get_instance()->register( $block_name, $style_properties );
+}
+
+/**
+ * Unregisters a block style.
+ *
+ * @since 5.3.0
+ *
+ * @param string $block_name Block type name including namespace.
+ * @param array $block_style_name Block style name.
+ *
+ * @return boolean True if the block style was unregistered with success and false otherwise.
+ */
+function unregister_block_style( $block_name, $block_style_name ) {
+ return WP_Block_Styles_Registry::get_instance()->unregister( $block_name, $block_style_name );
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesclasswpblockstylesregistryphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/class-wp-block-styles-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-styles-registry.php (rev 0)
+++ trunk/src/wp-includes/class-wp-block-styles-registry.php 2019-09-14 18:20:58 UTC (rev 46111)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,161 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Blocks API: WP_Block_Styles_Registry class
+ *
+ * @package Gutenberg
+ * @since 5.3.0
+ */
+
+/**
+ * Class used for interacting with block styles.
+ *
+ * @since 5.3.0
+ */
+final class WP_Block_Styles_Registry {
+ /**
+ * Registered block styles, as `$block_name => $block_style_name => $block_style_properties` multidimensional arrays.
+ *
+ * @since 5.3.0
+ * @var array
+ */
+ private $registered_block_styles = array();
+
+ /**
+ * Container for the main instance of the class.
+ *
+ * @since 5.3.0
+ * @var WP_Block_Styles_Registry|null
+ */
+ private static $instance = null;
+
+ /**
+ * Registers a block style.
+ *
+ * @since 5.3.0
+ *
+ * @param string $block_name Block type name including namespace.
+ * @param array $style_properties Array containing the properties of the style name, label, style (name of the stylesheet to be enqueued), inline_style (string containing the CSS to be added).
+ *
+ * @return boolean True if the block style was registered with success and false otherwise.
+ */
+ public function register( $block_name, $style_properties ) {
+
+ if ( ! isset( $block_name ) || ! is_string( $block_name ) ) {
+ $message = __( 'Block name name must be a string.', 'gutenberg' );
+ _doing_it_wrong( __METHOD__, $message, '6.2.0' );
+ return false;
+ }
+
+ if ( ! isset( $style_properties['name'] ) || ! is_string( $style_properties['name'] ) ) {
+ $message = __( 'Block style name must be a string.', 'gutenberg' );
+ _doing_it_wrong( __METHOD__, $message, '6.2.0' );
+ return false;
+ }
+
+ $block_style_name = $style_properties['name'];
+
+ if ( ! isset( $this->registered_block_styles[ $block_name ] ) ) {
+ $this->registered_block_styles[ $block_name ] = array();
+ }
+ $this->registered_block_styles[ $block_name ][ $block_style_name ] = $style_properties;
+
+ return true;
+ }
+
+ /**
+ * Unregisters a block style.
+ *
+ * @param string $block_name Block type name including namespace.
+ * @param array $block_style_name Block style name.
+ *
+ * @return boolean True if the block style was unregistered with success and false otherwise.
+ */
+ public function unregister( $block_name, $block_style_name ) {
+ if ( ! $this->is_registered( $block_name, $block_style_name ) ) {
+ /* translators: 1: block name, 2: block style name */
+ $message = sprintf( __( 'Block "%1$s" does not contain a style named "%2$s.".', 'gutenberg' ), $block_name, $block_style_name );
+ _doing_it_wrong( __METHOD__, $message, '6.2.0' );
+ return false;
+ }
+
+ unset( $this->registered_block_styles[ $block_name ][ $block_style_name ] );
+
+ return true;
+ }
+
+ /**
+ * Retrieves an array containing the properties of a registered block style.
+ *
+ * @since 5.3.0
+ *
+ * @param string $block_name Block type name including namespace.
+ * @param array $block_style_name Block style name.
+ *
+ * @return array Registered block style properties.
+ */
+ public function get_registered( $block_name, $block_style_name ) {
+ if ( ! $this->is_registered( $block_name, $block_style_name ) ) {
+ return null;
+ }
+
+ return $this->registered_block_styles[ $block_name ][ $block_style_name ];
+ }
+
+ /**
+ * Retrieves all registered block styles.
+ *
+ * @since 5.3.0
+ *
+ * @return array Array of arrays containing the registered block styles properties grouped per block, and per style.
+ */
+ public function get_all_registered() {
+ return $this->registered_block_styles;
+ }
+
+ /**
+ * Retrieves registered block styles for a specific block.
+ *
+ * @since 5.3.0
+ *
+ * @param string $block_name Block type name including namespace.
+ *
+ * @return array Array whose keys are block style names and whose value are block style properties.
+ */
+ public function get_registered_styles_for_block( $block_name ) {
+ if ( isset( $this->registered_block_styles[ $block_name ] ) ) {
+ return $this->registered_block_styles[ $block_name ];
+ }
+ return array();
+ }
+
+ /**
+ * Checks if a block style is registered.
+ *
+ * @since 5.3.0
+ *
+ * @param string $block_name Block type name including namespace.
+ * @param array $block_style_name Block style name.
+ *
+ * @return bool True if the block style is registered, false otherwise.
+ */
+ public function is_registered( $block_name, $block_style_name ) {
+ return isset( $this->registered_block_styles[ $block_name ][ $block_style_name ] );
+ }
+
+ /**
+ * Utility method to retrieve the main instance of the class.
+ *
+ * The instance will be created if it does not exist yet.
+ *
+ * @since 5.3.0
+ *
+ * @return WP_Block_Styles_Registry The main instance.
+ */
+ public static function get_instance() {
+ if ( null === self::$instance ) {
+ self::$instance = new self();
+ }
+
+ return self::$instance;
+ }
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesdefaultfiltersphp"></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/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2019-09-14 16:46:26 UTC (rev 46110)
+++ trunk/src/wp-includes/default-filters.php 2019-09-14 18:20:58 UTC (rev 46111)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -501,6 +501,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_print_scripts', 'wp_just_in_time_script_localization' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'print_scripts_array', 'wp_prototype_before_jquery' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'customize_controls_print_styles', 'wp_resource_hints', 1 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'enqueue_block_assets', 'enqueue_block_styles_assets', 30 );
+add_action( 'enqueue_block_editor_assets', 'enqueue_editor_block_styles_assets' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_default_styles', 'wp_default_styles' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'style_loader_src', 'wp_style_loader_src', 10, 2 );
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></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/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2019-09-14 16:46:26 UTC (rev 46110)
+++ trunk/src/wp-includes/script-loader.php 2019-09-14 18:20:58 UTC (rev 46111)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2780,3 +2780,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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">+
+/**
+ * Function responsible for enqueuing the styles required for block styles functionality on the editor and on the frontend.
+ *
+ * @since 5.3.0
+ */
+function enqueue_block_styles_assets() {
+ $block_styles = WP_Block_Styles_Registry::get_instance()->get_all_registered();
+
+ foreach ( $block_styles as $styles ) {
+ foreach ( $styles as $style_properties ) {
+ if ( isset( $style_properties['style_handle'] ) ) {
+ wp_enqueue_style( $style_properties['style_handle'] );
+ }
+ if ( isset( $style_properties['inline_style'] ) ) {
+ wp_add_inline_style( 'wp-block-library', $style_properties['inline_style'] );
+ }
+ }
+ }
+}
+
+/**
+ * Function responsible for enqueuing the assets required for block styles functionality on the editor.
+ *
+ * @since 5.3.0
+ */
+function enqueue_editor_block_styles_assets() {
+ $block_styles = WP_Block_Styles_Registry::get_instance()->get_all_registered();
+
+ $register_script_lines = array( '( function() {' );
+ foreach ( $block_styles as $block_name => $styles ) {
+ foreach ( $styles as $style_properties ) {
+ $register_script_lines[] = sprintf(
+ ' wp.blocks.registerBlockStyle( \'%s\', %s );',
+ $block_name,
+ wp_json_encode(
+ array(
+ 'name' => $style_properties['name'],
+ 'label' => $style_properties['label'],
+ )
+ )
+ );
+ }
+ }
+ $register_script_lines[] = '} )();';
+ $inline_script = implode( "\n", $register_script_lines );
+
+ wp_register_script( 'wp-block-styles', false, array( 'wp-blocks' ), true, true );
+ wp_add_inline_script( 'wp-block-styles', $inline_script );
+ wp_enqueue_script( 'wp-block-styles' );
+}
</ins></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2019-09-14 16:46:26 UTC (rev 46110)
+++ trunk/src/wp-settings.php 2019-09-14 18:20:58 UTC (rev 46111)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -256,6 +256,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . WPINC . '/rest-api/search/class-wp-rest-search-handler.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . WPINC . '/rest-api/search/class-wp-rest-post-search-handler.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . WPINC . '/class-wp-block-type.php' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require( ABSPATH . WPINC . '/class-wp-block-styles-registry.php' );
</ins><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . WPINC . '/class-wp-block-type-registry.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . WPINC . '/class-wp-block-parser.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . WPINC . '/blocks.php' );
</span></span></pre>
</div>
</div>
</body>
</html>