WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
10/26/2019 09:07:10 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Switch more docs over to typed array notation, plus some fixes.

See #48303, #41756

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/formatting.php

    r46592 r46596  
    231231     * @since 2.8.0
    232232     *
    233      * @param array $default_no_texturize_tags An array of HTML element names.
     233     * @param string[] $default_no_texturize_tags An array of HTML element names.
    234234     */
    235235    $no_texturize_tags = apply_filters( 'no_texturize_tags', $default_no_texturize_tags );
    … …  
    239239     * @since 2.8.0
    240240     *
    241      * @param array $default_no_texturize_shortcodes An array of shortcode names.
     241     * @param string[] $default_no_texturize_shortcodes An array of shortcode names.
    242242     */
    243243    $no_texturize_shortcodes = apply_filters( 'no_texturize_shortcodes', $default_no_texturize_shortcodes );
    … …  
    398398 * @access private
    399399 *
    400  * @param string $text Text to check. Must be a tag like `<html>` or `[shortcode]`.
    401  * @param array  $stack List of open tag elements.
    402  * @param array  $disabled_elements The tag names to match against. Spaces are not allowed in tag names.
     400 * @param string   $text              Text to check. Must be a tag like `<html>` or `[shortcode]`.
     401 * @param string[] $stack             Array of open tag elements.
     402 * @param string[] $disabled_elements Array of tag names to match against. Spaces are not allowed in tag names.
    403403 */
    404404function _wptexturize_pushpop_element( $text, &$stack, $disabled_elements ) {
    … …  
    737737 * @access private
    738738 * @ignore
    739  * @internal This function will be removed in 4.5.0 per Shortcode API Roadmap.
    740739 * @since 4.4.0
    741740 *
    742  * @param array $tagnames List of shortcodes to find.
     741 * @param string[] $tagnames Array of shortcodes to find.
    743742 * @return string The regular expression
    744743 */
    … …  
    20012000 * @since 2.1.0
    20022001 *
    2003  * @param string $filename The filename to be sanitized
    2004  * @return string The sanitized filename
     2002 * @param string $filename The filename to be sanitized.
     2003 * @return string The sanitized filename.
    20052004 */
    20062005function sanitize_file_name( $filename ) {
    … …  
    20122011     * @since 2.8.0
    20132012     *
    2014      * @param array  $special_chars Characters to remove.
    2015      * @param string $filename_raw  Filename as it was passed into sanitize_file_name().
     2013     * @param string[] $special_chars Array of characters to remove.
     2014     * @param string   $filename_raw  The original filename to be sanitized.
    20162015     */
    20172016    $special_chars = apply_filters( 'sanitize_file_name_chars', $special_chars, $filename_raw );
    … …  
    42694268 * @since 2.8.0
    42704269 *
    4271  * @param string $url       The URL to be cleaned.
    4272  * @param array $protocols Optional. An array of acceptable protocols.
    4273  *                          Defaults to return value of wp_allowed_protocols()
    4274  * @param string $_context  Private. Use esc_url_raw() for database usage.
     4270 * @param string   $url       The URL to be cleaned.
     4271 * @param string[] $protocols Optional. An array of acceptable protocols.
     4272 *                            Defaults to return value of wp_allowed_protocols()
     4273 * @param string   $_context  Private. Use esc_url_raw() for database usage.
    42754274 * @return string The cleaned $url after the {@see 'clean_url'} filter is applied.
    42764275 */
    … …  
    43774376 * @since 2.8.0
    43784377 *
    4379  * @param string $url       The URL to be cleaned.
    4380  * @param array $protocols An array of acceptable protocols.
     4378 * @param string   $url       The URL to be cleaned.
     4379 * @param string[] $protocols An array of acceptable protocols.
    43814380 * @return string The cleaned URL.
    43824381 */
    … …  
    51215120 * @global string $_links_add_target
    51225121 *
    5123  * @param string $content String to search for links in.
    5124  * @param string $target  The Target to add to the links.
    5125  * @param array $tags    An array of tags to apply to.
     5122 * @param string   $content String to search for links in.
     5123 * @param string   $target  The Target to add to the links.
     5124 * @param string[] $tags    An array of tags to apply to.
    51265125 * @return string The processed content.
    51275126 */
Note: See TracChangeset for help on using the changeset viewer.