Changeset 50505 for trunk/src/wp-admin/includes/media.php

Timestamp:

03/07/2021 12:30:38 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628

File:

• trunk/src/wp-admin/includes/media.php (modified) (2 diffs)

trunk/src/wp-admin/includes/media.php

@@ -697 +697 @@
      * of media uploaded.
      *
+     * Possible hook names include:
+     *
+     *  - `image_upload_iframe_src`
+     *  - `media_upload_iframe_src`
+     *
      * @since 3.0.0
      *
-     * @param string $upload_iframe_src The upload iframe source URL by type.
+     * @param string $upload_iframe_src The upload iframe source URL.
      */
     $upload_iframe_src = apply_filters( "{$type}_upload_iframe_src", $upload_iframe_src );
@@ -893 +898 @@
              * The dynamic portion of the hook name, `$type`, refers to the type
              * of media being sent.
+             *
+             * Possible hook names include:
+             *
+             *  - `audio_send_to_editor_url`
+             *  - `file_send_to_editor_url`
+             *  - `video_send_to_editor_url`
              *
              * @since 3.3.0