Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Corrected @deprecated doc Order in Inline Documentation #64013

Merged
merged 1 commit into from
Jul 27, 2024
Merged

Corrected @deprecated doc Order in Inline Documentation #64013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lib/experimental/script-modules.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,12 @@ function gutenberg_register_view_module_ids_rest_field() {
* Registers the module if no module with that module identifier has already
* been registered.
*
* @deprecated 17.6.0 gutenberg_register_module is deprecated. Please use wp_register_script_module instead.
*
* @param string $module_identifier The identifier of the module. Should be unique. It will be used in the final import map.
* @param string $src Full URL of the module, or path of the script relative to the WordPress root directory.
* @param array $dependencies Optional. An array of module identifiers of the dependencies of this module. The dependencies can be strings or arrays. If they are arrays, they need an `id` key with the module identifier, and can contain an `import` key with either `static` or `dynamic`. By default, dependencies that don't contain an import are considered static.
* @param string|false|null $version Optional. String specifying module version number. Defaults to false. It is added to the URL as a query string for cache busting purposes. If $version is set to false, the version number is the currently installed WordPress version. If $version is set to null, no version is added.
* @deprecated 17.6.0 gutenberg_register_module is deprecated. Please use wp_register_script_module instead.
*/
function gutenberg_register_module( $module_identifier, $src = '', $dependencies = array(), $version = false ) {
_deprecated_function( __FUNCTION__, 'Gutenberg 17.6.0', 'wp_register_script_module' );
Expand All @@ -179,8 +180,9 @@ function gutenberg_register_module( $module_identifier, $src = '', $dependencies
/**
* Marks the module to be enqueued in the page.
*
* @param string $module_identifier The identifier of the module.
* @deprecated 17.6.0 gutenberg_enqueue_module is deprecated. Please use wp_enqueue_script_module instead.
*
* @param string $module_identifier The identifier of the module.
*/
function gutenberg_enqueue_module( $module_identifier ) {
_deprecated_function( __FUNCTION__, 'Gutenberg 17.6.0', 'wp_enqueue_script_module' );
Expand All @@ -190,8 +192,9 @@ function gutenberg_enqueue_module( $module_identifier ) {
/**
* Unmarks the module so it is not longer enqueued in the page.
*
* @param string $module_identifier The identifier of the module.
* @deprecated 17.6.0 gutenberg_dequeue_module is deprecated. Please use wp_dequeue_script_module instead.
*
* @param string $module_identifier The identifier of the module.
*/
function gutenberg_dequeue_module( $module_identifier ) {
_deprecated_function( __FUNCTION__, 'Gutenberg 17.6.0', 'wp_dequeue_script_module' );
Expand Down
3 changes: 2 additions & 1 deletion packages/block-editor/src/components/use-settings/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ export function useSettings( ...paths ) {
* It looks up the setting first in the block instance hierarchy.
* If none is found, it'll look it up in the block editor settings.
*
* @deprecated 6.5.0 Use useSettings instead.
*
* @param {string} path The path to the setting.
* @return {any} Returns the value defined for the setting.
* @deprecated 6.5.0 Use useSettings instead.
* @example
* ```js
* const isEnabled = useSetting( 'typography.dropCap' );
Expand Down
Loading