[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

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

Memize options object.

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

Defines 1 class

PluginErrorBoundary:: (5 methods):
  registerPlugin()
  unregisterPlugin()
  getPlugin()
  getPlugins()
  PluginArea()

Defines 5 functions

  memize()
  memoized()
  usePluginContext()

Class: PluginErrorBoundary  - X-Ref

WordPress dependencies

registerPlugin(name, settings)   X-Ref
Registers a plugin to the editor.

param: name     A string identifying the plugin. Must be
param: settings The settings for this plugin.
return: The final plugin settings object.

unregisterPlugin(name)   X-Ref
Unregisters a plugin by name.

param: name Plugin name.
return: The previous plugin settings object, if it has been

getPlugin(name)   X-Ref
Returns a registered plugin settings.

param: name Plugin name.
return: Plugin setting.

getPlugins(scope)   X-Ref
Returns all registered plugins without a scope or for a given scope.

param: scope The scope to be used when rendering inside
return: The list of plugins without a scope or for a given scope.

PluginArea({scope,onError})   X-Ref
A component that renders all plugin fills in a hidden div.

param: props
param: props.scope
param: props.onError
return: {Component} The component to be rendered.

Functions
Functions that are not part of a class:

memize(fn, options)   X-Ref
Accepts a function to be memoized, and returns a new memoized function, with
optional options.

param: {F}             fn        Function to memoize.
param: {MemizeOptions} [options] Options object.
return: {((...args: Parameters<F>) => ReturnType<F>) & MemizeMemoizedFunction} Memoized function.

memoized()   X-Ref
No description

usePluginContext()   X-Ref
A hook that returns the plugin context.

return: {PluginContext} Plugin context



Generated : Thu Mar 28 08:20:01 2024 Cross-referenced by PHPXref