Deprecated
Deprecation utility for WordPress. Logs a message to notify developers about a deprecated feature.
Installation
Install the module
npm install @wordpress/deprecated --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.
Hook
The deprecated
action is fired with three parameters: the name of the deprecated feature, the options object passed to deprecated, and the message sent to the console.
Example:
import { addAction } from '@wordpress/hooks';
function addDeprecationAlert( message, { version } ) {
alert( `Deprecation: ${ message }. Version: ${ version }` );
}
addAction( 'deprecated', 'my-plugin/add-deprecation-alert', addDeprecationAlert );
API
default
src/index.js#L39-L78
Logs a message to notify developers about a deprecated feature.
Usage
import deprecated from '@wordpress/deprecated';
deprecated( 'Eating meat', {
version: 'the future',
alternative: 'vegetables',
plugin: 'the earth',
hint: 'You may find it beneficial to transition gradually.',
} );
Parameters
- feature
string
: Name of the deprecated feature. - options
?Object
: Personalisation options - options.version
?string
: Version in which the feature will be removed. - options.alternative
?string
: Feature to use instead - options.plugin
?string
: Plugin name if it's a plugin feature - options.link
?string
: Link to documentation - options.hint
?string
: Additional message to help transition away from the deprecated feature.
logged
src/index.js#L12-L12
Object map tracking messages which have been logged, for use in ensuring a
message is only logged once.
Type
Object