Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: Another pass at some inline docs fixes mostly made by PHPCBF. 

See #49572, #50744
Built from https://develop.svn.wordpress.org/trunk@48590


git-svn-id: http://core.svn.wordpress.org/trunk@48352 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2020-07-23 21:11:05 +00:00
parent 3f04e3bf5c
commit 9bc7d0a776
33 changed files with 216 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
wp-includes/class-wp-recovery-mode-email-service.php
View File

@ -41,7 +41,9 @@ final class WP_Recovery_Mode_Email_Service {
*
* @param int $rate_limit Number of seconds before another email can be sent.
* @param array $error Error details from {@see error_get_last()}
* @param array $extension The extension that caused the error. {
* @param array $extension {
* The extension that caused the error.
*
* @type string $slug The extension slug. The plugin or theme's directory.
* @type string $type The extension type. Either 'plugin' or 'theme'.
* }

2
wp-includes/class-wp-recovery-mode.php
View File

@ -341,6 +341,8 @@ class WP_Recovery_Mode {
*
* @param array $error Error that was triggered.
* @return array|false {
* Extension details.
*
* @type string $slug The extension slug. This is the plugin or theme's directory.
* @type string $type The extension type. Either 'plugin' or 'theme'.
* }

8
wp-includes/class-wp-theme.php
View File

@ -1636,8 +1636,8 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @param string $a First name.
* @param string $b Second name.
* @param WP_Theme $a First theme.
* @param WP_Theme $b Second theme.
* @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
* Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
*/
@ -1650,8 +1650,8 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @param string $a First name.
* @param string $b Second name.
* @param WP_Theme $a First theme.
* @param WP_Theme $b Second theme.
* @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
* Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
*/

5
wp-includes/comment.php
View File

@ -1063,6 +1063,7 @@ function get_comment_pages_count( $comments = null, $per_page = null, $threaded
* @param int $comment_ID Comment ID.
* @param array $args {
* Array of optional arguments.
*
* @type string $type Limit paginated comments to those matching a given type.
* Accepts 'comment', 'trackback', 'pingback', 'pings'
* (trackbacks and pingbacks), or 'all'. Default 'all'.
@ -3286,8 +3287,8 @@ function _close_comments_for_old_posts( $posts, $query ) {
* @since 2.7.0
* @access private
*
* @param bool $open Comments open or closed
* @param int $post_id Post ID
* @param bool $open Comments open or closed.
* @param int $post_id Post ID.
* @return bool $open
*/
function _close_comments_for_old_post( $open, $post_id ) {

3
wp-includes/formatting.php
View File

@ -4923,7 +4923,6 @@ function map_deep( $value, $callback ) {
/**
* Parses a string into variables to be stored in an array.
*
*
* @since 2.2.1
*
* @param string $string The string to be parsed.
@ -5364,7 +5363,7 @@ function sanitize_textarea_field( $str ) {
* @access private
*
* @param string $str String to sanitize.
* @param bool $keep_newlines optional Whether to keep newlines. Default: false.
* @param bool $keep_newlines Optional. Whether to keep newlines. Default: false.
* @return string Sanitized string.
*/
function _sanitize_text_fields( $str, $keep_newlines = false ) {

5
wp-includes/functions.php
View File

@ -298,7 +298,6 @@ function wp_date( $format, $timestamp = null, $timezone = null ) {
* @param string $format Format to display the date.
* @param int $timestamp Unix timestamp.
* @param DateTimeZone $timezone Timezone.
*
*/
$date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );
@ -7525,8 +7524,8 @@ function get_dirsize( $directory, $max_execution_time = null ) {
* @since 5.2.0 $max_execution_time parameter added.
*
* @param string $directory Full path of a directory.
* @param string|array $exclude Optional. Full path of a subdirectory to exclude from the total, or array of paths.
* Expected without trailing slash(es).
* @param string|array $exclude Optional. Full path of a subdirectory to exclude from the total, or array of
* paths. Expected without trailing slash(es).
* @param int $max_execution_time Maximum time to run before giving up. In seconds.
* The timeout is global and is measured from the moment WordPress started to load.
* @return int|false|null Size in bytes if a valid directory. False if not. Null if timeout.

1
wp-includes/meta.php
View File

@ -155,7 +155,6 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique =
* and was therefore added, true on successful update,
* false on failure or if the value passed to the function
* is the same as the one that is already in the database.
*/
function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value = '' ) {
global $wpdb;

4
wp-includes/pluggable.php
View File

@ -2591,7 +2591,7 @@ if ( ! function_exists( 'get_avatar' ) ) :
* 'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
* or 'gravatar_default' (the Gravatar logo). Default is the value of the
* 'avatar_default' option, with a fallback of 'mystery'.
* @param string $alt Optional. Alternative text to use in <img> tag. Default empty.
* @param string $alt Optional. Alternative text to use in img tag. Default empty.
* @param array $args {
* Optional. Extra arguments to retrieve the avatar.
*
@ -2602,7 +2602,7 @@ if ( ! function_exists( 'get_avatar' ) ) :
* judged in that order. Default is the value of the 'avatar_rating' option.
* @type string $scheme URL scheme to use. See set_url_scheme() for accepted values.
* Default null.
* @type array|string $class Array or string of additional classes to add to the <img> element.
* @type array|string $class Array or string of additional classes to add to the img element.
* Default null.
* @type bool $force_display Whether to always show the avatar - ignores the show_avatars option.
* Default false.

4
wp-includes/pomo/po.php
View File

@ -71,8 +71,8 @@ if ( ! class_exists( 'PO', false ) ) :
/**
* Same as {@link export}, but writes the result to a file
*
* @param string $filename where to write the PO string
* @param bool $include_headers whether to include tje headers in the export
* @param string $filename Where to write the PO string.
* @param bool $include_headers Whether to include the headers in the export.
* @return bool true on success, false on error
*/
function export_to_file( $filename, $include_headers = true ) {

2
wp-includes/post.php
View File

@ -4964,7 +4964,7 @@ function get_pung( $post_id ) {
* @since 4.7.0 `$post_id` can be a WP_Post object.
*
* @param int|WP_Post $post_id Post Object or ID
* @param string[] List of URLs yet to ping.
* @return string[]|false List of URLs yet to ping.
*/
function get_to_ping( $post_id ) {
$post = get_post( $post_id );

2
wp-includes/shortcodes.php
View File

@ -365,7 +365,7 @@ function do_shortcode_tag( $m ) {
*
* @since 4.2.3
*
* @param string $content Content to search for shortcodes
* @param string $content Content to search for shortcodes.
* @param bool $ignore_html When true, all square braces inside elements will be encoded.
* @param array $tagnames List of shortcodes to find.
* @return string Content with shortcodes filtered out.

9
wp-includes/taxonomy.php
View File

@ -841,11 +841,12 @@ function get_tax_sql( $tax_query, $primary_table, $primary_id_column ) {
*
* @param int|WP_Term|object $term If integer, term data will be fetched from the database, or from the cache if
* available. If stdClass object (as in the results of a database query), will apply
* filters and return a `WP_Term` object corresponding to the `$term` data. If `WP_Term`,
* will return `$term`.
* filters and return a `WP_Term` object corresponding to the `$term` data. If
* `WP_Term`, will return `$term`.
* @param string $taxonomy Optional. Taxonomy name that $term is part of.
* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
* a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
* correspond toa WP_Term object, an associative array, or a numeric array
* respectively. Default OBJECT.
* @param string $filter Optional. How to sanitize term fields. Default 'raw'.
* @return WP_Term|array|WP_Error|null Object of the type specified by `$output` on success. When `$output` is 'OBJECT',
* a WP_Term instance is returned. If taxonomy does not exist, a WP_Error is

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.5-beta3-48589';
$wp_version = '5.5-beta3-48590';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

1
wp-includes/wp-db.php
View File

@ -2661,7 +2661,6 @@ class wpdb {
* return an associative array of row objects keyed by the value
* of each row's first column's value. Duplicate keys are discarded.
* @return array|object|null Database query results.
*
*/
public function get_results( $query = null, $output = OBJECT ) {
$this->func_call = "\$db->get_results(\"$query\", $output)";

12
wp-signup.php
View File

@ -811,12 +811,12 @@ function validate_blog_signup() {
*
* @since MU (3.0.0)
*
* @param string $domain The domain URL
* @param string $path The site root path
* @param string $blog_title The new site title
* @param string $user_name The user's username
* @param string $user_email The user's email address
* @param array $meta Any additional meta from the {@see 'add_signup_meta'} filter in validate_blog_signup()
* @param string $domain The domain URL.
* @param string $path The site root path.
* @param string $blog_title The new site title.
* @param string $user_name The user's username.
* @param string $user_email The user's email address.
* @param array $meta Any additional meta from the {@see 'add_signup_meta'} filter in validate_blog_signup().
*/
function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $user_email = '', $meta = array() ) {
?>