Clarify the block editor settings from the post editor settings (#14082)

docs/designers-developers/developers/data/data-core-block-editor.md

@@ -737,7 +737,7 @@ Returns the Block List settings of a block, if any exist.
 
 Block settings of the block if set.
 
-### getEditorSettings
+### getSettings
 
 Returns the editor settings.
 
@@ -1027,9 +1027,9 @@ Returns an action object that changes the nested settings of a given block.
                          being received.
  * settings: Object with the new settings for the nested block.
 
-### updateEditorSettings
+### updateSettings
 
-Returns an action object used in signalling that the editor settings have been updated.
+Returns an action object used in signalling that the block editor settings have been updated.
 
 *Parameters*
 

docs/designers-developers/developers/data/data-core-editor.md

@@ -718,6 +718,18 @@ Is the editor ready
 
 is Ready.
 
+### getEditorSettings
+
+Returns the post editor settings.
+
+*Parameters*
+
+ * state: Editor state.
+
+*Returns*
+
+The editor settings object.
+
 ## Actions
 
 ### setupEditor
@@ -967,4 +979,12 @@ Returns an action object used to signal that the blocks have been updated.
 *Parameters*
 
  * blocks: Block Array.
- * options: Optional options.
+ * options: Optional options.
+
+### updateEditorSettings
+
+Returns an action object used in signalling that the post editor settings have been updated.
+
+*Parameters*
+
+ * settings: Updated settings

packages/block-editor/src/components/provider/index.js

@@ -30,22 +30,22 @@ const withRegistry = createHigherOrderComponent(
 
 class BlockEditorProvider extends Component {
 	componentDidMount() {
-		this.props.updateEditorSettings( this.props.settings );
+		this.props.updateSettings( this.props.settings );
 		this.props.resetBlocks( this.props.value );
 		this.attachChangeObserver( this.props.registry );
 	}
 
 	componentDidUpdate( prevProps ) {
 		const {
 			settings,
-			updateEditorSettings,
+			updateSettings,
 			value,
 			resetBlocks,
 			registry,
 		} = this.props;
 
 		if ( settings !== prevProps.settings ) {
-			updateEditorSettings( settings );
+			updateSettings( settings );
 		}
 
 		if ( registry !== prevProps.registry ) {
@@ -139,12 +139,12 @@ class BlockEditorProvider extends Component {
 export default compose( [
 	withDispatch( ( dispatch ) => {
 		const {
-			updateEditorSettings,
+			updateSettings,
 			resetBlocks,
 		} = dispatch( 'core/block-editor' );
 
 		return {
-			updateEditorSettings,
+			updateSettings,
 			resetBlocks,
 		};
 	} ),

packages/block-editor/src/index.js

@@ -9,3 +9,5 @@ import '@wordpress/blocks';
 import './store';
 
 export * from './components';
+
+export { SETTINGS_DEFAULTS } from './store/defaults';

packages/block-editor/src/store/actions.js

@@ -514,15 +514,15 @@ export function updateBlockListSettings( clientId, settings ) {
 }
 
 /*
- * Returns an action object used in signalling that the editor settings have been updated.
+ * Returns an action object used in signalling that the block editor settings have been updated.
  *
  * @param {Object} settings Updated settings
  *
  * @return {Object} Action object
  */
-export function updateEditorSettings( settings ) {
+export function updateSettings( settings ) {
 	return {
-		type: 'UPDATE_EDITOR_SETTINGS',
+		type: 'UPDATE_SETTINGS',
 		settings,
 	};
 }

packages/block-editor/src/store/defaults.js

@@ -10,17 +10,22 @@ export const PREFERENCES_DEFAULTS = {
 /**
  * The default editor settings
  *
- *  alignWide          boolean        Enable/Disable Wide/Full Alignments
- *  colors             Array          Palette colors
- *  fontSizes          Array          Available font sizes
- *  imageSizes         Array          Available image sizes
- *  maxWidth           number         Max width to constraint resizing
- *  blockTypes         boolean|Array  Allowed block types
- *  hasFixedToolbar    boolean        Whether or not the editor toolbar is fixed
- *  focusMode          boolean        Whether the focus mode is enabled or not
- *  richEditingEnabled boolean        Whether rich editing is enabled or not
+ *  alignWide              boolean        Enable/Disable Wide/Full Alignments
+ *  colors                 Array          Palette colors
+ *  disableCustomColors    boolean        Whether or not the custom colors are disabled
+ *  fontSizes              Array          Available font sizes
+ *  disableCustomFontSizes boolean        Whether or not the custom font sizes are disabled
+ *  imageSizes             Array          Available image sizes
+ *  maxWidth               number         Max width to constraint resizing
+ *  blockTypes             boolean|Array  Allowed block types
+ *  hasFixedToolbar        boolean        Whether or not the editor toolbar is fixed
+ *  focusMode              boolean        Whether the focus mode is enabled or not
+ *  styles                 Array          Editor Styles
+ *  isRTL                  boolean        Whether the editor is in RTL mode
+ *  bodyPlaceholder        string         Empty post placeholder
+ *  titlePlaceholder       string         Empty title placeholder
  */
-export const EDITOR_SETTINGS_DEFAULTS = {
+export const SETTINGS_DEFAULTS = {
 	alignWide: false,
 	colors: [
 		{
@@ -126,8 +131,5 @@ export const EDITOR_SETTINGS_DEFAULTS = {
 
 	// List of allowed mime types and file extensions.
 	allowedMimeTypes: null,
-
-	// Whether richs editing is enabled or not.
-	richEditingEnabled: true,
 };
 

packages/block-editor/src/store/reducer.js

@@ -26,7 +26,7 @@ import { isReusableBlock } from '@wordpress/blocks';
  */
 import {
 	PREFERENCES_DEFAULTS,
-	EDITOR_SETTINGS_DEFAULTS,
+	SETTINGS_DEFAULTS,
 } from './defaults';
 import { insertAt, moveTo } from './array';
 
@@ -830,9 +830,9 @@ export function template( state = { isValid: true }, action ) {
  *
  * @return {Object} Updated state.
  */
-export function settings( state = EDITOR_SETTINGS_DEFAULTS, action ) {
+export function settings( state = SETTINGS_DEFAULTS, action ) {
 	switch ( action.type ) {
-		case 'UPDATE_EDITOR_SETTINGS':
+		case 'UPDATE_SETTINGS':
 			return {
 				...state,
 				...action.settings,

packages/block-editor/src/store/selectors.js

@@ -1034,7 +1034,7 @@ const canInsertBlockTypeUnmemoized = ( state, blockName, rootClientId = null ) =
 		return false;
 	}
 
-	const { allowedBlockTypes } = getEditorSettings( state );
+	const { allowedBlockTypes } = getSettings( state );
 
 	const isBlockAllowedInEditor = checkAllowList( allowedBlockTypes, blockName, true );
 	if ( ! isBlockAllowedInEditor ) {
@@ -1350,7 +1350,7 @@ export function getBlockListSettings( state, clientId ) {
  *
  * @return {Object} The editor settings object.
  */
-export function getEditorSettings( state ) {
+export function getSettings( state ) {
 	return state.settings;
 }
 

packages/block-editor/src/store/test/effects.js

@@ -18,7 +18,7 @@ import { createRegistry } from '@wordpress/data';
  * Internal dependencies
  */
 import actions, {
-	updateEditorSettings,
+	updateSettings,
 	mergeBlocks,
 	replaceBlocks,
 	resetBlocks,
@@ -234,7 +234,7 @@ describe( 'effects', () => {
 		} );
 
 		it( 'should return undefined if invalid but unlocked', () => {
-			store.dispatch( updateEditorSettings( {
+			store.dispatch( updateSettings( {
 				template: [
 					[ 'core/foo', {} ],
 				],
@@ -248,7 +248,7 @@ describe( 'effects', () => {
 		} );
 
 		it( 'should return undefined if locked and valid', () => {
-			store.dispatch( updateEditorSettings( {
+			store.dispatch( updateSettings( {
 				template: [
 					[ 'core/test-block' ],
 				],
@@ -263,7 +263,7 @@ describe( 'effects', () => {
 		} );
 
 		it( 'should return validity set action if invalid on default state', () => {
-			store.dispatch( updateEditorSettings( {
+			store.dispatch( updateSettings( {
 				template: [
 					[ 'core/foo' ],
 				],

packages/block-library/src/html/edit.js

@@ -87,8 +87,8 @@ class HTMLEdit extends Component {
 	}
 }
 export default withSelect( ( select ) => {
-	const { getEditorSettings } = select( 'core/block-editor' );
+	const { getSettings } = select( 'core/block-editor' );
 	return {
-		styles: getEditorSettings().styles,
+		styles: getSettings().styles,
 	};
 } )( HTMLEdit );

packages/block-library/src/image/edit.js

@@ -705,9 +705,9 @@ class ImageEdit extends Component {
 export default compose( [
 	withSelect( ( select, props ) => {
 		const { getMedia } = select( 'core' );
-		const { getEditorSettings } = select( 'core/block-editor' );
+		const { getSettings } = select( 'core/block-editor' );
 		const { id } = props.attributes;
-		const { maxWidth, isRTL, imageSizes } = getEditorSettings();
+		const { maxWidth, isRTL, imageSizes } = getSettings();
 
 		return {
 			image: id ? getMedia( id ) : null,

packages/block-library/src/paragraph/edit.js

@@ -259,10 +259,10 @@ const ParagraphEdit = compose( [
 	withFontSizes( 'fontSize' ),
 	applyFallbackStyles,
 	withSelect( ( select ) => {
-		const { getEditorSettings } = select( 'core/block-editor' );
+		const { getSettings } = select( 'core/block-editor' );
 
 		return {
-			isRTL: getEditorSettings().isRTL,
+			isRTL: getSettings().isRTL,
 		};
 	} ),
 ] )( ParagraphBlock );

packages/block-library/src/pullquote/index.js

@@ -100,7 +100,7 @@ export const settings = {
 		// Is normal style and a named color is being used, we need to retrieve the color value to set the style,
 		// as there is no expectation that themes create classes that set border colors.
 		} else if ( mainColor ) {
-			const colors = get( select( 'core/block-editor' ).getEditorSettings(), [ 'colors' ], [] );
+			const colors = get( select( 'core/block-editor' ).getSettings(), [ 'colors' ], [] );
 			const colorObject = getColorObjectByAttributeValues( colors, mainColor );
 			figureStyles = {
 				borderColor: colorObject.color,

packages/edit-post/src/components/header/header-toolbar/index.js

@@ -57,7 +57,7 @@ export default compose( [
 	withSelect( ( select ) => ( {
 		hasFixedToolbar: select( 'core/edit-post' ).isFeatureActive( 'fixedToolbar' ),
 		// This setting (richEditingEnabled) should not live in the block editor's setting.
-		showInserter: select( 'core/edit-post' ).getEditorMode() === 'visual' && select( 'core/block-editor' ).getEditorSettings().richEditingEnabled,
+		showInserter: select( 'core/edit-post' ).getEditorMode() === 'visual' && select( 'core/editor' ).getEditorSettings().richEditingEnabled,
 		isTextModeEnabled: select( 'core/edit-post' ).getEditorMode() === 'text',
 	} ) ),
 	withViewportMatch( { isLargeViewport: 'medium' } ),

packages/edit-post/src/components/header/mode-switcher/index.js

@@ -49,7 +49,7 @@ function ModeSwitcher( { onSwitch, mode } ) {
 
 export default compose( [
 	withSelect( ( select ) => ( {
-		isRichEditingEnabled: select( 'core/block-editor' ).getEditorSettings().richEditingEnabled,
+		isRichEditingEnabled: select( 'core/editor' ).getEditorSettings().richEditingEnabled,
 		mode: select( 'core/edit-post' ).getEditorMode(),
 	} ) ),
 	ifCondition( ( { isRichEditingEnabled } ) => isRichEditingEnabled ),

packages/edit-post/src/components/keyboard-shortcuts/index.js

@@ -55,7 +55,7 @@ class EditorModeKeyboardShortcuts extends Component {
 
 export default compose( [
 	withSelect( ( select ) => ( {
-		isRichEditingEnabled: select( 'core/block-editor' ).getEditorSettings().richEditingEnabled,
+		isRichEditingEnabled: select( 'core/editor' ).getEditorSettings().richEditingEnabled,
 		mode: select( 'core/edit-post' ).getEditorMode(),
 		isEditorSidebarOpen: select( 'core/edit-post' ).isEditorSidebarOpened(),
 	} ) ),

packages/edit-post/src/components/layout/index.js

@@ -137,7 +137,7 @@ export default compose(
 		hasFixedToolbar: select( 'core/edit-post' ).isFeatureActive( 'fixedToolbar' ),
 		hasActiveMetaboxes: select( 'core/edit-post' ).hasMetaBoxes(),
 		isSaving: select( 'core/edit-post' ).isSavingMetaBoxes(),
-		isRichEditingEnabled: select( 'core/block-editor' ).getEditorSettings().richEditingEnabled,
+		isRichEditingEnabled: select( 'core/editor' ).getEditorSettings().richEditingEnabled,
 	} ) ),
 	withDispatch( ( dispatch ) => {
 		const { closePublishSidebar, togglePublishSidebar } = dispatch( 'core/edit-post' );

packages/edit-post/src/components/options-modal/meta-boxes-section.js

@@ -34,7 +34,7 @@ export function MetaBoxesSection( { areCustomFieldsRegistered, metaBoxes, ...sec
 }
 
 export default withSelect( ( select ) => {
-	const { getEditorSettings } = select( 'core/block-editor' );
+	const { getEditorSettings } = select( 'core/editor' );
 	const { getAllMetaBoxes } = select( 'core/edit-post' );
 
 	return {

packages/edit-post/src/components/options-modal/options/enable-custom-fields.js

@@ -43,5 +43,5 @@ export class EnableCustomFieldsOption extends Component {
 }
 
 export default withSelect( ( select ) => ( {
-	isChecked: !! select( 'core/block-editor' ).getEditorSettings().enableCustomFields,
+	isChecked: !! select( 'core/editor' ).getEditorSettings().enableCustomFields,
 } ) )( EnableCustomFieldsOption );

packages/edit-post/src/components/text-editor/index.js

@@ -38,7 +38,7 @@ function TextEditor( { onExit, isRichEditingEnabled } ) {
 
 export default compose(
 	withSelect( ( select ) => ( {
-		isRichEditingEnabled: select( 'core/block-editor' ).getEditorSettings().richEditingEnabled,
+		isRichEditingEnabled: select( 'core/editor' ).getEditorSettings().richEditingEnabled,
 	} ) ),
 	withDispatch( ( dispatch ) => {
 		return {

packages/editor/src/components/alignment-toolbar/index.js

@@ -69,10 +69,10 @@ export default compose(
 	} ),
 	withViewportMatch( { isLargeViewport: 'medium' } ),
 	withSelect( ( select, { clientId, isLargeViewport, isCollapsed } ) => {
-		const { getBlockRootClientId, getEditorSettings } = select( 'core/block-editor' );
+		const { getBlockRootClientId, getSettings } = select( 'core/block-editor' );
 		return {
 			isCollapsed: isCollapsed || ! isLargeViewport || (
-				! getEditorSettings().hasFixedToolbar &&
+				! getSettings().hasFixedToolbar &&
 				getBlockRootClientId( clientId )
 			),
 		};

packages/editor/src/components/autosave-monitor/index.js

@@ -66,8 +66,7 @@ export default compose( [
 			isAutosavingPost,
 		} = select( 'core/editor' );
 
-		// This settings should not live in the block editor.
-		const { autosaveInterval } = select( 'core/block-editor' ).getEditorSettings();
+		const { autosaveInterval } = select( 'core/editor' ).getEditorSettings();
 
 		return {
 			isDirty: isEditedPostDirty(),

packages/editor/src/components/block-alignment-toolbar/index.js

@@ -75,11 +75,12 @@ export default compose(
 	} ),
 	withViewportMatch( { isLargeViewport: 'medium' } ),
 	withSelect( ( select, { clientId, isLargeViewport, isCollapsed } ) => {
-		const { getBlockRootClientId, getEditorSettings } = select( 'core/block-editor' );
+		const { getBlockRootClientId, getSettings } = select( 'core/block-editor' );
+		const settings = getSettings();
 		return {
-			wideControlsEnabled: select( 'core/block-editor' ).getEditorSettings().alignWide,
+			wideControlsEnabled: settings.alignWide,
 			isCollapsed: isCollapsed || ! isLargeViewport || (
-				! getEditorSettings().hasFixedToolbar &&
+				! settings.hasFixedToolbar &&
 				getBlockRootClientId( clientId )
 			),
 		};