Make WordPress Core


Ignore:
Timestamp:
11/24/2014 05:18:56 AM (10 years ago)
Author:
DrewAPicture
Message:

Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

  • Remove HTML tag from parameter description in comment_form()
  • Remove HTML tag from a summary for the comment_form_top hook
  • Markdown-indent a code snippet in the description for get_linkobjectsbyname()
  • Markdown-indent a code snippet and format an unordered list in the description for get_linkobjects()
  • Backtick-escape some inline code in the description for clean_pre()
  • Remove HTML tag from the summary for the rss_tag_pre hook
  • Various formatting fixes in the descriptions for get_filesystem_method() and request_filesystem_credentials()

Props rarst for the initial patch.
See #30473.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/file.php

    r30384 r30538  
    869869/**
    870870 * Determines which Filesystem Method to use.
    871  * The priority of the Transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets (Via Sockets class, or fsockopen())
     871 *
     872 * The priority of the Transports are: Direct, SSH2, FTP PHP Extension,
     873 * FTP Sockets (Via Sockets class, or `fsockopen()`).
    872874 *
    873875 * Note that the return value of this function can be overridden in 2 ways
    874  *  - By defining FS_METHOD in your <code>wp-config.php</code> file
     876 *
     877 *  - By defining FS_METHOD in your `wp-config.php` file
    875878 *  - By using the filesystem_method filter
    876  * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
    877  * Plugins may also define a custom transport handler, See the WP_Filesystem function for more information.
     879 *
     880 * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'.
     881 *
     882 * Plugins may also define a custom transport handler, See the WP_Filesystem
     883 * function for more information.
    878884 *
    879885 * @since 2.5.0
     886 *
     887 * @todo Properly mark arguments as optional.
    880888 *
    881889 * @param array $args Connection details.
     
    944952
    945953/**
    946  * Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
     954 * Displays a form to the user to request for their FTP/SSH details in order
     955 * to connect to the filesystem.
     956 *
    947957 * All chosen/entered details are saved, Excluding the Password.
    948958 *
    949  * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467) to specify an alternate FTP/SSH port.
    950  *
    951  * Plugins may override this form by returning true|false via the <code>request_filesystem_credentials</code> filter.
    952  *
    953  * @since 2.5.0
     959 * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
     960 * to specify an alternate FTP/SSH port.
     961 *
     962 * Plugins may override this form by returning true|false via the
     963 * {@see 'request_filesystem_credentials'} filter.
     964 *
     965 * @since 2.5.
     966 *
     967 * @todo Properly mark optional arguments as such
    954968 *
    955969 * @param string $form_post the URL to post the form to
Note: See TracChangeset for help on using the changeset viewer.