Let Gutenberg be default editor for posts with blocks; add links to classic editor #1797

westonruter · 2017-07-07T22:12:32Z

When a post contains blocks, the main edit link becomes the link to Gutenberg whereas the row action link then goes to the Classic Editor:

Any edit post link for a post with blocks becomes a link to the Gutenberg editor, including links on the frontend:

If a post does not contain blocks, then the main link remains pointing to the classic editor and the Gutenberg link is in the row actions.

Likewise, if a post does have blocks then when the post is viewed on the frontend, the “Edit Post” link will link to Gutenberg and it will have a “Edit in Gutenberg” title. The classic editor will then be available via a submenu item:

Likewise, when the post does not contain blocks, then the original Edit Post link is in place with a link to Gutenberg being in the submenu as the alternate edit mode:

Lastly, if the post type is not registered with show_in_rest then the Gutenberg editor is not shown, since the REST API is a dependency for Gutenberg.

westonruter · 2017-07-07T22:53:50Z

I'll add unit tests for the new PHP functions once a 👍 on the functionality is given.

afercia · 2017-07-09T12:22:47Z

While there's the need to keep the links text as short as possible, given the limited space, I'd consider to try to improve them a bit.

all the row actions use verbs: Edit, Quick Edit, View, Preview, etc.: "Classic Editor" and "Gutenberg" instead don't immediately communicate the available action
the action of the "Edit" link in the list table and the "Edit Post" in the toolbar can be inferred only looking at the link close to them, not sure if this will be immediately clear for users

Since the aria-label text is not visible, it could be expanded always specifying "in the classic editor" / "in the Gutenberg editor"

westonruter · 2017-07-10T06:37:35Z

the action of the "Edit" link in the list table and the "Edit Post" in the toolbar can be inferred only looking at the link close to them, not sure if this will be immediately clear for users

@afercia I'm not entirely clear if your feedback here is about the design of the WordPress post list table in general, or if it is specifically regarding changes in this PR.

afercia · 2017-07-10T06:55:16Z

@westonruter I meant the current list table design in WordPress is clear enough because there's just one "Edit" and just one editor. Now that this PR introduces 2 links to 2 different editors, it's not always immediately clear where the "Edit" link points.

westonruter · 2017-07-10T07:07:58Z

It links to the default editor. If you think it should be verbosely “Edit in Gutenberg”, I wouldn't be opposed, but again there is limited space.

afercia · 2017-07-10T07:14:28Z

Yep that's what I meant 🙂 I see the limited space issue. Shortening the link text is not always so clear though.

westonruter · 2017-07-10T07:53:21Z

Please amend the PR with whatever you deem best.

ellatrix · 2017-07-14T15:59:43Z

lib/register.php

+ */
+function gutenberg_post_has_blocks( $post_id ) {
+	$post = get_post( $post_id );
+	return $post && preg_match( '#<!-- wp:\w+#', $post->post_content );


How about strpos( $post->post_content, '<!-- wp:' ) !== false?

Probably would be just as good in the vast majority of cases. That sequence of chars shouldn't be present unless there are blocks.

Yeah, I think that if <!-- wp: is already there, the chance is very high that it is followed by a word-like sequence anyway.

Thanks for the input. Changed in 53e2def.

westonruter · 2017-07-25T20:27:03Z

Rebased. 326645d rewritten to ef5a661.

karmatosed · 2017-08-30T17:07:05Z

+1 to getting this merged from me. Can we get a refresh to pass all checks? Be great to get this in for 1.1.

afercia · 2017-08-30T18:42:57Z

@karmatosed I kindly disagree. There's still a design issue to solve here: the link destination is not always clear.

karmatosed · 2017-08-30T18:56:53Z

@afercia to me, we get the PR in a state we can then see (it's not yet) and then either merge and iterate or iterate. What are you thinking is missing and would advise?

afercia · 2017-08-31T07:05:53Z

@karmatosed for example: would you be able to understand what the two "Edit" links in the screenshot below do at first sight?

To me, this seems confusing because I can understand the difference between the two "Edit" only by looking at the other link close to them. Not to mention, the link on the post title doesn't say anything either.

I see potential confusion also in the toolbar: often times, users just click, they don't read (muscle memory also). They will see "Edit bla bla" and click and sometimes land in the classic editor, sometimes on Gutenberg.

aduth · 2017-09-01T15:39:41Z

To me, it seems like it might be good to have edit actions as "Gutenberg Editor" (or "Edit in Gutenberg"), "Classic Editor" (or "Edit in Classic Editor") in all cases (never changing order or text), then set the behavior of the title link to the preferred default (Gutenberg if blocks exist, Classic otherwise).

…nk to row actions

…lockified posts

…orts

aduth · 2017-09-01T21:22:31Z

I've rebased to resolve conflicts and made the following revisions:

Using the display_post_states filter, add a "Gutenberg" status in post table for posts containing blocks:

Always show "Classic Editor" and "Gutenberg" links in post actions, regardless of post contents:

Always show full "Edit in ..." text in front-end admin bar:

aduth · 2017-09-01T21:24:18Z

lib/register.php

-		$gutenberg_action = sprintf(
+	if ( gutenberg_post_has_blocks( $post->ID ) ) {
+		remove_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10 );
+		add_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10, 3 );


@westonruter Should we just add a default filter handler for get_edit_post_link to always override with the preferred editor by content?

Isn't that what is already done here?

gutenberg/lib/register.php

Lines 210 to 231 in 547d038

/**

* Filters the post edit link to default to the Gutenberg editor when the post content contains a block.

*

* @since 0.5.0

*

* @param string $url The edit link URL.

* @param int $post_id Post ID.

* @param string $context The link context. If set to 'display' then ampersands are encoded.

* @return string Edit post link.

*/

function gutenberg_filter_edit_post_link( $url, $post_id, $context ) {

$post = get_post( $post_id );

if ( gutenberg_can_edit_post( $post_id ) && gutenberg_post_has_blocks( $post_id ) && post_type_supports( get_post_type( $post_id ), 'editor' ) ) {

$gutenberg_url = gutenberg_get_edit_post_url( $post->ID );

if ( 'display' === $context ) {

$gutenberg_url = esc_url( $gutenberg_url );

}

$url = $gutenberg_url;

}

return $url;

}

add_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10, 3 );

The reason why the remove_filter and add_filter are done above is to facilitate obtaining the classic post editor URL, even for a post that has blocks in it:

gutenberg/lib/register.php

Lines 88 to 91 in 547d038

$classic_text = __( 'Edit in Classic Editor', 'gutenberg' );

remove_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10 );

$classic_url = get_edit_post_link( $post->ID, 'raw' );

add_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10, 3 );

Yeah, seeing that now in the changes prior to 63ff18d. I guess this might not be working correctly for the "Classic Editor" link for Gutenberg posts currently then.

westonruter · 2017-09-01T21:47:39Z

lib/register.php

-		$gutenberg_action = sprintf(
+	if ( gutenberg_post_has_blocks( $post->ID ) ) {
+		remove_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10 );
+		add_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10, 3 );


As it stands right now, this if condition with add/remove of the get_edit_post_link filter is just removing and adding something right back, so it has no purpose right?

aduth · 2017-09-06T14:47:02Z

54df7bc should resolve the issue where Classic Editor would use an incorrect link for Gutenberg posts (from discussion thread at #1797 (comment)).

From my perspective, this seems ready to go.

codecov · 2017-09-06T14:51:57Z

Codecov Report

Merging #1797 into master will increase coverage by 1%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           master    #1797    +/-   ##
========================================
+ Coverage   31.38%   32.39%    +1%     
========================================
  Files         177      182     +5     
  Lines        5413     5933   +520     
  Branches      949     1087   +138     
========================================
+ Hits         1699     1922   +223     
- Misses       3139     3348   +209     
- Partials      575      663    +88

Impacted Files	Coverage Δ
blocks/editable/index.js	`10.02% <0%> (-0.5%)`	⬇️
editor/sidebar/post-status/index.js	`0% <0%> (ø)`	⬆️
blocks/library/gallery/gallery-image.js	`50% <0%> (ø)`	⬆️
blocks/editable/constants.js	`100% <0%> (ø)`
editor/sidebar/post-pending-status/index.js	`58.33% <0%> (ø)`
components/autocomplete/index.js	`89.04% <0%> (ø)`
blocks/block-autocomplete/index.js	`100% <0%> (ø)`
blocks/library/gallery/block.js	`11.76% <0%> (ø)`
blocks/editable/format-toolbar/index.js	`8% <0%> (+0.5%)`	⬆️
components/drop-zone/provider.js	`1.98% <0%> (+0.64%)`	⬆️
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8621e54...54df7bc. Read the comment docs.

`get_edit_post_link` is used in `post.php` to redirect when saving. See https://core.trac.wordpress.org/browser/trunk/src/wp-admin/post.php#L190 By checking to see if the referer is the classic editor, modification to the edit post link is preserved. Introduced in #1797 Fixes #2707

…kspace [iOS] Remove xcworkspace.

This was referenced Jul 7, 2017

Add front-end edit link #1779

Closed

WP admin bar - no gutenberg edit link #1627

Closed

westonruter force-pushed the add/edit-post-links branch from b39d28e to de0ef8b Compare July 8, 2017 01:52

westonruter added the [Status] In Progress Tracking issues with work in progress label Jul 11, 2017

westonruter assigned afercia Jul 11, 2017

lkraav mentioned this pull request Jul 13, 2017

Gutenberg integration kylephillips/wp-nested-pages#204

Closed

ellatrix reviewed Jul 14, 2017

View reviewed changes

westonruter force-pushed the add/edit-post-links branch from 326645d to 5d55e39 Compare July 25, 2017 20:26

mtias added Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Priority] High Used to indicate top priority items that need quick attention labels Aug 2, 2017

westonruter mentioned this pull request Aug 3, 2017

Rename "gutenberg" link to "edit in gutenberg" or ·edit in new editor" #2159

Closed

helen mentioned this pull request Aug 3, 2017

Consider a guiding NUX for Gutenberg #2176

Closed

westonruter mentioned this pull request Aug 3, 2017

Move Gutenberg to be under "Posts" menu #2145

Closed

nylen mentioned this pull request Aug 3, 2017

Add Gutenberg tab next to Text Editor tab. #2200

Closed

westonruter mentioned this pull request Aug 5, 2017

Detecting pages/posts authored via Gutenberg #2235

Closed

westonruter added 2 commits September 1, 2017 16:35

Prevent showing Gutenberg edit link if post type is not available

5390ea2

Link to Gurenberg editor if post has blocks; add classic edit post li…

990ee41

…nk to row actions

westonruter and others added 8 commits September 1, 2017 16:36

Show Gutenberg editor and classic editor in admin bar (with submenu)

da3c25f

Ensure edit post link on frontend are filtered to use Gutenberg for b…

a658729

…lockified posts

Use strpos instead of regex in gutenberg_post_has_blocks()

b66439e

Add unit tests for functions added in register.php

d319cc6

Prevent showing links to Gutenberg if editor not among post type supp…

cb336ba

…orts

Admin: Show Classic Editor, Gutenberg links consistently

63ff18d

Admin: Always show full "Edit in" text in admin bar

65f752e

Admin: Show post display state for Gutenberg posts

547d038

aduth force-pushed the add/edit-post-links branch from 5d55e39 to 547d038 Compare September 1, 2017 21:19

aduth reviewed Sep 1, 2017

View reviewed changes

westonruter commented Sep 1, 2017

View reviewed changes

Admin: Generate classic editor URL by removed edit filter

54df7bc

aduth approved these changes Sep 6, 2017

View reviewed changes

aduth merged commit b9bdfa2 into master Sep 8, 2017

aduth deleted the add/edit-post-links branch September 8, 2017 17:36

This was referenced Sep 8, 2017

Saving Gutenberg post in Classic Editor redirects to Gutenberg #2707

Closed

Compat: Disable wpautop in Classic Editor when post contains block #2708

Merged

aaronjorbin mentioned this pull request Sep 9, 2017

FIX: Saving in Classic Editor shouldn't redirect to Gutenberg #2709

Merged

aduth mentioned this pull request Sep 27, 2017

"Return to editor" link is wrong when comparing revisions #2808

Closed

This was referenced Sep 27, 2017

Bump plugin to version 1.2.0 #2810

Merged

Use Gutenberg as default editor #2824

Closed

Tug pushed a commit that referenced this pull request Feb 28, 2020

Merge pull request #1797 from wordpress-mobile/issue/remove-ios-xcwor…

bc83e25

…kspace [iOS] Remove xcworkspace.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Let Gutenberg be default editor for posts with blocks; add links to classic editor #1797

Let Gutenberg be default editor for posts with blocks; add links to classic editor #1797

westonruter commented Jul 7, 2017 •

edited

Loading

westonruter commented Jul 7, 2017

afercia commented Jul 9, 2017

westonruter commented Jul 10, 2017

afercia commented Jul 10, 2017

westonruter commented Jul 10, 2017

afercia commented Jul 10, 2017

westonruter commented Jul 10, 2017

ellatrix Jul 14, 2017

westonruter Jul 15, 2017

ellatrix Jul 18, 2017

westonruter Jul 18, 2017

westonruter commented Jul 25, 2017

karmatosed commented Aug 30, 2017

afercia commented Aug 30, 2017

karmatosed commented Aug 30, 2017

afercia commented Aug 31, 2017

aduth commented Sep 1, 2017

aduth commented Sep 1, 2017

aduth Sep 1, 2017

westonruter Sep 1, 2017

westonruter Sep 1, 2017

aduth Sep 1, 2017

westonruter Sep 1, 2017

aduth commented Sep 6, 2017

codecov bot commented Sep 6, 2017 •

edited

Loading

	/**
	* Filters the post edit link to default to the Gutenberg editor when the post content contains a block.
	*
	* @since 0.5.0
	*
	* @param string $url The edit link URL.
	* @param int $post_id Post ID.
	* @param string $context The link context. If set to 'display' then ampersands are encoded.
	* @return string Edit post link.
	*/
	function gutenberg_filter_edit_post_link( $url, $post_id, $context ) {
	$post = get_post( $post_id );
	if ( gutenberg_can_edit_post( $post_id ) && gutenberg_post_has_blocks( $post_id ) && post_type_supports( get_post_type( $post_id ), 'editor' ) ) {
	$gutenberg_url = gutenberg_get_edit_post_url( $post->ID );
	if ( 'display' === $context ) {
	$gutenberg_url = esc_url( $gutenberg_url );
	}
	$url = $gutenberg_url;
	}
	return $url;
	}
	add_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10, 3 );

	$classic_text = __( 'Edit in Classic Editor', 'gutenberg' );
	remove_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10 );
	$classic_url = get_edit_post_link( $post->ID, 'raw' );
	add_filter( 'get_edit_post_link', 'gutenberg_filter_edit_post_link', 10, 3 );

Let Gutenberg be default editor for posts with blocks; add links to classic editor #1797

Let Gutenberg be default editor for posts with blocks; add links to classic editor #1797

Conversation

westonruter commented Jul 7, 2017 • edited Loading

westonruter commented Jul 7, 2017

afercia commented Jul 9, 2017

westonruter commented Jul 10, 2017

afercia commented Jul 10, 2017

westonruter commented Jul 10, 2017

afercia commented Jul 10, 2017

westonruter commented Jul 10, 2017

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

westonruter commented Jul 25, 2017

karmatosed commented Aug 30, 2017

afercia commented Aug 30, 2017

karmatosed commented Aug 30, 2017

afercia commented Aug 31, 2017

aduth commented Sep 1, 2017

aduth commented Sep 1, 2017

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

aduth commented Sep 6, 2017

codecov bot commented Sep 6, 2017 • edited Loading

Codecov Report

westonruter commented Jul 7, 2017 •

edited

Loading

codecov bot commented Sep 6, 2017 •

edited

Loading