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

Add a "separator" attribute to post-terms block #32812

Merged
merged 9 commits into from
Jul 12, 2021
Merged

Add a "separator" attribute to post-terms block #32812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bbc394e
Add a "separator" attribute to post-terms
aristath Jun 18, 2021
735b178
Change default from a pipe to a comma
aristath Jun 18, 2021
3121c5a
fix defaults
aristath Jun 22, 2021
d84cd1d
Add separator class
aristath Jun 22, 2021
8c0a0bd
update fixtures
aristath Jun 22, 2021
6179865
change selector from sep to separator
aristath Jul 9, 2021
ad78d49
Add styles
aristath Jul 9, 2021
37021f2
indentation fix
aristath Jul 9, 2021
d5bb6b2
import style
ntsekouras Jul 9, 2021
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
7 changes: 6 additions & 1 deletion packages/block-library/src/post-terms/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
},
"textAlign": {
"type": "string"
},
"separator": {
"type": "string",
"default": ", "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should default be empty?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a comma makes more sense — it tends to be the most commonly used separator in themes.

}
},
"usesContext": [ "postId", "postType" ],
Expand All @@ -24,5 +28,6 @@
"lineHeight": true,
"fontSize": true
}
}
},
"style": "wp-block-post-terms"
}
26 changes: 23 additions & 3 deletions packages/block-library/src/post-terms/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ import classnames from 'classnames';
*/
import {
AlignmentToolbar,
InspectorAdvancedControls,
BlockControls,
Warning,
useBlockProps,
} from '@wordpress/block-editor';
import { Spinner } from '@wordpress/components';
import { Spinner, TextControl } from '@wordpress/components';
import { useSelect } from '@wordpress/data';
import { __ } from '@wordpress/i18n';
import { store as coreStore } from '@wordpress/core-data';
Expand All @@ -27,7 +28,7 @@ export default function PostTermsEdit( {
context,
setAttributes,
} ) {
const { term, textAlign } = attributes;
const { term, textAlign, separator } = attributes;
const { postId, postType } = context;

const selectedTerm = useSelect(
Expand Down Expand Up @@ -78,6 +79,17 @@ export default function PostTermsEdit( {
} }
/>
</BlockControls>
<InspectorAdvancedControls>
<TextControl
autoComplete="off"
label={ __( 'Separator' ) }
value={ separator || '' }
onChange={ ( nextValue ) => {
setAttributes( { separator: nextValue } );
} }
help={ __( 'Enter character(s) used to separate terms.' ) }
/>
</InspectorAdvancedControls>
<div { ...blockProps }>
{ isLoading && <Spinner /> }
{ ! isLoading &&
Expand All @@ -92,7 +104,15 @@ export default function PostTermsEdit( {
{ postTerm.name }
</a>
) )
.reduce( ( prev, curr ) => [ prev, ' | ', curr ] ) }
.reduce( ( prev, curr ) => (
<>
{ prev }
<span className="wp-block-post-terms__separator">
{ separator || ' ' }
</span>
{ curr }
</>
) ) }
{ ! isLoading &&
! hasPostTerms &&
( selectedTerm?.labels?.no_terms ||
Expand Down
26 changes: 9 additions & 17 deletions packages/block-library/src/post-terms/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ function render_block_core_post_terms( $attributes, $content, $block ) {
}

$post_terms = get_the_terms( $block->context['postId'], $attributes['term'] );
if ( is_wp_error( $post_terms ) ) {
return '';
}
if ( empty( $post_terms ) ) {
if ( is_wp_error( $post_terms ) || empty( $post_terms ) ) {
return '';
}

Expand All @@ -35,21 +32,16 @@ function render_block_core_post_terms( $attributes, $content, $block ) {
$classes .= ' has-text-align-' . $attributes['textAlign'];
}

$terms_links = '';
foreach ( $post_terms as $term ) {
$terms_links .= sprintf(
'<a href="%1$s">%2$s</a> | ',
get_term_link( $term->term_id ),
esc_html( $term->name )
);
}
$terms_links = trim( $terms_links, ' | ' );
$separator = empty( $attributes['separator'] ) ? ' ' : $attributes['separator'];

$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $classes ) );

return sprintf(
'<div %1$s>%2$s</div>',
$wrapper_attributes,
$terms_links
return get_the_term_list(
$block->context['postId'],
$attributes['term'],
"<div $wrapper_attributes>",
'<span class="wp-block-post-terms__separator">' . $separator . '</span>',
'</div>'
);
}

Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/post-terms/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wp-block-post-terms__separator {
white-space: pre-wrap;
}
1 change: 1 addition & 0 deletions packages/block-library/src/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
@import "./post-comments/style.scss";
@import "./post-comments-form/style.scss";
@import "./post-excerpt/style.scss";
@import "./post-terms/style.scss";
@import "./post-title/style.scss";
@import "./preformatted/style.scss";
@import "./pullquote/style.scss";
Expand Down
4 changes: 3 additions & 1 deletion packages/e2e-tests/fixtures/blocks/core__post-terms.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"clientId": "_clientId_0",
"name": "core/post-terms",
"isValid": true,
"attributes": {},
"attributes": {
"separator": ", "
},
"innerBlocks": [],
"originalContent": ""
}
Expand Down