get_upload_iframe_src( string $type = null, int $post_id = null, string $tab = null ): string
Retrieves the upload iframe source URL.
Parameters
-
$type
string Optional -
Media type.
Default:
null
-
$post_id
int Optional -
Post ID.
Default:
null
-
$tab
string 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.
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |