[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 16 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  _arrayWithoutHoles()
  _nonIterableSpread()
  _toConsumableArray()
  _iterableToArray()
  createNotice()
  createSuccessNotice()
  createInfoNotice()
  createErrorNotice()
  createWarningNotice()
  removeNotice()
  getNotices()
  _objectSpread()
  _defineProperty()

Functions
Functions that are not part of a class:

__webpack_require__(moduleId)   X-Ref
No description

getDefault()   X-Ref
No description

getModuleExports()   X-Ref
No description

_arrayWithoutHoles(arr)   X-Ref
No description

_nonIterableSpread()   X-Ref
No description

_toConsumableArray(arr)   X-Ref
No description

_iterableToArray(iter)   X-Ref
No description

createNotice()   X-Ref
Yields action objects used in signalling that a notice is to be created.

param: {string}                [status='info']              Notice status.
param: {string}                content                      Notice message.
param: {Object}                [options]                    Notice options.
param: {string}                [options.context='global']   Context under which to
param: {string}                [options.id]                 Identifier for notice.
param: {boolean}               [options.isDismissible=true] Whether the notice can
param: {string}                [options.type='default']     Type of notice, one of
param: {boolean}               [options.speak=true]         Whether the notice
param: {Array<WPNoticeAction>} [options.actions]            User actions to be

createSuccessNotice(content, options)   X-Ref
Returns an action object used in signalling that a success notice is to be
created. Refer to `createNotice` for options documentation.

param: {string} content   Notice message.
param: {Object} [options] Optional notice options.
return: {Object} Action object.

createInfoNotice(content, options)   X-Ref
Returns an action object used in signalling that an info notice is to be
created. Refer to `createNotice` for options documentation.

param: {string} content   Notice message.
param: {Object} [options] Optional notice options.
return: {Object} Action object.

createErrorNotice(content, options)   X-Ref
Returns an action object used in signalling that an error notice is to be
created. Refer to `createNotice` for options documentation.

param: {string} content   Notice message.
param: {Object} [options] Optional notice options.
return: {Object} Action object.

createWarningNotice(content, options)   X-Ref
Returns an action object used in signalling that a warning notice is to be
created. Refer to `createNotice` for options documentation.

param: {string} content   Notice message.
param: {Object} [options] Optional notice options.
return: {Object} Action object.

removeNotice(id)   X-Ref
Returns an action object used in signalling that a notice is to be removed.

param: {string} id                 Notice unique identifier.
param: {string} [context='global'] Optional context (grouping) in which the notice is
return: {Object} Action object.

getNotices(state)   X-Ref
Returns all notices as an array, optionally for a given context. Defaults to
the global context.

param: {Object}  state   Notices state.
param: {?string} context Optional grouping context.
return: {WPNotice[]} Array of notices.

_objectSpread(target)   X-Ref
No description

_defineProperty(obj, key, value)   X-Ref
No description



Generated: Thu Jan 23 01:00:04 2020 Cross-referenced by PHPXref 0.7.1