media_upload_type_url_form()

💡 云策文档标注

概述

media_upload_type_url_form() 函数用于输出旧版外部媒体上传表单，支持自定义媒体类型和错误处理。它生成一个表单，允许用户通过URL插入媒体，并包含相关的过滤器和钩子。

关键要点

函数输出旧版外部媒体上传表单，默认媒体类型为 'image'。
接受三个可选参数：$type（媒体类型）、$errors（错误对象）和$id（ID）。
使用 media_upload_header() 输出表单头部，并生成包含 nonce 字段的表单。
包含多个过滤器，如 'media_upload_form_url' 用于修改表单动作URL，'type_url_form_media' 用于过滤表单HTML。
相关函数包括 wp_media_insert_url_form()、admin_url() 和 get_user_setting() 等。

代码示例

media_upload_type_url_form( 'video', null, 123 );

注意事项

此函数自 WordPress 2.7.0 版本引入，属于旧版媒体上传系统。
表单动作URL可通过 'media_upload_form_url' 过滤器自定义。
使用 esc_url() 确保URL安全，避免XSS攻击。

📄 原文内容

Outputs the legacy media upload form for external media.

Parameters

$typestringoptional: Default:null
$errorsobjectoptional: Default:null
$idintoptional: Default:null

Source

function media_upload_type_url_form( $type = null, $errors = null, $id = null ) {

	if ( null === $type ) {

		$type = 'image';

	}
	media_upload_header();
	$post_id = isset( $_REQUEST['post_id'] ) ? (int) $_REQUEST['post_id'] : 0;
	$form_action_url = admin_url( "media-upload.php?type=$type&tab;=type&post;_id=$post_id" );

	/** This filter is documented in wp-admin/includes/media.php */

	$form_action_url = apply_filters( 'media_upload_form_url', $form_action_url, $type );

	$form_class      = 'media-upload-form type-form validate';
	if ( get_user_setting( 'uploader' ) ) {

		$form_class .= ' html-uploader';

	}
	?>

	<form enctype="multipart/form-data" method="post" action="<?php echo esc_url( $form_action_url ); ?>" class="<?php echo $form_class; ?>" id="<?php echo $type; ?>-form">

	<input type="hidden" name="post_id" id="post_id" value="<?php echo (int) $post_id; ?>" />
	<h3 class="media-title"></h3>
	<script type="text/javascript">

	var addExtImage = {
	width : '',

	height : '',

	align : 'alignnone',
	insert : function() {

		var t = this, html, f = document.forms[0], cls, title = '', alt = '', caption = '';
		if ( '' === f.src.value || '' === t.width )

			return false;
		if ( f.alt.value )

			alt = f.alt.value.replace(/'/g, ''').replace(/"/g, '"').replace(/</g, '<').replace(/>/g, '>');
		<?php

		/** This filter is documented in wp-admin/includes/media.php */

		if ( ! apply_filters( 'disable_captions', '' ) ) {

			?>

			if ( f.caption.value ) {

				caption = f.caption.value.replace(/rn|r/g, 'n');

				caption = caption.replace(/<[a-zA-Z0-9]+( [^<>]+)?>/g, function(a){

					return a.replace(/[rnt]+/, ' ');

				});
				caption = caption.replace(/s*ns*/g, '<br />');

			}

			<?php

		}
		?>

		cls = caption ? '' : ' class="'+t.align+'"';
		html = '<img alt="'+alt+'" src="'+f.src.value+'"'+cls+' width="'+t.width+'" height="'+t.height+'" />';
		if ( f.url.value ) {

			url = f.url.value.replace(/'/g, ''').replace(/"/g, '"').replace(/</g, '<').replace(/>/g, '>');

			html = '<a href="'+url+'">'+html+'</a>';

		}
		if ( caption )

			html = ''+html+caption+'';
		var win = window.dialogArguments || opener || parent || top;

		win.send_to_editor(html);

		return false;

	},
	resetImageData : function() {

		var t = addExtImage;
		t.width = t.height = '';

		document.getElementById('go_button').style.color = '#bbb';

		if ( ! document.forms[0].src.value )

			document.getElementById('status_img').innerHTML = '';

		else document.getElementById('status_img').innerHTML = '<img src="<?php echo esc_url( admin_url( 'images/no.png' ) ); ?>" alt="" />';

	},
	updateImageData : function() {

		var t = addExtImage;
		t.width = t.preloadImg.width;

		t.height = t.preloadImg.height;

		document.getElementById('go_button').style.color = '#333';

		document.getElementById('status_img').innerHTML = '<img src="<?php echo esc_url( admin_url( 'images/yes.png' ) ); ?>" alt="" />';

	},
	getImageData : function() {

		if ( jQuery('table.describe').hasClass('not-image') )

			return;
		var t = addExtImage, src = document.forms[0].src.value;
		if ( ! src ) {

			t.resetImageData();

			return false;

		}
		document.getElementById('status_img').innerHTML = '<img src="<?php echo esc_url( admin_url( 'images/spinner-2x.gif' ) ); ?>" alt="" width="16" height="16" />';

		t.preloadImg = new Image();

		t.preloadImg.onload = t.updateImageData;

		t.preloadImg.onerror = t.resetImageData;

		t.preloadImg.src = src;

	}

	};
	jQuery( function($) {

		$('.media-types input').click( function() {

			$('table.describe').toggleClass('not-image', $('#not-image').prop('checked') );

		});

	} );

	</script>
	<div id="media-items">

	<div class="media-item media-blank">
	</div>

	</div>

	</form>

	</pre><p class="wporg-dot-link-list"><a href="https://developer.wordpress.org/reference/files/wp-admin/includes/media.php/">View all references</a> <a href="https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-admin/includes/media.php#L2405">View on Trac</a> <a href="https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-admin/includes/media.php#L2405-L2541">View on GitHub</a></p></section>

		<section class="wp-block-wporg-code-reference-hooks"><h2 id="hooks" class="is-toc-heading wp-block-heading has-heading-5-font-size" tabindex="-1" ><a href="#hooks">Hooks</a></h2> <dl><dt class="wp-block-wporg-code-reference-title has-normal-font-size"><a href="https://developer.wordpress.org/reference/hooks/disable_captions/"><span class="hook-func">apply_filters</span>( ‘disable_captions’,  <nobr><span class="arg-type">bool</span> <span class="arg-name">$bool</span></nobr> )</a></dt><dd><p>Filters whether to disable captions.</p>

</dd><dt class="wp-block-wporg-code-reference-title has-normal-font-size"><a href="https://developer.wordpress.org/reference/hooks/media_upload_form_url/"><span class="hook-func">apply_filters</span>( ‘media_upload_form_url’,  <nobr><span class="arg-type">string</span> <span class="arg-name">$form_action_url</span></nobr>,  <nobr><span class="arg-type">string</span> <span class="arg-name">$type</span></nobr> )</a></dt><dd><p>Filters the media upload form action URL.</p>

</dd><dt class="wp-block-wporg-code-reference-title has-normal-font-size"><a href="https://developer.wordpress.org/reference/hooks/type_url_form_media/"><span class="hook-func">apply_filters</span>( ‘type_url_form_media’,  <nobr><span class="arg-type">string</span> <span class="arg-name">$form_html</span></nobr> )</a></dt><dd><p>Filters the insert media from URL form HTML.</p>

</dd></dl></section>

		<section class="wp-block-wporg-code-reference-related" data-nosnippet="true"><h2 id="related" class="is-toc-heading wp-block-heading has-heading-5-font-size" tabindex="-1" ><a href="#related">Related</a></h2> <section style="margin-top:var(--wp--preset--spacing--20)" class="wp-block-wporg-code-table" id="uses"><figure class="wp-block-table "><table><thead><tr><th scope="col">Uses</th><th scope="col">Description</th></tr></thead><tbody><tr class=""><td><a href="https://developer.wordpress.org/reference/functions/wp_media_insert_url_form/">wp_media_insert_url_form()</a><code>wp-admin/includes/media.php

Creates the form for external url.



media_upload_header()wp-admin/includes/media.php

Outputs the legacy media upload header.



wp_nonce_field()wp-includes/functions.php

Retrieves or display nonce hidden field for forms.



get_user_setting()wp-includes/option.php

Retrieves user interface setting value based on setting name.



_e()wp-includes/l10n.php

Displays translated text.



esc_url()wp-includes/formatting.php

Checks and cleans a URL.



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.





Show 4 moreShow less

Changelog

Version	Description
2.7.0	Introduced.

云策 WordPress 开发者社区

函数文档

media_upload_type_url_form()

概述

关键要点

代码示例

注意事项

Parameters

Source

Changelog