WordPress.org

Make WordPress Core

Changeset 48573


Ignore:
Timestamp:
07/23/2020 12:46:56 AM (2 months ago)
Author:
johnbillion
Message:

Docs: Various corrections to inline docblocks.

See #49572

Location:
trunk/src
Files:
13 edited

Legend:

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

    r47808 r48573  
    301301 * @since 2.8.0
    302302 *
    303  * @param int|string $tag_name
    304  * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
     303 * @param string $tag_name The term name.
     304 * @param string $taxonomy Optional. The taxonomy within which to create the term. Default 'post_tag'.
    305305 * @return array|WP_Error
    306306 */
  • trunk/src/wp-admin/includes/template.php

    r48380 r48573  
    22222222
    22232223/**
    2224  * Function to echo the attachment media states as HTML.
     2224 * Outputs the attachment media states as HTML.
    22252225 *
    22262226 * @since 3.2.0
    22272227 *
    22282228 * @param WP_Post $post The attachment post to retrieve states for.
    2229  * @return string Media states string.
    22302229 */
    22312230function _media_states( $post ) {
  • trunk/src/wp-includes/blocks.php

    r48243 r48573  
    360360 * @since 5.3.1
    361361 *
    362  * @param array $attributes Attributes object.
     362 * @param array $block_attributes Attributes object.
    363363 * @return string Serialized attributes.
    364364 */
     
    397397 * @since 5.3.1
    398398 *
    399  * @param string $block_name Block name.
    400  * @param array  $attributes Block attributes.
    401  * @param string $content    Block save content.
     399 * @param string $block_name       Block name.
     400 * @param array  $block_attributes Block attributes.
     401 * @param string $block_content    Block save content.
    402402 * @return string Comment-delimited block content.
    403403 */
  • trunk/src/wp-includes/class-wp-customize-manager.php

    r48211 r48573  
    22932293     * @since 3.4.0
    22942294     *
    2295      * @param $current_theme {@internal Parameter is not used}
     2295     * @param mixed $current_theme {@internal Parameter is not used}
    22962296     * @return string Theme name.
    22972297     */
  • trunk/src/wp-includes/class-wp-customize-setting.php

    r48473 r48573  
    847847     * @since 3.4.0
    848848     *
    849      * @param $root
    850      * @param $keys
     849     * @param array $root
     850     * @param array $keys
    851851     * @param bool $create Default false.
    852852     * @return array|void Keys are 'root', 'node', and 'key'.
     
    902902     * @since 3.4.0
    903903     *
    904      * @param $root
    905      * @param $keys
     904     * @param array $root
     905     * @param array $keys
    906906     * @param mixed $value The value to update.
    907907     * @return mixed
     
    928928     * @since 3.4.0
    929929     *
    930      * @param $root
    931      * @param $keys
     930     * @param array $root
     931     * @param array $keys
    932932     * @param mixed $default A default value which is used as a fallback. Default null.
    933933     * @return mixed The requested value or the default value.
     
    947947     * @since 3.4.0
    948948     *
    949      * @param $root
    950      * @param $keys
     949     * @param array $root
     950     * @param array $keys
    951951     * @return bool True if value is set, false if not.
    952952     */
  • trunk/src/wp-includes/class-wp-dependency.php

    r48462 r48573  
    9191     *              to the function signature.
    9292     *
    93      * @param ...$args Dependency information.
     93     * @param mixed ...$args Dependency information.
    9494     */
    9595    public function __construct( ...$args ) {
  • trunk/src/wp-includes/functions.php

    r48538 r48573  
    25982598 *
    25992599 * @param string $filename The file name to check.
    2600  * $param array  $files    An array of existing files in the directory.
    2601  * $return bool True if the tested file name could match an existing file, false otherwise.
     2600 * @param array  $files    An array of existing files in the directory.
     2601 * @return bool True if the tested file name could match an existing file, false otherwise.
    26022602 */
    26032603function _wp_check_existing_file_names( $filename, $files ) {
  • trunk/src/wp-includes/general-template.php

    r48542 r48573  
    21632163 *
    21642164 * @param bool $initial Optional. Whether to use initial calendar names. Default true.
    2165  * @param bool $display Optional. Whether to display or return the calendar. Default true.
     2165 * @param bool $echo    Optional. Whether to display the calendar output. Default true.
    21662166 * @return void|string Void if `$echo` argument is true, calendar HTML if `$echo` is false.
    21672167 */
  • trunk/src/wp-includes/kses.php

    r48572 r48573  
    10351035 * @global string[]       $pass_allowed_protocols Array of allowed URL protocols.
    10361036 *
     1037 * @param array $matches preg_replace regexp matches
    10371038 * @return string
    10381039 */
     
    17131714 * @param string   $string            Content to check for bad protocols.
    17141715 * @param string[] $allowed_protocols Array of allowed URL protocols.
     1716 * @param int      $count             Depth of call recursion to this function.
    17151717 * @return string Sanitized content.
    17161718 */
  • trunk/src/wp-includes/pomo/po.php

    r48109 r48573  
    9393         *
    9494         * Doesn't need to include # in the beginning of lines, these are added automatically
     95         *
     96         * @param string $text Text to include as a comment.
    9597         */
    9698        function set_comment_before_headers( $text ) {
  • trunk/src/wp-includes/post-template.php

    r48197 r48573  
    15451545 * @see Walker_PageDropdown::walk() for parameters and return description.
    15461546 *
     1547 * @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
    15471548 * @return string
    15481549 */
  • trunk/src/wp-includes/script-loader.php

    r48537 r48573  
    4040 * @since 5.0.0
    4141 *
    42  * @param WP_Scripts $scripts WP_Scripts object.
     42 * @param WP_Scripts $scripts            WP_Scripts object.
     43 * @param bool       $force_uncompressed Whether to forcibly prevent gzip compression. Default false.
    4344 */
    4445function wp_register_tinymce_scripts( $scripts, $force_uncompressed = false ) {
  • trunk/src/wp-includes/theme.php

    r48491 r48573  
    24722472 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
    24732473 *              by adding it to the function signature.
     2474 * @since 5.5.0 The `core-block-patterns` feature was added and is enabled by default.
    24742475 *
    24752476 * @global array $_wp_theme_features
Note: See TracChangeset for help on using the changeset viewer.