On this page
get_upload_iframe_src( string $type = null, int $post_id = null, string $tab = null ): string
Retrieves the upload iframe source URL.
Parameters
$typestring Optional-
Media type.
Default:
null $post_idint Optional-
Post ID.
Default:
null $tabstring Optional-
Media upload tab.
Default:
null
Return
string Upload iframe source URL.
Source
File: wp-admin/includes/media.php. View all references
function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) {
global $post_ID;
if ( empty( $post_id ) ) {
$post_id = $post_ID;
}
$upload_iframe_src = add_query_arg( 'post_id', (int) $post_id, admin_url( 'media-upload.php' ) );
if ( $type && 'media' !== $type ) {
$upload_iframe_src = add_query_arg( 'type', $type, $upload_iframe_src );
}
if ( ! empty( $tab ) ) {
$upload_iframe_src = add_query_arg( 'tab', $tab, $upload_iframe_src );
}
/**
* Filters the upload iframe source URL for a specific media type.
*
* The dynamic portion of the hook name, `$type`, refers to the type
* 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.
*/
$upload_iframe_src = apply_filters( "{$type}_upload_iframe_src", $upload_iframe_src );
return add_query_arg( 'TB_iframe', true, $upload_iframe_src );
}
Hooks
- apply_filters( "{$type}_upload_iframe_src",
string $upload_iframe_src ) -
Filters the upload iframe source URL for a specific media type.
Related
Uses
| Uses | Description |
|---|---|
| add_query_arg() wp-includes/functions.php | Retrieves a modified URL query string. |
| admin_url() wp-includes/link-template.php | Retrieves the URL to the admin area for the current site. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
Used By
| Used By | Description |
|---|---|
| _wp_post_thumbnail_html() wp-admin/includes/post.php | Returns HTML for the post thumbnail meta box. |
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_upload_iframe_src