Plugins: Deprecate 'withPluginContext' HOC (WordPress#66363)

Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org>
pewresearch · Oct 23, 2024 · 71bb8b8 · 71bb8b8
1 parent 78b65c5
commit 71bb8b8
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 0 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/plugins/README.md b/packages/plugins/README.md
@@ -192,6 +192,8 @@ _Returns_
 
 #### withPluginContext
 
+> **Deprecated** 6.8.0 Use `usePluginContext` hook instead.
+
 A Higher Order Component used to inject Plugin context to the wrapped component.
 
 _Parameters_

diff --git a/packages/plugins/package.json b/packages/plugins/package.json
@@ -30,6 +30,7 @@
 		"@babel/runtime": "7.25.7",
 		"@wordpress/components": "*",
 		"@wordpress/compose": "*",
+		"@wordpress/deprecated": "*",
 		"@wordpress/element": "*",
 		"@wordpress/hooks": "*",
 		"@wordpress/icons": "*",

diff --git a/packages/plugins/src/components/plugin-context/index.tsx b/packages/plugins/src/components/plugin-context/index.tsx
@@ -3,6 +3,7 @@
  */
 import { createContext, useContext } from '@wordpress/element';
 import { createHigherOrderComponent } from '@wordpress/compose';
+import deprecated from '@wordpress/deprecated';
 
 /**
  * Internal dependencies
@@ -34,6 +35,8 @@ export function usePluginContext() {
  * A Higher Order Component used to inject Plugin context to the
  * wrapped component.
  *
+ * @deprecated 6.8.0 Use `usePluginContext` hook instead.
+ *
  * @param  mapContextToProps Function called on every context change,
  *                           expected to return object of props to
  *                           merge with the component's own props.
@@ -47,6 +50,10 @@ export const withPluginContext = (
 	) => T & PluginContext
 ) =>
 	createHigherOrderComponent( ( OriginalComponent ) => {
+		deprecated( 'wp.plugins.withPluginContext', {
+			since: '6.8.0',
+			alternative: 'wp.plugins.usePluginContext',
+		} );
 		return ( props ) => (
 			<Context.Consumer>
 				{ ( context ) => (

diff --git a/packages/plugins/tsconfig.json b/packages/plugins/tsconfig.json
@@ -9,6 +9,7 @@
 	"references": [
 		{ "path": "../components" },
 		{ "path": "../compose" },
+		{ "path": "../deprecated" },
 		{ "path": "../element" },
 		{ "path": "../hooks" },
 		{ "path": "../icons" },