@wordpress/deprecated

インストール

モジュールをインストールします

npm install @wordpress/deprecated --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。このような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含める必要があります。

フック

*例:*  
``````bash
import { addAction } from '@wordpress/hooks';
function addDeprecationAlert( message, { version } ) {
   alert( `Deprecation: ${ message }. Version: ${ version }` );
}
addAction(
   'deprecated',
   'my-plugin/add-deprecation-alert',
   addDeprecationAlert
);
`

API

デフォルト

非推奨機能について開発者に通知するメッセージをログに記録します。

使用法

import deprecated from '@wordpress/deprecated';
deprecated( 'Eating meat', {
   since: '2019.01.01'
   version: '2020.01.01',
   alternative: 'vegetables',
   plugin: 'the earth',
   hint: 'You may find it beneficial to transition gradually.',
} );
// Logs: 'Eating meat is deprecated since version 2019.01.01 and will be removed from the earth in version 2020.01.01. Please use vegetables instead. Note: You may find it beneficial to transition gradually.'

パラメータ

• feature string: 非推奨機能の名前。
• options [Object]: パーソナライズオプション
• options.since [string]: 機能が非推奨になったバージョン。
• options.version [string]: 機能が削除されるバージョン。
• options.alternative [string]: 代わりに使用する機能
• options.plugin [string]: プラグイン機能の場合のプラグイン名
• options.link [string]: ドキュメントへのリンク
• options.hint [string]: 非推奨機能からの移行を助けるための追加メッセージ。
  

ログ記録

ログに記録されたメッセージを追跡するオブジェクトマップで、メッセージが一度だけログに記録されることを保証するために使用されます。

タイプ

• Record<string, true | undefined>

このパッケージへの貢献

これはグーテンベルクプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージは[https://www.npmjs.com/]に公開され、[https://make.wordpress.org/core/]や他のソフトウェアプロジェクトで使用されています。

このパッケージやグーテンベルク全体への貢献について詳しく知りたい場合は、プロジェクトの主な[https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md]をお読みください。