wp_allowed_protocols() WordPress Function

The wp_allowed_protocols() function is used to specify which protocols are allowed in WordPress. This is useful for restricting access to certain parts of the site or for security purposes. The function takes an array of protocols as its argument and returns an array of allowed protocols.

wp_allowed_protocols() #

Retrieve a list of protocols to allow in HTML attributes.


Description

Top ↑

See also


Top ↑

Return

(string[]) Array of allowed protocols. Defaults to an array containing 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'irc6', 'ircs', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'sms', 'svn', 'tel', 'fax', 'xmpp', 'webcal', and 'urn'. This covers all common link protocols, except for 'javascript' which should not be allowed for untrusted users.


Top ↑

Source

File: wp-includes/functions.php

function wp_allowed_protocols() {
	static $protocols = array();

	if ( empty( $protocols ) ) {
		$protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'irc6', 'ircs', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'sms', 'svn', 'tel', 'fax', 'xmpp', 'webcal', 'urn' );
	}

	if ( ! did_action( 'wp_loaded' ) ) {
		/**
		 * Filters the list of protocols allowed in HTML attributes.
		 *
		 * @since 3.0.0
		 *
		 * @param string[] $protocols Array of allowed protocols e.g. 'http', 'ftp', 'tel', and more.
		 */
		$protocols = array_unique( (array) apply_filters( 'kses_allowed_protocols', $protocols ) );
	}

	return $protocols;
}


Top ↑

Changelog

Changelog
VersionDescription
5.6.0Added 'irc6' and 'ircs' to the protocols array.
5.3.0Added 'sms' to the protocols array.
4.7.0Added 'urn' to the protocols array.
4.3.0Added 'webcal' to the protocols array.
3.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More