Changeset 56414 for trunk/src/wp-includes/functions.wp-scripts.php

Timestamp:

08/18/2023 05:27:16 PM (16 months ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock corrections and improvements.

See #58833

File:

• trunk/src/wp-includes/functions.wp-scripts.php (modified) (4 diffs)

trunk/src/wp-includes/functions.wp-scripts.php

@@ -74 +74 @@
  * Called by admin-header.php and {@see 'wp_head'} hook. Since it is called by wp_head on every page load,
  * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
- * Makes use of already-instantiated $wp_scripts global if present. Use provided {@see 'wp_print_scripts'}
+ * Makes use of already-instantiated `$wp_scripts` global if present. Use provided {@see 'wp_print_scripts'}
  * hook to register/enqueue new scripts.
  *
@@ -114 +114 @@
  *
  * Code will only be added if the script is already in the queue.
- * Accepts a string $data containing the Code. If two or more code blocks
- * are added to the same script $handle, they will be printed in the order
+ * Accepts a string `$data` containing the code. If two or more code blocks
+ * are added to the same script `$handle`, they will be printed in the order
  * they were added, i.e. the latter added code can redeclare the previous.
  *
@@ -202 +202 @@
  * Works only if the script has already been registered.
  *
- * Accepts an associative array $l10n and creates a JavaScript object:
- *
- *     "$object_name" = {
+ * Accepts an associative array `$l10n` and creates a JavaScript object:
+ *
+ *     "$object_name": {
  *         key: value,
  *         key: value,
@@ -338 +338 @@
  * Enqueues a script.
  *
- * Registers the script if $src provided (does NOT overwrite), and enqueues it.
+ * Registers the script if `$src` provided (does NOT overwrite), and enqueues it.
  *
  * @see WP_Dependencies::add()