[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 10 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  createNotice()
  createSuccessNotice()
  createInfoNotice()
  createErrorNotice()
  createWarningNotice()
  removeNotice()
  getNotices()

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

createNotice()   X-Ref
Returns an action object used in signalling that a notice is to be created.

return: {Object} Action object.
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
param: {Object}                [options.icon]               An icon displayed with the notice.
param: {boolean}               [options.explicitDismiss]    Whether the notice includes
param: {Function}              [options.onDismiss]          Called when the notice is dismissed.

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.

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

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.

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

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.

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

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.

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

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

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

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

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



Generated: Mon Nov 29 01:00:03 2021 Cross-referenced by PHPXref 0.7.1