Filter the Post Format list to only formats that are supported #6301

pento · 2018-04-20T05:03:33Z

Description

As described in #6296, the PostFormat list should only display post formats that are currently supported.

Core Ticket: https://core.trac.wordpress.org/ticket/43817

Screenshots

Twenty Seventeen restricts the post formats than can be used:

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.

…anually add it to the list

danielbachhuber · 2018-04-20T12:22:34Z

Given #2523, I'm think formats, featured image, and all theme support data might be better suited to live on the API index response.

danielbachhuber · 2018-04-20T13:30:50Z

I started moving formats to the index response in #6318. However, it doesn't appear there are any JS APIs yet for accessing data on the index. Is there something I'm missing?

danielbachhuber · 2018-04-20T22:56:24Z

However, it doesn't appear there are any JS APIs yet for accessing data on the index.

I updated #6318 (which merges into this) to include select( 'core' ) support for accessing index data.

* Introduce `theme_supports` with `formats` to REST API index * Load supported formats from index into scope * Use `union` for a more concise logic declaration. * Remove unused second argument * Directly access the object variable * Use shorthand format

aduth · 2018-04-25T20:21:47Z

core-data/reducer.js

+ *
+ * @return {Object} Updated state.
+ */
+export function indexData( state = {}, action ) {


Continuing discussion from #6318 (comment) : That "index" is considered ambiguous doesn't seem to be helped by the addition of a suffix, and makes me wonder if we can better communicate what it is we're tracking. I guess the endpoint itself is properly called the index (source). From some of the comments, we could derive other names like siteIndex, siteData, or maybe just site.

Most worrying to me is that routes is a very large data shape that we presumably don't really need here.

aduth · 2018-04-25T20:25:14Z

core-data/resolvers.js

+/**
+ * Requests theme supports data from the index.
+ */
+export async function* getThemeSupports() {


Elsewhere we seem to be anticipating that index data may be broadly useful, rather than tracking only theme supports. But it's not consistent with how we've implemented resolvers and selectors, as there's only exposed access to theme supports. Scaling this out to other properties will require (maybe not so obviously) refactoring of the resolver to implement an isFulfilled for all index-sourced values (see #6084).

Which is to say: We should probably be consistent one way or the other: Only track theme supports, or implement resolvers and selectors as broadly index-sourced.

I think it's better to focus specifically on theme supports data: 1c6e693

aduth · 2018-04-25T20:26:45Z

core-data/selectors.js

+ *
+ * @param {Object} state    Data state.
+ *
+ * @return {Mixed?}     Index data.


Mixed is not a valid type. JSDoc encourages * as the wildcard "any" type (reference)

Extra whitespace should be removed after types, both in @param and @return

Handled in 1c6e693

aduth · 2018-04-25T20:28:37Z

editor/components/post-format/index.js

+		const themeSupports = select( 'core' ).getThemeSupports();
+		// Ensure current format is always in the set.
+		// The current format may not be a format supported by the theme.
+		const supportedFormats = union( [ format ], get( themeSupports, 'formats', [] ) );
 		return {
 			postFormat: getEditedPostAttribute( 'format' ),


We can leverage the assigned variable format here.

(And optionally rename as postFormat for consistency / benefit of object property shorthand)

aduth · 2018-04-25T20:29:12Z

lib/compat.php

+ * @param WP_REST_Response $response WP REST API response of the wp-json index.
+ * @return WP_REST_Response Response that contains the permalink structure.
+ */
+function gutenberg_ensure_wp_json_has_permalink_structure( $response ) {


Is the (re-?)introduction of permalink structure intended? Guessing not by #6319.

Nope. I think this was a bad merge conflict. Removed in 8830dd7

aduth · 2018-04-25T21:29:55Z

editor/components/post-format/index.js

 	const postFormatSelectorId = 'post-format-selector-' + instanceId;
-	const suggestion = find( POST_FORMATS, ( format ) => format.id === suggestedFormat );
+	const formats = POST_FORMATS.filter( ( format ) => supportedFormats.includes( format.id ) );


Array#includes (and any other prototype-member function) is not polyfilled, and this will error in IE11.

Use Lodash _.includes instead.

See also: #746

Feedback has been addressed

pento added 4 commits April 20, 2018 14:53

Add supported post formats to the post type REST API response

e616b7d

Filter the post formats we show in the PostFormat dropdown

37de60d

Need to pass the slug to post_type_supports()

b2a22e4

Standard post format is added in the end point response, no need to m…

c0070ea

…anually add it to the list

pento added [Feature] Document Settings Document settings experience Core REST API Task Task for Core REST API efforts labels Apr 20, 2018

pento added this to the 2.8 milestone Apr 20, 2018

pento requested a review from danielbachhuber April 20, 2018 05:03

danielbachhuber self-assigned this Apr 20, 2018

danielbachhuber mentioned this pull request Apr 20, 2018

Introduce theme_supports with formats to REST API index #6318

Merged

danielbachhuber removed their assignment Apr 23, 2018

danielbachhuber approved these changes Apr 25, 2018

View reviewed changes

Merge branch 'master' into add/post-format-filtering

2ebfcda

danielbachhuber requested a review from aduth April 25, 2018 12:18

aduth reviewed Apr 25, 2018

View reviewed changes

danielbachhuber added 3 commits April 25, 2018 13:53

More consise variable definition

39dbb81

Remove permalink_structure definition, which has been removed

8830dd7

Focus state management on themeSupports data

1c6e693

aduth previously requested changes Apr 25, 2018

View reviewed changes

Use lodash implementation of includes() for IE11 compat

f7108b8

danielbachhuber merged commit 5dafcbd into master Apr 25, 2018

danielbachhuber deleted the add/post-format-filtering branch April 25, 2018 22:28

aduth mentioned this pull request Apr 26, 2018

Pre-load REST API index data to avoid FOMD #6434

Merged

danielbachhuber changed the title ~~Filter the PostFormat list~~ Filter the Post Format list to only formats that are supported May 9, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filter the Post Format list to only formats that are supported #6301

Filter the Post Format list to only formats that are supported #6301

pento commented Apr 20, 2018 •

edited

Loading

danielbachhuber commented Apr 20, 2018

danielbachhuber commented Apr 20, 2018

danielbachhuber commented Apr 20, 2018

aduth Apr 25, 2018

aduth Apr 25, 2018

danielbachhuber Apr 25, 2018

aduth Apr 25, 2018

danielbachhuber Apr 25, 2018

aduth Apr 25, 2018

danielbachhuber Apr 25, 2018

aduth Apr 25, 2018

danielbachhuber Apr 25, 2018

aduth Apr 25, 2018

danielbachhuber Apr 25, 2018

Filter the Post Format list to only formats that are supported #6301

Filter the Post Format list to only formats that are supported #6301

Conversation

pento commented Apr 20, 2018 • edited Loading

Description

Screenshots

Checklist:

danielbachhuber commented Apr 20, 2018

danielbachhuber commented Apr 20, 2018

danielbachhuber commented Apr 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pento commented Apr 20, 2018 •

edited

Loading