IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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.

Built from https://develop.svn.wordpress.org/trunk@30538


git-svn-id: http://core.svn.wordpress.org/trunk@30527 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2014-11-24 05:19:23 +00:00
parent 273396fe1e
commit de809a5a86
5 changed files with 52 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
wp-admin/includes/file.php
View File

@@ -868,16 +868,24 @@ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_own
/**
* Determines which Filesystem Method to use.
* The priority of the Transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets (Via Sockets class, or fsockopen())
*
* The priority of the Transports are: Direct, SSH2, FTP PHP Extension,
* FTP Sockets (Via Sockets class, or `fsockopen()`).
*
* Note that the return value of this function can be overridden in 2 ways
* - By defining FS_METHOD in your <code>wp-config.php</code> file
*
* - By defining FS_METHOD in your `wp-config.php` file
* - By using the filesystem_method filter
* Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
* Plugins may also define a custom transport handler, See the WP_Filesystem function for more information.
*
* Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'.
*
* Plugins may also define a custom transport handler, See the WP_Filesystem
* function for more information.
*
* @since 2.5.0
*
* @todo Properly mark arguments as optional.
*
* @param array $args Connection details.
* @param string $context Full path to the directory that is tested for being writable.
* @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
@@ -943,14 +951,20 @@ function get_filesystem_method( $args = array(), $context = false, $allow_relaxe
}
/**
* Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
* Displays a form to the user to request for their FTP/SSH details in order
* to connect to the filesystem.
*
* All chosen/entered details are saved, Excluding the Password.
*
* Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467) to specify an alternate FTP/SSH port.
* Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
* to specify an alternate FTP/SSH port.
*
* Plugins may override this form by returning true|false via the <code>request_filesystem_credentials</code> filter.
* Plugins may override this form by returning true|false via the
* {@see 'request_filesystem_credentials'} filter.
*
* @since 2.5.0
* @since 2.5.
*
* @todo Properly mark optional arguments as such
*
* @param string $form_post the URL to post the form to
* @param string $type the chosen Filesystem method in use