Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement the custom classname support hook in the server #24483

Merged
merged 4 commits into from
Aug 17, 2020
Merged

Implement the custom classname support hook in the server #24483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e93d38
Implement the custom classname support hook in the server
youknowriad Aug 11, 2020
b875a40
Fix phpcs
youknowriad Aug 12, 2020
dcc0fbc
Add a unit test
youknowriad Aug 13, 2020
732ea9e
Fix phpcs
youknowriad Aug 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions lib/block-supports/custom-classname.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php
/**
* Custom classname block support flag.
*
* @package gutenberg
*/

/**
* Registers the custom classname block attribute for block types that support it.
*
* @param array $block_type Block Type.
*/
function gutenberg_register_custom_classname_support( $block_type ) {
$has_custom_classname_support = gutenberg_experimental_get( $block_type->supports, array( 'customClassName' ), true );
if ( $has_custom_classname_support ) {
if ( ! $block_type->attributes ) {
$block_type->attributes = array();
}

if ( ! array_key_exists( 'className', $block_type->attributes ) ) {
$block_type->attributes['className'] = array(
'type' => 'string',
);
}
}
}

/**
* Add the custom classnames to the output.
*
* @param array $attributes comprehensive list of attributes to be applied.
* @param array $block_attributes block attributes.
* @param array $block_type Block Type.
* @return array Block CSS classes and inline styles.
*/
function gutenberg_apply_custom_classname_support( $attributes, $block_attributes, $block_type ) {
$has_custom_classname_support = gutenberg_experimental_get( $block_type->supports, array( 'customClassName' ), true );
if ( $has_custom_classname_support ) {
$has_custom_classnames = array_key_exists( 'className', $block_attributes );

if ( $has_custom_classnames ) {
$attributes['css_classes'][] = $block_attributes['className'];
}
}

return $attributes;
}
2 changes: 2 additions & 0 deletions lib/block-supports/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ function gutenberg_register_block_supports() {
gutenberg_register_alignment_support( $block_type );
gutenberg_register_colors_support( $block_type );
gutenberg_register_typography_support( $block_type );
gutenberg_register_custom_classname_support( $block_type );
}
}

Expand Down Expand Up @@ -44,6 +45,7 @@ function gutenberg_apply_block_supports( $block_content, $block ) {
$attributes = gutenberg_apply_colors_support( $attributes, $block['attrs'], $block_type );
$attributes = gutenberg_apply_typography_support( $attributes, $block['attrs'], $block_type );
$attributes = gutenberg_apply_alignment_support( $attributes, $block['attrs'], $block_type );
$attributes = gutenberg_apply_custom_classname_support( $attributes, $block['attrs'], $block_type );

if ( ! count( $attributes ) ) {
return $block_content;
Expand Down
1 change: 1 addition & 0 deletions lib/load.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,4 @@ function gutenberg_is_experiment_enabled( $name ) {
require dirname( __FILE__ ) . '/block-supports/align.php';
require dirname( __FILE__ ) . '/block-supports/colors.php';
require dirname( __FILE__ ) . '/block-supports/typography.php';
require dirname( __FILE__ ) . '/block-supports/custom-classname.php';
2 changes: 1 addition & 1 deletion lib/utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ function gutenberg_experimental_get( $array, $path, $default = array() ) {

$path_length = count( $path );
for ( $i = 0; $i < $path_length; ++$i ) {
if ( empty( $array[ $path[ $i ] ] ) ) {
if ( ! isset( $array[ $path[ $i ] ] ) ) {
return $default;
}
$array = $array[ $path[ $i ] ];
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/archives/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/archives",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"displayAsDropdown": {
"type": "boolean",
"default": false
Expand Down
4 changes: 0 additions & 4 deletions packages/block-library/src/archives/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ function render_block_core_archives( $attributes ) {

$class = 'wp-block-archives';

if ( isset( $attributes['className'] ) ) {
$class .= " {$attributes['className']}";
}

if ( ! empty( $attributes['displayAsDropdown'] ) ) {

$class .= ' wp-block-archives-dropdown';
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/calendar/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/calendar",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"month": {
"type": "integer"
},
Expand Down
4 changes: 1 addition & 3 deletions packages/block-library/src/calendar/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,9 @@ function render_block_core_calendar( $attributes ) {
}
}

$custom_class_name = empty( $attributes['className'] ) ? '' : ' ' . $attributes['className'];

$output = sprintf(
'<div class="%1$s">%2$s</div>',
esc_attr( 'wp-block-calendar' . $custom_class_name ),
esc_attr( 'wp-block-calendar' ),
get_calendar( true, false )
);

Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/categories/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/categories",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"displayAsDropdown": {
"type": "boolean",
"default": false
Expand Down
4 changes: 0 additions & 4 deletions packages/block-library/src/categories/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,6 @@ function render_block_core_categories( $attributes ) {

$class = "wp-block-categories wp-block-categories-{$type}";

if ( isset( $attributes['className'] ) ) {
$class .= " {$attributes['className']}";
}

return sprintf(
$wrapper_markup,
esc_attr( $class ),
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/latest-comments/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/latest-comments",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"commentsToShow": {
"type": "number",
"default": 5,
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/latest-comments/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,6 @@ function render_block_core_latest_comments( $attributes = array() ) {
}

$class = 'wp-block-latest-comments';
if ( ! empty( $attributes['className'] ) ) {
$class .= ' ' . $attributes['className'];
}
if ( $attributes['displayAvatar'] ) {
$class .= ' has-avatars';
}
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/latest-posts/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/latest-posts",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
Expand Down
4 changes: 0 additions & 4 deletions packages/block-library/src/latest-posts/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,6 @@ function render_block_core_latest_posts( $attributes ) {
$class .= ' has-author';
}

if ( isset( $attributes['className'] ) ) {
$class .= ' ' . $attributes['className'];
}

return sprintf(
'<ul class="%1$s">%2$s</ul>',
esc_attr( $class ),
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/navigation/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
"orientation": {
"type": "string"
},
"className": {
"type": "string"
},
"textColor": {
"type": "string"
},
Expand Down
1 change: 0 additions & 1 deletion packages/block-library/src/navigation/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,6 @@ function render_block_core_navigation( $attributes, $content, $block ) {
$colors['css_classes'],
$font_sizes['css_classes'],
array( 'wp-block-navigation' ),
isset( $attributes['className'] ) ? array( $attributes['className'] ) : array(),
( isset( $attributes['orientation'] ) && 'vertical' === $attributes['orientation'] ) ? array( 'is-vertical' ) : array(),
isset( $attributes['itemsJustification'] ) ? array( 'items-justified-' . $attributes['itemsJustification'] ) : array()
);
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/rss/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/rss",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"columns": {
"type": "number",
"default": 2
Expand Down
4 changes: 0 additions & 4 deletions packages/block-library/src/rss/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,6 @@ function render_block_core_rss( $attributes ) {
$class .= ' columns-' . $attributes['columns'];
}

if ( isset( $attributes['className'] ) ) {
$class .= ' ' . $attributes['className'];
}

return sprintf( '<ul class="%s">%s</ul>', esc_attr( $class ), $list_items );
}

Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/search/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/search",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"label": {
"type": "string"
},
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/search/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,6 @@ function render_block_core_search( $attributes ) {
}

$class = 'wp-block-search';
if ( isset( $attributes['className'] ) ) {
$class .= ' ' . $attributes['className'];
}

return sprintf(
'<form class="%s" role="search" method="get" action="%s">%s</form>',
Expand Down
3 changes: 0 additions & 3 deletions packages/block-library/src/tag-cloud/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "core/tag-cloud",
"category": "widgets",
"attributes": {
"className": {
"type": "string"
},
"taxonomy": {
"type": "string",
"default": "post_tag"
Expand Down
7 changes: 1 addition & 6 deletions packages/block-library/src/tag-cloud/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,7 @@
*/
function render_block_core_tag_cloud( $attributes ) {
$class = 'wp-block-tag-cloud';

if ( isset( $attributes['className'] ) ) {
$class .= ' ' . $attributes['className'];
}

$args = array(
$args = array(
'echo' => false,
'taxonomy' => $attributes['taxonomy'],
'show_count' => $attributes['showTagCounts'],
Expand Down
56 changes: 56 additions & 0 deletions phpunit/class-block-supported-styles-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,4 +687,60 @@ function test_render_callback_required() {

$this->assert_content_and_styles_and_classes_match( $block, $expected_classes, $expected_styles );
}

/**
* Tests custom classname server-side block support.
*/
function test_custom_classnames_support() {
$block_type_settings = array(
'attributes' => array(),
'supports' => array(),
'render_callback' => true,
);
$this->register_block_type( 'core/example', $block_type_settings );

$block = array(
'blockName' => 'core/example',
'attrs' => array(
'className' => 'my-custom-classname',
),
'innerBlock' => array(),
'innerContent' => array(),
'innerHTML' => array(),
);

$expected_styles = 'test:style; ';
$expected_classes = 'wp-block-example foo-bar-class my-custom-classname';

$this->assert_content_and_styles_and_classes_match( $block, $expected_classes, $expected_styles );
}

/**
* Tests custom classname server-side block support opt-out.
*/
function test_custom_classnames_support_opt_out() {
$block_type_settings = array(
'attributes' => array(),
'supports' => array(
'customClassName' => false,
),
'render_callback' => true,
);
$this->register_block_type( 'core/example', $block_type_settings );

$block = array(
'blockName' => 'core/example',
'attrs' => array(
'className' => 'my-custom-classname',
),
'innerBlock' => array(),
'innerContent' => array(),
'innerHTML' => array(),
);

$expected_styles = 'test:style;';
$expected_classes = 'wp-block-example foo-bar-class';

$this->assert_content_and_styles_and_classes_match( $block, $expected_classes, $expected_styles );
}
}