sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Miscellaneous docblock improvements.

Browse Source 
See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48184 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2020-06-26 18:38:51 +00:00
parent c31fd4988a
commit 9af5e46627
4 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/wp-admin/includes/class-wp-plugins-list-table.php
View File

@ -1011,9 +1011,10 @@ class WP_Plugins_List_Table extends WP_List_Table {
* the version, author, author URI, and plugin URI.
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @param array $plugin_data An array of plugin data.
* @param string $status Status of the plugin. Defaults are 'All', 'Active',
* 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
* 'Drop-ins', 'Search', 'Paused'.
* @param string $status Status filter currently applied to the plugin list. Possible
* values are: 'all', 'active', 'inactive', 'recently_activated',
* 'upgrade', 'mustuse', 'dropins', 'search', 'paused',
* 'auto-update-enabled', 'auto-update-disabled'.
*/
$plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
@ -1131,10 +1132,10 @@ class WP_Plugins_List_Table extends WP_List_Table {
*
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @param array $plugin_data An array of plugin data.
* @param string $status Status of the plugin. Defaults are 'All', 'Active',
* 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
* 'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
* 'Auto-updates Disabled'.
* @param string $status Status filter currently applied to the plugin list. Possible
* values are: 'all', 'active', 'inactive', 'recently_activated',
* 'upgrade', 'mustuse', 'dropins', 'search', 'paused',
* 'auto-update-enabled', 'auto-update-disabled'.
*/
do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
@ -1149,10 +1150,10 @@ class WP_Plugins_List_Table extends WP_List_Table {
*
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @param array $plugin_data An array of plugin data.
* @param string $status Status of the plugin. Defaults are 'All', 'Active',
* 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
* 'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
* 'Auto-updates Disabled'.
* @param string $status Status filter currently applied to the plugin list. Possible
* values are: 'all', 'active', 'inactive', 'recently_activated',
* 'upgrade', 'mustuse', 'dropins', 'search', 'paused',
* 'auto-update-enabled', 'auto-update-disabled'.
*/
do_action( "after_plugin_row_{$plugin_file}", $plugin_file, $plugin_data, $status );
}

6
src/wp-admin/includes/file.php
View File

@ -888,7 +888,7 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
* @param mixed $move_new_file If null (default) move the file after the upload.
* @param string[] $file An array of data for a single file.
* @param string $new_file Filename of the newly-uploaded file.
* @param string $type File type.
* @param string $type Mime type of the newly-uploaded file.
*/
$move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
@ -940,8 +940,8 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
* Array of upload data.
*
* @type string $file Filename of the newly-uploaded file.
* @type string $url URL of the uploaded file.
* @type string $type File type.
* @type string $url URL of the newly-uploaded file.
* @type string $type Mime type of the newly-uploaded file.
* }
* @param string $context The type of upload action. Values include 'upload' or 'sideload'.
*/

12
src/wp-includes/canonical.php
View File

@ -850,7 +850,7 @@ function redirect_guess_404_permalink() {
* Filters whether to attempt to guess a redirect URL for a 404 request.
*
* Passing a false value to the filter will disable the URL guessing
* and return early.
* and return early without performing a redirect.
*
* @since 5.5.0
*
@ -862,15 +862,15 @@ function redirect_guess_404_permalink() {
}
/**
* Filters whether to short-circuit redirect URL guessing for 404 requests.
* Short-circuits the redirect URL guessing for 404 requests.
*
* Passing a non-null value to the filter will effectively short-circuit
* the URL guessing, returning the passed value instead.
*
* @since 5.5.0
*
* @param null|string $pre Whether to short-circuit redirect guess 404 permalink.
* Default null to continue with the URL guessing.
* @param null|string|false $pre Whether to short-circuit guessing the redirect for a 404.
* Default null to continue with the URL guessing.
*/
$pre = apply_filters( 'pre_redirect_guess_404_permalink', null );
if ( null !== $pre ) {
@ -879,13 +879,13 @@ function redirect_guess_404_permalink() {
if ( get_query_var( 'name' ) ) {
/**
* Filters whether to perform a strict or loose guess.
* Filters whether to perform a strict guess for a 404 redirect.
*
* Passing a truthy value to the filter will redirect only exact post_name matches.
*
* @since 5.5.0
*
* @param bool $strict_guess Whether to perform a strict/exact guess. Default false (loose guess).
* @param bool $strict_guess Whether to perform a strict guess. Default false (loose guess).
*/
$strict_guess = apply_filters( 'strict_redirect_guess_404_permalink', false );

12
src/wp-includes/class-wp-http-proxy.php
View File

@ -160,8 +160,8 @@ class WP_HTTP_Proxy {
*
* @since 2.8.0
*
* @param string $uri URI to check.
* @return bool True, to send through the proxy and false if, the proxy should not be used.
* @param string $uri URL of the request.
* @return bool Whether to send the request through the proxy.
*/
public function send_through_proxy( $uri ) {
$check = parse_url( $uri );
@ -181,10 +181,10 @@ class WP_HTTP_Proxy {
*
* @since 3.5.0
*
* @param bool|null $override Whether to override the request result. Default null.
* @param string $uri URL to check.
* @param array $check Associative array result of parsing the request URI.
* @param array $home Associative array result of parsing the site URL.
* @param bool|null $override Whether to send the request through the proxy. Default null.
* @param string $uri URL of the request.
* @param array $check Associative array result of parsing the request URL with `parse_url()`.
* @param array $home Associative array result of parsing the site URL with `parse_url()`.
*/
$result = apply_filters( 'pre_http_send_through_proxy', null, $uri, $check, $home );
if ( ! is_null( $result ) ) {