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 sticky support in Query block #26279

Merged
merged 5 commits into from
Oct 27, 2020
Merged

Add sticky support in Query block #26279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fecef3e
Add sticky support in Query block
ntsekouras Oct 19, 2020
d59d7cb
regenerate fixtures
ntsekouras Oct 19, 2020
e540b64
support all options for sticky
ntsekouras Oct 20, 2020
20ac843
change sticky options labels
ntsekouras Oct 20, 2020
84e3886
add comments for sticky options
ntsekouras Oct 26, 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
8 changes: 8 additions & 0 deletions packages/block-library/src/query-loop/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export default function QueryLoopEdit( {
author,
search,
exclude,
sticky,
} = {},
queryContext,
},
Expand Down Expand Up @@ -65,6 +66,12 @@ export default function QueryLoopEdit( {
if ( exclude?.length ) {
query.exclude = exclude;
}
// If sticky is not set, it will return all posts in the results.
// If sticky is set to `only`, it will limit the results to sticky posts only.
// If it is anything else, it will exclude sticky posts from results. For the record the value stored is `exclude`.
if ( sticky ) {
query.sticky = sticky === 'only';
ntsekouras marked this conversation as resolved.
Show resolved Hide resolved
}
return {
posts: getEntityRecords( 'postType', postType, query ),
blocks: getBlocks( clientId ),
Expand All @@ -83,6 +90,7 @@ export default function QueryLoopEdit( {
search,
postType,
exclude,
sticky,
]
);

Expand Down
19 changes: 14 additions & 5 deletions packages/block-library/src/query-loop/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,27 @@ function render_block_core_query_loop( $attributes, $content, $block ) {
$page = empty( $_GET[ $page_key ] ) ? 1 : filter_var( $_GET[ $page_key ], FILTER_VALIDATE_INT );

$query = array(
'post_type' => 'post',
'offset' => 0,
'order' => 'DESC',
'orderby' => 'date',
'post_type' => 'post',
'offset' => 0,
'order' => 'DESC',
'orderby' => 'date',
'post__not_in' => array(),
);

if ( isset( $block->context['query'] ) ) {
if ( isset( $block->context['query']['postType'] ) ) {
$query['post_type'] = $block->context['query']['postType'];
}
if ( isset( $block->context['query']['sticky'] ) && ! empty( $block->context['query']['sticky'] ) ) {
$sticky = get_option( 'sticky_posts' );
if ( 'only' === $block->context['query']['sticky'] ) {
$query['post__in'] = $sticky;
} else {
$query['post__not_in'] = array_merge( $query['post__not_in'], $sticky );
}
}
if ( isset( $block->context['query']['exclude'] ) ) {
$query['post__not_in'] = $block->context['query']['exclude'];
$query['post__not_in'] = array_merge( $query['post__not_in'], $block->context['query']['exclude'] );
}
if ( isset( $block->context['query']['perPage'] ) ) {
$query['offset'] = ( $block->context['query']['perPage'] * ( $page - 1 ) ) + $block->context['query']['offset'];
Expand Down
3 changes: 2 additions & 1 deletion packages/block-library/src/query/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"orderBy": "date",
"author": "",
"search": "",
"exclude": []
"exclude": [],
"sticky": ""
}
}
},
Expand Down
31 changes: 30 additions & 1 deletion packages/block-library/src/query/edit/query-inspector-controls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,16 @@ import { getTermsInfo } from '../utils';
import { MAX_FETCHED_TERMS } from '../constants';

export default function QueryInspectorControls( { query, setQuery } ) {
const { order, orderBy, author: selectedAuthorId, postType } = query;
const {
order,
orderBy,
author: selectedAuthorId,
postType,
sticky,
} = query;
const [ showCategories, setShowCategories ] = useState( true );
const [ showTags, setShowTags ] = useState( true );
const [ showSticky, setShowSticky ] = useState( postType === 'post' );
const { authorList, categories, tags, postTypes } = useSelect(
( select ) => {
const { getEntityRecords, getPostTypes } = select( 'core' );
Expand Down Expand Up @@ -72,6 +79,9 @@ export default function QueryInspectorControls( { query, setQuery } ) {
setShowCategories( postTypeTaxonomies.includes( 'category' ) );
setShowTags( postTypeTaxonomies.includes( 'post_tag' ) );
}, [ postType, postTypesTaxonomiesMap ] );
useEffect( () => {
setShowSticky( postType === 'post' );
}, [ postType ] );
const postTypesSelectOptions = useMemo(
() =>
( postTypes || [] ).map( ( { labels, slug } ) => ( {
Expand All @@ -88,6 +98,9 @@ export default function QueryInspectorControls( { query, setQuery } ) {
if ( ! postTypesTaxonomiesMap[ newValue ].includes( 'post_tag' ) ) {
updateQuery.tagIds = [];
}
if ( newValue !== 'post' ) {
updateQuery.sticky = '';
}
setQuery( updateQuery );
};
// Handles categories and tags changes.
Expand All @@ -111,6 +124,14 @@ export default function QueryInspectorControls( { query, setQuery } ) {
onChangeDebounced();
return onChangeDebounced.cancel;
}, [ querySearch, onChangeDebounced ] );
const stickyOptions = useMemo( () => [
{
label: __( 'Include' ),
value: '',
},
{ label: __( 'Exclude' ), value: 'exclude' },
{ label: __( 'Only' ), value: 'only' },
] );
return (
<InspectorControls>
<PanelBody title={ __( 'Filtering and Sorting' ) }>
Expand Down Expand Up @@ -161,6 +182,14 @@ export default function QueryInspectorControls( { query, setQuery } ) {
value={ querySearch }
onChange={ setQuerySearch }
/>
{ showSticky && (
<SelectControl
label={ __( 'Sticky posts' ) }
options={ stickyOptions }
value={ sticky }
onChange={ ( value ) => setQuery( { sticky: value } ) }
/>
) }
</PanelBody>
</InspectorControls>
);
Expand Down
28 changes: 14 additions & 14 deletions packages/e2e-tests/fixtures/blocks/core__embed.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[
{
"clientId": "_clientId_0",
"name": "core/embed",
"isValid": true,
"attributes": {
"url": "https://example.com/",
"caption": "Embedded content from an example URL",
"allowResponsive": true,
"responsive": false,
"previewable": true
},
"innerBlocks": [],
"originalContent": "<figure class=\"wp-block-embed\">\n <div class=\"wp-block-embed__wrapper\">\n https://example.com/\n </div>\n <figcaption>Embedded content from an example URL</figcaption>\n</figure>"
}
{
"clientId": "_clientId_0",
"name": "core/embed",
"isValid": true,
"attributes": {
"url": "https://example.com/",
"caption": "Embedded content from an example URL",
"allowResponsive": true,
"responsive": false,
"previewable": true
},
"innerBlocks": [],
"originalContent": "<figure class=\"wp-block-embed\">\n <div class=\"wp-block-embed__wrapper\">\n https://example.com/\n </div>\n <figcaption>Embedded content from an example URL</figcaption>\n</figure>"
}
]
48 changes: 24 additions & 24 deletions packages/e2e-tests/fixtures/blocks/core__latest-posts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
[
{
"clientId": "_clientId_0",
"name": "core/latest-posts",
"isValid": true,
"attributes": {
"postsToShow": 5,
"displayPostContent": false,
"displayPostContentRadio": "excerpt",
"excerptLength": 55,
"displayAuthor": false,
"displayPostDate": false,
"postLayout": "list",
"columns": 3,
"order": "desc",
"orderBy": "date",
"displayFeaturedImage": false,
"featuredImageSizeSlug": "thumbnail",
"featuredImageSizeWidth": null,
"featuredImageSizeHeight": null,
"addLinkToFeaturedImage": false
},
"innerBlocks": [],
"originalContent": ""
}
{
"clientId": "_clientId_0",
"name": "core/latest-posts",
"isValid": true,
"attributes": {
"postsToShow": 5,
"displayPostContent": false,
"displayPostContentRadio": "excerpt",
"excerptLength": 55,
"displayAuthor": false,
"displayPostDate": false,
"postLayout": "list",
"columns": 3,
"order": "desc",
"orderBy": "date",
"displayFeaturedImage": false,
"featuredImageSizeSlug": "thumbnail",
"featuredImageSizeWidth": null,
"featuredImageSizeHeight": null,
"addLinkToFeaturedImage": false
},
"innerBlocks": [],
"originalContent": ""
}
]
48 changes: 24 additions & 24 deletions packages/e2e-tests/fixtures/blocks/core__latest-posts__displayPostDate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
[
{
"clientId": "_clientId_0",
"name": "core/latest-posts",
"isValid": true,
"attributes": {
"postsToShow": 5,
"displayPostContent": false,
"displayPostContentRadio": "excerpt",
"excerptLength": 55,
"displayAuthor": false,
"displayPostDate": true,
"postLayout": "list",
"columns": 3,
"order": "desc",
"orderBy": "date",
"displayFeaturedImage": false,
"featuredImageSizeSlug": "thumbnail",
"featuredImageSizeWidth": null,
"featuredImageSizeHeight": null,
"addLinkToFeaturedImage": false
},
"innerBlocks": [],
"originalContent": ""
}
{
"clientId": "_clientId_0",
"name": "core/latest-posts",
"isValid": true,
"attributes": {
"postsToShow": 5,
"displayPostContent": false,
"displayPostContentRadio": "excerpt",
"excerptLength": 55,
"displayAuthor": false,
"displayPostDate": true,
"postLayout": "list",
"columns": 3,
"order": "desc",
"orderBy": "date",
"displayFeaturedImage": false,
"featuredImageSizeSlug": "thumbnail",
"featuredImageSizeWidth": null,
"featuredImageSizeHeight": null,
"addLinkToFeaturedImage": false
},
"innerBlocks": [],
"originalContent": ""
}
]
20 changes: 10 additions & 10 deletions packages/e2e-tests/fixtures/blocks/core__post-featured-image.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[
{
"clientId": "_clientId_0",
"name": "core/post-featured-image",
"isValid": true,
"attributes": {
"isLink": false
},
"innerBlocks": [],
"originalContent": ""
}
{
"clientId": "_clientId_0",
"name": "core/post-featured-image",
"isValid": true,
"attributes": {
"isLink": false
},
"innerBlocks": [],
"originalContent": ""
}
]
26 changes: 13 additions & 13 deletions packages/e2e-tests/fixtures/blocks/core__post-title.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[
{
"clientId": "_clientId_0",
"name": "core/post-title",
"isValid": true,
"attributes": {
"level": 2,
"isLink": false,
"linkTarget": "_self",
"rel": ""
},
"innerBlocks": [],
"originalContent": ""
}
{
"clientId": "_clientId_0",
"name": "core/post-title",
"isValid": true,
"attributes": {
"level": 2,
"isLink": false,
"rel": "",
"linkTarget": "_self"
},
"innerBlocks": [],
"originalContent": ""
}
]
45 changes: 23 additions & 22 deletions packages/e2e-tests/fixtures/blocks/core__query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
[
{
"clientId": "_clientId_0",
"name": "core/query",
"isValid": true,
"attributes": {
"query": {
"perPage": null,
"pages": 1,
"offset": 0,
"postType": "post",
"categoryIds": [],
"tagIds": [],
"order": "desc",
"orderBy": "date",
"author": "",
"search": "",
"exclude": []
}
},
"innerBlocks": [],
"originalContent": ""
}
{
"clientId": "_clientId_0",
"name": "core/query",
"isValid": true,
"attributes": {
"query": {
"perPage": null,
"pages": 1,
"offset": 0,
"postType": "post",
"categoryIds": [],
"tagIds": [],
"order": "desc",
"orderBy": "date",
"author": "",
"search": "",
"exclude": [],
"sticky": ""
}
},
"innerBlocks": [],
"originalContent": ""
}
]
6 changes: 3 additions & 3 deletions packages/e2e-tests/fixtures/blocks/core__search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
"name": "core/search",
"isValid": true,
"attributes": {
"buttonPosition": "button-outside",
"buttonUseIcon": false,
"showLabel": true,
"placeholder": "",
"showLabel": true
"buttonPosition": "button-outside",
"buttonUseIcon": false
},
"innerBlocks": [],
"originalContent": ""
Expand Down
Loading