[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/js/dist/ -> preferences.js (summary)

WordPress dependencies

File Size: 345 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  defaults()
  preferences()
  toggle()
  set()
  setDefaults()
  get()
  PreferenceToggleMenuItem()

Functions
Functions that are not part of a class:

defaults()   X-Ref
Reducer returning the defaults for user preferences.

This is kept intentionally separate from the preferences
themselves so that defaults are not persisted.

return: {Object} Updated state.
param: {Object} state  Current state.
param: {Object} action Dispatched action.

preferences()   X-Ref
Reducer returning the user preferences.

return: {Object} Updated state.
param: {Object} state  Current state.
param: {Object} action Dispatched action.

toggle(scope, name)   X-Ref
Returns an action object used in signalling that a preference should be
toggled.

param: {string} scope The preference scope (e.g. core/edit-post).
param: {string} name  The preference name.

set(scope, name, value)   X-Ref
Returns an action object used in signalling that a preference should be set
to a value

return: {Object} Action object.
param: {string} scope The preference scope (e.g. core/edit-post).
param: {string} name  The preference name.
param: {*}      value The value to set.

setDefaults(scope, defaults)   X-Ref
Returns an action object used in signalling that preference defaults should
be set.

return: {Object} Action object.
param: {string}            scope    The preference scope (e.g. core/edit-post).
param: {Object<string, *>} defaults A key/value map of preference names to values.

get(state, scope, name)   X-Ref
Returns a boolean indicating whether a prefer is active for a particular
scope.

return: {*} Is the feature enabled?
param: {Object} state The store state.
param: {string} scope The scope of the feature (e.g. core/edit-post).
param: {string} name  The name of the feature.

PreferenceToggleMenuItem(_ref)   X-Ref
Internal dependencies




Generated: Fri Apr 19 01:00:02 2024 Cross-referenced by PHPXref 0.7.1