WordPress.org
Get WordPress

Make WordPress Core

Ticket #5638: 5638.r8781.diff

File 5638.r8781.diff, 21.7 KB (added by jacobsantos, 17 years ago)

Just inline documentation and code styling based from r8781

  • formatting.php

     
    1010/**
    1111 * Replaces common plain text characters into formatted entities
    1212 *
    13  * As an example, 
     13 * As an example,
    1414 * <code>
    1515 * 'cause today's effort makes it worth tomorrow's "holiday"...
    1616 * </code>
    … …  
    5151        $dynamic_replacements = array('&#8217;$1','$1&#8216;', '$1&#8243;', '$1&#8242;', '$1&#8217;$2', '$1&#8220;$2', '&#8221;$1', '&#8217;$1', '$1&#215;$2');
    5252
    5353        for ( $i = 0; $i < $stop; $i++ ) {
    54                 $curl = $textarr[$i];
     54                $curl = $textarr[$i];
    5555
    5656                if ( !empty($curl) && '<' != $curl{0} && '[' != $curl{0} && $next && !$has_pre_parent) { // If it's not a tag
    5757                        // static strings
    … …  
    7272                $output .= $curl;
    7373        }
    7474
    75         return $output;
     75        return $output;
    7676}
    7777
    7878/**
    … …  
    105105 * A group of regex replaces used to identify text formatted with newlines and
    106106 * replace double line-breaks with HTML paragraph tags. The remaining
    107107 * line-breaks after conversion become <<br />> tags, unless $br is set to '0'
    108  *  or 'false'.
     108 * or 'false'.
    109109 *
    110110 * @since 0.71
    111111 *
    … …  
    154154/**
    155155 * Checks to see if a string is utf8 encoded.
    156156 *
    157  * {@internal Missing Long Description}}
    158  *
    159157 * @since 1.2.1
    160158 *
    161159 * @param string $Str The string to be checked
    … …  
    183181 * Converts a number of special characters into their HTML entities.
    184182 *
    185183 * Differs from htmlspecialchars as existing HTML entities will not be encoded.
    186  * Specificically changes: & to &#038;, < to &lt; and > to &gt;.
     184 * Specifically changes: & to &#038;, < to &lt; and > to &gt;.
    187185 *
    188186 * $quotes can be set to 'single' to encode ' to &#039;, 'double' to encode " to
    189187 * &quot;, or '1' to do both. Default is 0 where no quotes are encoded.
    … …  
    267265/**
    268266 * Replaces accents in a string.
    269267 *
    270  * {@internal Missing Long Description}}
    271  *
    272268 * @since 1.2.1
    273269 *
    274270 * @param string $string The text to be filtered.
    … …  
    423419        $name = preg_replace('|-+|', '-', $name);
    424420        $name = trim($name, '-');
    425421        return $name;
    426        
    427422}
    428423
    429424/**
    430  * Removes characters from the username.
     425 * Sanitize username stripping out unsafe characters.
    431426 *
    432427 * If $strict is true, only alphanumeric characters (as well as _, space, ., -,
    433428 * @) are returned.
    … …  
    456451}
    457452
    458453/**
    459  * Returns a string which has been sanitized.
     454 * Sanitizes title or use fallback title.
    460455 *
    461456 * Specifically, HTML and PHP tags are stripped. Further actions can be added
    462457 * via the plugin API. If $title is empty and $fallback_title is set, the latter
    … …  
    479474}
    480475
    481476/**
    482  * Replaces the string with safe characters. Whitespace becomes a dash.
     477 * Sanitizes title, replacing whitespace with dashes.
    483478 *
    484479 * Limits the output to alphanumeric characters, underscore (_) and dash (-).
     480 * Whitespace becomes a dash.
    485481 *
    486482 * @since 1.2.0
    487483 *
    … …  
    603599/**
    604600 * Fixes javascript bugs in browsers.
    605601 *
    606  * {@internal Missing Long Description}}
     602 * Converts unicode characters to HTML numbered entities.
    607603 *
    608604 * @since 1.5.0
    609605 * @uses $is_macIE
    … …  
    616612        // Fixes for browsers' javascript bugs
    617613        global $is_macIE, $is_winIE;
    618614
     615        /** @todo use preg_replace_callback() instead */
    619616        if ( $is_winIE || $is_macIE )
    620617                $text =  preg_replace("/\%u([0-9A-F]{4,4})/e",  "'&#'.base_convert('\\1',16,10).';'", $text);
    621618
    … …  
    623620}
    624621
    625622/**
    626  * balanceTags() - {@internal Missing Short Description}}
     623 * Will only balance the tags if forced to and the option is set to balance tags.
    627624 *
    628  * {@internal Missing Long Description}}
     625 * The option 'use_balanceTags' is used for whether the tags will be balanced.
     626 * Both the $force parameter and 'use_balanceTags' option will have to be true
     627 * before the tags will be balanced.
    629628 *
    630629 * @since 0.71
    631630 *
    … …  
    642641/**
    643642 * Balances tags of string using a modified stack.
    644643 *
    645  * {@internal Missing Long Description}}
    646  *
    647644 * @since 2.0.4
    648645 *
    649646 * @author Leonard Lin <leonard@acm.org>
    650647 * @license GPL v2.0
    651  * @date November 4, 2001
     648 * @copyright November 4, 2001
    652649 * @version 1.1
    653650 * @todo Make better - change loop condition to $text in 1.2
    654651 * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
    … …  
    781778/**
    782779 * Holder for the 'format_to_post' filter.
    783780 *
    784  * {@internal Deprecated? Unused in 2.6}}
    785  *
    786781 * @since 0.71
    787782 *
    788783 * @param string $content The text to pass through the filter.
    … …  
    796791/**
    797792 * Add leading zeros when necessary.
    798793 *
    799  * {@internal Missing Long Description}}
     794 * If you set the threshold to '4' and the number is '10', then you will get
     795 * back '0010'. If you set the number to '4' and the number is '5000', then you
     796 * will get back '5000'.
    800797 *
    801798 * @since 0.71
    802799 *
    … …  
    804801 * @param int $threshold Amount of digits
    805802 * @return string Adds leading zeros to number if needed
    806803 */
    807 function zeroise($number,$threshold) {
     804function zeroise($number, $threshold) {
    808805        return sprintf('%0'.$threshold.'s', $number);
    809806}
    810807
    811808/**
    812809 * Adds backslashes before letters and before a number at the start of a string.
    813810 *
    814  * {@internal Missing Long Description}}
    815  *
    816811 * @since 0.71
    817812 *
    818813 * @param string $string Value to which backslashes will be added.
    … …  
    861856/**
    862857 * Adds slashes to escape strings.
    863858 *
    864  * Slashes will first be removed if magic_quotes_gpc is set,
    865  * see {@link http://www.php.net/magic_quotes} for more details.
     859 * Slashes will first be removed if magic_quotes_gpc is set, see {@link
     860 * http://www.php.net/magic_quotes} for more details.
    866861 *
    867862 * @since 0.71
    868863 *
    … …  
    882877/**
    883878 * Navigates through an array and removes slashes from the values.
    884879 *
    885  * If an array is passed, the array_map() function causes a callback to
    886  * pass the value back to the function. The slashes from this value will
    887  * removed.
     880 * If an array is passed, the array_map() function causes a callback to pass the
     881 * value back to the function. The slashes from this value will removed.
    888882 *
    889883 * @since 2.0.0
    890884 *
    … …  
    892886 * @return array|string Stripped array (or string in the callback).
    893887 */
    894888function stripslashes_deep($value) {
    895          $value = is_array($value) ?
    896                  array_map('stripslashes_deep', $value) :
    897                  stripslashes($value);
    898 
    899          return $value;
     889        $value = is_array($value) ? array_map('stripslashes_deep', $value) : stripslashes($value);
     890        return $value;
    900891}
    901892
    902893/**
    … …  
    911902 * @return array|string $value The encoded array (or string from the callback).
    912903 */
    913904function urlencode_deep($value) {
    914          $value = is_array($value) ?
    915                  array_map('urlencode_deep', $value) :
    916                  urlencode($value);
    917 
    918          return $value;
     905        $value = is_array($value) ? array_map('urlencode_deep', $value) : urlencode($value);
     906        return $value;
    919907}
    920908
    921909/**
    … …  
    947935}
    948936
    949937/**
    950  * _make_url_clickable_cb() - {@internal Missing Short Description}}
     938 * Callback to convert URI match to HTML A element.
    951939 *
    952  * {@internal Missing Long Description}}
     940 * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
     941 * make_clickable()}.
    953942 *
    954  * @since 2.5.0
     943 * @since 2.3.2
    955944 * @access private
    956945 *
    957  * @param unknown_type $matches
    958  * @return unknown
     946 * @param array $matches Single Regex Match.
     947 * @return string HTML A element with URI address.
    959948 */
    960949function _make_url_clickable_cb($matches) {
    961950        $ret = '';
    … …  
    972961}
    973962
    974963/**
    975  * _make_web_ftp_clickable_cb() - {@internal Missing Short Description}}
     964 * Callback to convert URL match to HTML A element.
    976965 *
    977  * {@internal Missing Long Description}}
     966 * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
     967 * make_clickable()}.
    978968 *
    979  * @since 2.5.0
     969 * @since 2.3.2
    980970 * @access private
    981971 *
    982  * @param unknown_type $matches
    983  * @return unknown
     972 * @param array $matches Single Regex Match.
     973 * @return string HTML A element with URL address.
    984974 */
    985975function _make_web_ftp_clickable_cb($matches) {
    986976        $ret = '';
    … …  
    998988}
    999989
    1000990/**
    1001  * _make_email_clickable_cb() - {@internal Missing Short Description}}
     991 * Callback to convert email address match to HTML A element.
    1002992 *
    1003  * {@internal Missing Long Description}}
     993 * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
     994 * make_clickable()}.
    1004995 *
    1005  * @since 2.5.0
     996 * @since 2.3.2
    1006997 * @access private
    1007998 *
    1008  * @param unknown_type $matches
    1009  * @return unknown
     999 * @param array $matches Single Regex Match.
     1000 * @return string HTML A element with email address.
    10101001 */
    10111002function _make_email_clickable_cb($matches) {
    10121003        $email = $matches[2] . '@' . $matches[3];
    … …  
    10141005}
    10151006
    10161007/**
    1017  * make_clickable() - {@internal Missing Short Description}}
     1008 * Convert plaintext URI to HTML links.
    10181009 *
    1019  * {@internal Missing Long Description}}
     1010 * Converts URI, www and ftp, and email addresses. Finishes by fixing links
     1011 * within links.
    10201012 *
    10211013 * @since 0.71
    10221014 *
    1023  * @param unknown_type $ret
    1024  * @return unknown
     1015 * @param string $ret Content to convert URIs.
     1016 * @return string Content with converted URIs.
    10251017 */
    10261018function make_clickable($ret) {
    10271019        $ret = ' ' . $ret;
    … …  
    10771069 *
    10781070 * @since 0.71
    10791071 *
    1080  * @param unknown_type $text
    1081  * @return unknown
     1072 * @param string $text
     1073 * @return string
    10821074 */
    10831075function convert_smilies($text) {
    10841076        global $wp_smiliessearch, $wp_smiliesreplace;
    … …  
    11041096/**
    11051097 * Checks to see if the text is a valid email address.
    11061098 *
    1107  * {@internal Missing Long Description}}
    1108  *
    11091099 * @since 0.71
    11101100 *
    11111101 * @param string $user_email The email address to be checked.
    … …  
    11251115}
    11261116
    11271117/**
    1128  * wp_iso_descrambler() - {@internal Missing Short Description}}
     1118 * {@internal Missing Short Description}}
    11291119 *
    11301120 * {@internal Missing Long Description}}
    11311121 *
    11321122 * @since 1.2.0
    11331123 * @usedby wp_mail() handles charsets in email subjects
    11341124 *
    1135  * @param unknown_type $string
    1136  * @return unknown
     1125 * @param string $string
     1126 * @return string
    11371127 */
    11381128function wp_iso_descrambler($string) {
    11391129        /* this may only work with iso-8859-1, I'm afraid */
    … …  
    11411131                return $string;
    11421132        } else {
    11431133                $subject = str_replace('_', ' ', $matches[2]);
     1134                /** @todo use preg_replace_callback() */
    11441135                $subject = preg_replace('#\=([0-9a-f]{2})#ei', "chr(hexdec(strtolower('$1')))", $subject);
    11451136                return $subject;
    11461137        }
    … …  
    11491140/**
    11501141 * Returns a date in the GMT equivalent.
    11511142 *
    1152  * Requires and returns a date in the Y-m-d H:i:s format.
    1153  * Simply subtracts the value of gmt_offset.
     1143 * Requires and returns a date in the Y-m-d H:i:s format. Simply subtracts the
     1144 * value of gmt_offset.
    11541145 *
    11551146 * @since 1.2.0
    11561147 *
    … …  
    11671158/**
    11681159 * Converts a GMT date into the correct format for the blog.
    11691160 *
    1170  * Requires and returns in the Y-m-d H:i:s format. Simply
    1171  * adds the value of gmt_offset.
     1161 * Requires and returns in the Y-m-d H:i:s format. Simply adds the value of
     1162 * gmt_offset.
    11721163 *
    11731164 * @since 1.2.0
    11741165 *
    … …  
    11851176/**
    11861177 * Computes an offset in seconds from an iso8601 timezone.
    11871178 *
    1188  * {@internal Missing Long Description}}
    1189  *
    11901179 * @since 1.5.0
    11911180 *
    11921181 * @param string $timezone Either 'Z' for 0 offset or '±hhmm'.
    … …  
    12081197/**
    12091198 * Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].
    12101199 *
    1211  * {@internal Missing Long Description}}
    1212  *
    12131200 * @since 1.5.0
    12141201 *
    12151202 * @param string $date_string Date and time in ISO 8601 format {@link http://en.wikipedia.org/wiki/ISO_8601}.
    1216  * @param unknown_type $timezone Optional. If set to GMT returns the time minus gmt_offset. Default USER.
     1203 * @param string $timezone Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'.
    12171204 * @return string The date and time in MySQL DateTime format - Y-m-d H:i:s.
    12181205 */
    12191206function iso8601_to_datetime($date_string, $timezone = USER) {
    12201207        if ($timezone == GMT) {
    12211208
     1209        if ($timezone == 'gmt') {
     1210
    12221211                preg_match('#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', $date_string, $date_bits);
    12231212
    12241213                if (!empty($date_bits[7])) { // we have a timezone, so let's compute an offset
    … …  
    12691258/**
    12701259 * Determines the difference between two timestamps.
    12711260 *
    1272  * The difference is returned in a human readable format such as
    1273  * "1 hour", "5 mins", "2 days".
     1261 * The difference is returned in a human readable format such as "1 hour",
     1262 * "5 mins", "2 days".
    12741263 *
    12751264 * @since 1.5.0
    12761265 *
    … …  
    13051294}
    13061295
    13071296/**
    1308  * Generates an excerpt from the content if needed.
     1297 * Generates an excerpt from the content, if needed.
    13091298 *
    1310  * {@internal Missing Long Description}}
     1299 * The excerpt word amount will be 55 words and if the amount is greater than
     1300 * that, then the string '[...]' will be appended to the excerpt. If the string
     1301 * is less than 55 words, then the content will be returned as is.
    13111302 *
    13121303 * @since 1.5.0
    13131304 *
    13141305 * @param string $text The exerpt. If set to empty an excerpt is generated.
    13151306 * @return string The excerpt.
    13161307 */
    1317 function wp_trim_excerpt($text) { // Fakes an excerpt if needed
     1308function wp_trim_excerpt($text) {
    13181309        if ( '' == $text ) {
    13191310                $text = get_the_content('');
    13201311
    … …  
    13371328/**
    13381329 * Converts named entities into numbered entities.
    13391330 *
    1340  * {@internal Missing Long Description}}
    1341  *
    13421331 * @since 1.5.1
    13431332 *
    13441333 * @param string $text The text within which entities will be converted.
    1345  * @return string Text with converted entities. 
     1334 * @return string Text with converted entities.
    13461335 */
    13471336function ent2ncr($text) {
    13481337        $to_ncr = array(
    … …  
    16091598}
    16101599
    16111600/**
    1612  * Formats text for the rich text editor and applies filter.
     1601 * Formats text for the rich text editor.
    16131602 *
    1614  * The filter 'richedit_pre' is applied here. If $text is empty
    1615  * the filter will be applied to an empty string.
     1603 * The filter 'richedit_pre' is applied here. If $text is empty the filter will
     1604 * be applied to an empty string.
    16161605 *
    16171606 * @since 2.0.0
    16181607 *
    … …  
    16311620}
    16321621
    16331622/**
    1634  * Formats text for the HTML editor and applies a filter.
     1623 * Formats text for the HTML editor.
    16351624 *
    1636  * Unless $output is empty it will pass through htmlspecialchars
    1637  * before the 'htmledit_pre' filter is applied.
     1625 * Unless $output is empty it will pass through htmlspecialchars before the
     1626 * 'htmledit_pre' filter is applied.
    16381627 *
    1639  * @since unknown
     1628 * @since 2.5.0
    16401629 *
    16411630 * @param string $output The text to be formatted.
    16421631 * @return string Formatted text after filter applied.
    … …  
    16491638}
    16501639
    16511640/**
    1652  * Checks and cleans a URL. 
     1641 * Checks and cleans a URL.
    16531642 *
    1654  * A number of characters are removed from the URL. If the URL is
    1655  * for displaying (the default behaviour) amperstands are also replaced.
    1656  * The 'clean_url' filter is applied to the returned cleaned URL.
     1643 * A number of characters are removed from the URL. If the URL is for displaying
     1644 * (the default behaviour) amperstands are also replaced. The 'clean_url' filter
     1645 * is applied to the returned cleaned URL.
    16571646 *
    16581647 * @since 1.2.0
    16591648 * @uses wp_kses_bad_protocol() To only permit protocols in the URL set
    1660  *      via $protocols or the common ones set in the function.
     1649 *              via $protocols or the common ones set in the function.
    16611650 *
    16621651 * @param string $url The URL to be cleaned.
    1663  * @param array $protocols Optional. An array of acceptable protocols. 
    1664  *              Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.
    1665  * @param string $context Optional. How the URL will be used. Default is 'display'. 
     1652 * @param array $protocols Optional. An array of acceptable protocols.
     1653 *              Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.
     1654 * @param string $context Optional. How the URL will be used. Default is 'display'.
    16661655 * @return string The cleaned $url after the 'cleaned_url' filter is applied.
    16671656 */
    16681657function clean_url( $url, $protocols = null, $context = 'display' ) {
    … …  
    17111700/**
    17121701 * Convert entities, while preserving already-encoded entities.
    17131702 *
    1714  * {@internal Missing Long Description}}
    1715  *
    17161703 * @link http://www.php.net/htmlentities Borrowed from the PHP Manual user notes.
    17171704 *
    17181705 * @since 1.2.2
    … …  
    17461733/**
    17471734 * Escaping for HTML attributes.
    17481735 *
    1749  * @since unknown
     1736 * @since 2.0.6
    17501737 *
    17511738 * @param string $text
    17521739 * @return string
    … …  
    17591746/**
    17601747 * Escape a HTML tag name.
    17611748 *
    1762  * @since unknown
     1749 * @since 2.5.0
    17631750 *
    17641751 * @param string $tag_name
    17651752 * @return string
    … …  
    17721759/**
    17731760 * Escapes text for SQL LIKE special characters % and _.
    17741761 *
    1775  * @since unknown
     1762 * @since 2.5.0
    17761763 *
    17771764 * @param string $text The text to be escaped.
    17781765 * @return string text, safe for inclusion in LIKE query.
    … …  
    17821769}
    17831770
    17841771/**
    1785  * {@internal Missing Short Description}}
     1772 * Convert full URL paths to absolute paths.
    17861773 *
    1787  * @since unknown
     1774 * Removes the http or https protocols and the domain. Keeps the path '/' at the
     1775 * beginning, so it isn't a true relative link, but from the web root base.
    17881776 *
    1789  * @param string $link
    1790  * @return string
     1777 * @since 2.1.0
     1778 *
     1779 * @param string $link Full URL path.
     1780 * @return string Absolute path.
    17911781 */
    17921782function wp_make_link_relative( $link ) {
    1793         return preg_replace('|https?://[^/]+(/.*)|i', '$1', $link );
     1783        return preg_replace( '|https?://[^/]+(/.*)|i', '$1', $link );
    17941784}
    17951785
    17961786/**
    17971787 * Sanitises various option values based on the nature of the option.
    17981788 *
    1799  * This is basically a switch statement which will pass $value through
    1800  * a number of functions depending on the $option.
     1789 * This is basically a switch statement which will pass $value through a number
     1790 * of functions depending on the $option.
    18011791 *
    18021792 * @since 2.0.5
    18031793 *
    … …  
    18051795 * @param string $value The unsanitised value.
    18061796 * @return string Sanitized value.
    18071797 */
    1808 function sanitize_option($option, $value) { // Remember to call stripslashes!
     1798function sanitize_option($option, $value) {
    18091799
    18101800        switch ($option) {
    18111801                case 'admin_email':
    … …  
    18821872/**
    18831873 * Parses a string into variables to be stored in an array.
    18841874 *
    1885  * Uses {@link http://www.php.net/parse_str parse_str()} and stripslashes
    1886  * if {@link http://www.php.net/magic_quotes magic_quotes_gpc} is on.
     1875 * Uses {@link http://www.php.net/parse_str parse_str()} and stripslashes if
     1876 * {@link http://www.php.net/magic_quotes magic_quotes_gpc} is on.
    18871877 *
    18881878 * @since 2.2.1
    18891879 * @uses apply_filters() for the 'wp_parse_str' filter.
    … …  
    19011891/**
    19021892 * Convert lone less than signs.
    19031893 *
    1904  * KSES already converts lone greater than signs. 
     1894 * KSES already converts lone greater than signs.
    19051895 *
    19061896 * @uses wp_pre_kses_less_than_callback in the callback function.
    1907  * @since unknown
     1897 * @since 2.3.0
    19081898 *
    19091899 * @param string $text Text to be converted.
    19101900 * @return string Converted text.
    … …  
    19161906/**
    19171907 * Callback function used by preg_replace.
    19181908 *
    1919  * @since unknown
    19201909 * @uses wp_specialchars to format the $matches text.
     1910 * @since 2.3.0
    19211911 *
    19221912 * @param array $matches Populated by matches to preg_replace.
    19231913 * @return string The text returned after wp_specialchars if needed.
    … …  
    19311921/**
    19321922 * WordPress implementation of PHP sprintf() with filters.
    19331923 *
    1934  * @since unknown
     1924 * @since 2.5.0
    19351925 * @link http://www.php.net/sprintf
    19361926 *
    19371927 * @param string $pattern The string which formatted args are inserted.
    … …  
    19911981}
    19921982
    19931983/**
    1994  * List specifier %l for wp_sprintf.
     1984 * Localize list items before the rest of the content.
    19951985 *
    1996  * @since unknown
     1986 * The '%l' must be at the first characters can then contain the rest of the
     1987 * content. The list items will have ', ', ', and', and ' and ' added depending
     1988 * on the amount of list items in the $args parameter.
    19971989 *
    1998  * @param unknown_type $pattern
    1999  * @param unknown_type $args
    2000  * @return unknown
     1990 * @since 2.5.0
     1991 *
     1992 * @param string $pattern Content containing '%l' at the beginning.
     1993 * @param array $args List items to prepend to the content and replace '%l'.
     1994 * @return string Localized list items and rest of the content.
    20011995 */
    20021996function wp_sprintf_l($pattern, $args) {
    20031997        // Not a match
    … …  
    20372031 * be counted as one character. For example &amp; will be counted as 4, &lt; as
    20382032 * 3, etc.
    20392033 *
     2034 * @since 2.5.0
     2035 *
    20402036 * @param integer $str String to get the excerpt from.
    20412037 * @param integer $count Maximum number of characters to take.
    20422038 * @return string The excerpt.
    … …  
    20522048/**
    20532049 * Add a Base url to relative links in passed content.
    20542050 *
    2055  * By default it supports the 'src' and 'href' attributes,
    2056  * However this may be changed via the 3rd param.
     2051 * By default it supports the 'src' and 'href' attributes. However this can be
     2052 * changed via the 3rd param.
    20572053 *
    2058  * @package WordPress
    2059  * @since 2.7
     2054 * @since 2.7.0
    20602055 *
    20612056 * @param string $content String to search for links in.
    20622057 * @param string $base The base URL to prefix to links.
    … …  
    20732068/**
    20742069 * Callback to add a base url to relative links in passed content.
    20752070 *
     2071 * @since 2.7.0
     2072 * @access private
    20762073 *
    2077  * @package WordPress
    2078  * @since 2.7
    2079  *
    20802074 * @param string $m The matched link.
    20812075 * @param string $base The base URL to prefix to links.
    20822076 * @return string The processed link.
    … …  
    20932087/**
    20942088 * Adds a Target attribute to all links in passed content.
    20952089 *
    2096  * This function by default only applies to <a> tags,
    2097  * however this can be modified by the 3rd param.
    2098  * NOTE: Any current target attributed will be striped and replaced.
     2090 * This function by default only applies to <a> tags, however this can be
     2091 * modified by the 3rd param.
    20992092 *
    2100  * @package WordPress
    2101  * @since 2.7
     2093 * <b>NOTE:</b> Any current target attributed will be striped and replaced.
    21022094 *
     2095 * @since 2.7.0
     2096 *
    21032097 * @param string $content String to search for links in.
    21042098 * @param string $target The Target to add to the links.
    21052099 * @param array $tags An array of tags to apply to.
    … …  
    21142108/**
    21152109 * Callback to add a target attribute to all links in passed content.
    21162110 *
     2111 * @since 2.7.0
     2112 * @access private
    21172113 *
    2118  * @package WordPress
    2119  * @since 2.7
    2120  *
    21212114 * @param string $m The matched link.
    21222115 * @param string $target The Target to add to the links.
    21232116 * @return string The processed link.