Try: Improve permalink editing #12009

earnjam · 2018-11-17T04:18:38Z

Description

Allows immediate editing of permalinks, without requiring a save.
Fixes: #7129, #12714, #12031

Notes:

In order edit the permalink before a save, we need to know what the permalink template structure is on page load. To get this, we need to modify get_sample_permalink() in core to add the auto-save status to the list of statuses that are faked to publish. See: /wp-admin/includes/post.php#L1310. In the PR, I just used the get_sample_permalink filter at the end of the function and passed the parameters back through it, pretending it was published. I will need to open a separate core ticket to address this for whenever it's merged.

How has this been tested?

Extensive testing across various post statuses and different orders of editing the slug and/or title and the different methods of saving, publishing and transitioning the post status.

packages/editor/src/components/post-permalink/index.js

afercia · 2018-11-18T16:51:31Z

Related: #12031

earnjam · 2018-11-20T20:37:24Z

Rebased and resolved merge conflicts. Still need to apply the updates to the sidebar panel too, but not sure the level of refactoring that should be done at this point right before an RC.

Should note again that this PR would require a core patch at merge time.

youknowriad · 2019-01-22T07:56:01Z

Thanks @earnjam for this PR and sorry for the delays, I'd like to see #7129 fixed if we can. It seems that this PR does a lot of things in parallel, do you think it's possible to split it into steps or does it only make sense as a single PR?

earnjam · 2019-01-22T11:18:30Z

@youknowriad I'll look over this again today and see if I can split it up a bit. I think the only thing we could split out would be the application of the preview functionality, though I do think that would be nice to have.

The other question around this, would it be more helpful to have a shared permalink component to use between both the title and the sidebar permalink editor instead of duplicating the effort?

youknowriad · 2019-01-22T11:43:52Z

The other question around this, would it be more helpful to have a shared permalink component to use between both the title and the sidebar permalink editor instead of duplicating the effort?

IMO, the title permalink should be deprecated at some point, but if it's easy to factorize a shared component, then, yes, it sounds like a great idea.

earnjam · 2019-02-15T14:42:22Z

I rebased master, stripped out the preview functionality, moved the slug logic to a new getEditedPostSlug selector, and cleaned up the commits to make it easier to follow/read the changes here.

I think this probably the minimum required to fix #7129 to allow permalink editing immediately without requiring any saves.

There are more improvements that I'll probably try to make in separate PRs, such as recreating the logic from the sanitize_permalink() php function to make it a more exact match to what will be saved.

youknowriad

The code is looking very good here. Do you think we should land this before the the core patch https://core.trac.wordpress.org/ticket/46266 or maybe wait until the approach is validated. Who do you think can validate that patch?

earnjam · 2020-03-16T09:15:04Z

@youknowriad I'm going to loop @desrosj in today to get his feedback on the core side and see if we should validate with anyone else, but I don't anticipate it being an issue.

youknowriad

This seems to work well for me. 👍

youknowriad · 2020-03-18T11:55:20Z

Can we rebase and land this?

This somewhat diminishes the effects of this pull request, but it will help it pass the e2e tests and also streamlines writing a bit. Reverts back to preventing showing the permalink editor in the title until after a manual or autosave. It does at least show the actual permalink on the autosave and users can edit the slug at any time using the document sidebar.

earnjam · 2020-03-18T12:24:51Z

Rebased. I'll wait for tests to finish and then land it.

youknowriad · 2020-03-18T14:01:53Z

Great work here and thanks for pushing it to the finish line.

youknowriad · 2020-03-18T14:03:41Z

Should we still close the three issues mentioned here #7129, #12714, #12031

earnjam · 2020-03-18T19:11:09Z

Yep, all 3 are closed now. The last one had some additional discussion on it, but the original basis of the ticket is resolved. I told Andrea he could open it back up if he felt it wasn't resolved.

paaljoachim · 2020-03-24T09:05:44Z

I found it interesting that clicking Edit having the save button visible one could click it or just click outside into empty space or another block to automatically close it. Perhaps this method can be used with other features as well. Instead of adding a cancel button one just clicks outside the button and the area it belongs to.
I am thinking about the creation of reusable block and one wants to cancel the creation. #12940

earnjam mentioned this pull request Nov 17, 2018

Update displayed permalink when slug is cleared #11783

Merged

earnjam added the [Feature] Permalink The permalink of a post or page and the experience of setting or editing it label Nov 17, 2018

swissspidy reviewed Nov 17, 2018

View reviewed changes

packages/editor/src/components/post-permalink/index.js Outdated Show resolved Hide resolved

earnjam mentioned this pull request Nov 18, 2018

Add permalinks to the document sidebar #11874

Merged

earnjam force-pushed the try/improve-permalink-editing branch from 73a5d50 to 038395d Compare November 20, 2018 20:29

noisysocks added this to the 4.8 milestone Dec 10, 2018

youknowriad modified the milestones: 4.8, 4.9 Dec 19, 2018

youknowriad modified the milestones: 4.9 (Gutenberg), 5.0 (Gutenberg) Jan 21, 2019

youknowriad requested a review from a team January 22, 2019 07:56

youknowriad modified the milestones: 5.0 (Gutenberg), 5.1 (Gutenberg) Feb 4, 2019

earnjam force-pushed the try/improve-permalink-editing branch from 038395d to 9335715 Compare February 15, 2019 14:35

earnjam requested review from aduth, gziolo, noisysocks, talldan and youknowriad as code owners February 15, 2019 14:35

earnjam force-pushed the try/improve-permalink-editing branch from 9335715 to 85fa2b2 Compare February 15, 2019 15:11

earnjam requested review from ajitbohra, chrisvanpatten, mkaz and oandregal as code owners February 15, 2019 15:11

earnjam removed the [Status] Stale Gives the original author opportunity to update before closing. Can be reopened as needed. label Mar 13, 2020

youknowriad reviewed Mar 16, 2020

View reviewed changes

youknowriad approved these changes Mar 16, 2020

View reviewed changes

earnjam added 9 commits March 18, 2020 08:22

Filter REST API to return permalink_template

be32226

Add new getEditedPostSlug selector

d61a01b

Update auto-generated docs

e3b5009

Make permalink editing more timely/accurate in title editor

d13f4a7

Make permalink editing more timely/accurate in sidebar panel

ea081f5

Apply minor code style changes

3217fa1

Update e2e tests to reflect that panel should always show

bb2f588

Add unit tests for getEditedPostSlug selector

bd08f74

earnjam force-pushed the try/improve-permalink-editing branch from c4830d3 to ddeeb8d Compare March 18, 2020 12:23

earnjam merged commit 8ee1f0c into master Mar 18, 2020

earnjam deleted the try/improve-permalink-editing branch March 18, 2020 13:20

github-actions bot added this to the Gutenberg 7.8 milestone Mar 18, 2020

youknowriad mentioned this pull request Mar 18, 2020

Refining the permalink structure #12714

Closed

afercia mentioned this pull request Mar 19, 2020

Improve Permalink UI placement and tab order #5494

Closed

paaljoachim mentioned this pull request Mar 24, 2020

Can't cancel creation of Resuable Block #12940

Closed

This was referenced Apr 7, 2020

Navigation: Clicking to add top level page but deciding not to leaves "Add link..." in place #21450

Closed

Navigation: Not adding a submenu the "Add link..." remains and is not automatically deleted. #21448

Closed

ellatrix mentioned this pull request Jun 16, 2020

WP 5.5: merge all PHP changes #23210

Closed

12 tasks

hansjovis mentioned this pull request Aug 14, 2020

Initialize slug from the store when in block editor Yoast/wordpress-seo#15857

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Try: Improve permalink editing #12009

Try: Improve permalink editing #12009

earnjam commented Nov 17, 2018 •

edited

Loading

afercia commented Nov 18, 2018

earnjam commented Nov 20, 2018

youknowriad commented Jan 22, 2019 •

edited

Loading

earnjam commented Jan 22, 2019

youknowriad commented Jan 22, 2019

earnjam commented Feb 15, 2019

youknowriad left a comment

earnjam commented Mar 16, 2020

youknowriad left a comment

youknowriad commented Mar 18, 2020

earnjam commented Mar 18, 2020

youknowriad commented Mar 18, 2020

youknowriad commented Mar 18, 2020

earnjam commented Mar 18, 2020

paaljoachim commented Mar 24, 2020 •

edited

Loading

Try: Improve permalink editing #12009

Try: Improve permalink editing #12009

Conversation

earnjam commented Nov 17, 2018 • edited Loading

Description

How has this been tested?

afercia commented Nov 18, 2018

earnjam commented Nov 20, 2018

youknowriad commented Jan 22, 2019 • edited Loading

earnjam commented Jan 22, 2019

youknowriad commented Jan 22, 2019

earnjam commented Feb 15, 2019

youknowriad left a comment

Choose a reason for hiding this comment

earnjam commented Mar 16, 2020

youknowriad left a comment

Choose a reason for hiding this comment

youknowriad commented Mar 18, 2020

earnjam commented Mar 18, 2020

youknowriad commented Mar 18, 2020

youknowriad commented Mar 18, 2020

earnjam commented Mar 18, 2020

paaljoachim commented Mar 24, 2020 • edited Loading

earnjam commented Nov 17, 2018 •

edited

Loading

youknowriad commented Jan 22, 2019 •

edited

Loading

paaljoachim commented Mar 24, 2020 •

edited

Loading