Changeset 57785

Timestamp:

03/06/2024 05:04:00 AM (7 months ago)

Author:

SergeyBiryukov

Message:

Docs: Add a description for the $wp_embed global.

Follow-up to [57748].

See #60699.

Location:

trunk/src

Files:

• wp-admin/includes/ajax-actions.php (modified) (3 diffs)
• wp-includes/block-template.php (modified) (1 diff)
• wp-includes/class-wp-oembed-controller.php (modified) (1 diff)
• wp-includes/embed.php (modified) (3 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -275 +275 @@
  * @since 3.1.0
  *
- * @global WP_Embed $wp_embed
+ * @global WP_Embed $wp_embed WordPress Embed object.
  */
 function wp_ajax_oembed_cache() {
@@ -3382 +3382 @@
  *
  * @global WP_Post  $post     Global post object.
- * @global WP_Embed $wp_embed
+ * @global WP_Embed $wp_embed WordPress Embed object.
  */
 function wp_ajax_send_link_to_editor() {
@@ -3734 +3734 @@
  * @since 4.0.0
  *
- * @global WP_Post    $post       Global post object.
- * @global WP_Embed   $wp_embed   Embed API instance.
+ * @global WP_Post    $post          Global post object.
+ * @global WP_Embed   $wp_embed      WordPress Embed object.
  * @global WP_Scripts $wp_scripts
  * @global int        $content_width

trunk/src/wp-includes/block-template.php

@@ -211 +211 @@
  * @global string   $_wp_current_template_id
  * @global string   $_wp_current_template_content
- * @global WP_Embed $wp_embed
- * @global WP_Query $wp_query
+ * @global WP_Embed $wp_embed                     WordPress Embed object.
+ * @global WP_Query $wp_query                     WordPress Query object.
  *
  * @return string Block template markup.

trunk/src/wp-includes/class-wp-oembed-controller.php

@@ -161 +161 @@
      *
      * @see WP_oEmbed::get_html()
-     * @global WP_Embed   $wp_embed
+     * @global WP_Embed   $wp_embed   WordPress Embed object.
      * @global WP_Scripts $wp_scripts
      *

trunk/src/wp-includes/embed.php

@@ -15 +15 @@
  * @since 2.9.0
  *
- * @global WP_Embed $wp_embed
+ * @global WP_Embed $wp_embed WordPress Embed object.
  *
  * @param string   $id       An internal ID/name for the handler. Needs to be unique.
@@ -33 +33 @@
  * @since 2.9.0
  *
- * @global WP_Embed $wp_embed
+ * @global WP_Embed $wp_embed WordPress Embed object.
  *
  * @param string $id       The handler ID that should be removed.
@@ -231 +231 @@
  * @since 4.0.0
  *
- * @global WP_Embed $wp_embed
+ * @global WP_Embed $wp_embed WordPress Embed object.
  *
  * @param array  $matches The RegEx matches from the provided regex when calling