WordPress.org

Make WordPress Core

Changeset 44643


Ignore:
Timestamp:
01/18/2019 01:02:11 AM (3 years ago)
Author:
pento
Message:

Docs: Add missing periods to a grab-bag of docblocks.

Props Hitendra Chopda.
Fixes #45409.

Location:
trunk/src/wp-admin/includes
Files:
4 edited

Legend:

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

    r44280 r44643  
    871871 * @param int|WP_Post $post    Post ID or WP_Post object.
    872872 *
    873  * @return null|false Boolean False if page has no children, otherwise print out html elements
     873 * @return null|false Boolean False if page has no children, otherwise print out html elements.
    874874 */
    875875function parent_dropdown( $default = 0, $parent = 0, $level = 0, $post = null ) {
     
    13711371
    13721372/**
    1373  * Meta Box Accordion Template Function
     1373 * Meta Box Accordion Template Function.
    13741374 *
    13751375 * Largely made up of abstracted code from do_meta_boxes(), this
     
    14511451 * Part of the Settings API. Use this to define new settings sections for an admin page.
    14521452 * Show settings sections in your admin page callback function with do_settings_sections().
    1453  * Add settings fields to your section with add_settings_field()
     1453 * Add settings fields to your section with add_settings_field().
    14541454 *
    14551455 * The $callback argument should be the name of a function that echoes out any
     
    14591459 * @since 2.7.0
    14601460 *
    1461  * @global $wp_settings_sections Storage array of all settings sections added to admin pages
     1461 * @global $wp_settings_sections Storage array of all settings sections added to admin pages.
    14621462 *
    14631463 * @param string   $id       Slug-name to identify the section. Used in the 'id' attribute of tags.
     
    15051505
    15061506/**
    1507  * Add a new field to a section of a settings page
     1507 * Add a new field to a section of a settings page.
    15081508 *
    15091509 * Part of the Settings API. Use this to define a settings field that will show
     
    15181518 * @since 4.2.0 The `$class` argument was added.
    15191519 *
    1520  * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
     1520 * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections.
    15211521 *
    15221522 * @param string   $id       Slug-name to identify the field. Used in the 'id' attribute of tags.
     
    15831583 * add_settings_section() and add_settings_field()
    15841584 *
    1585  * @global $wp_settings_sections Storage array of all settings sections added to admin pages
    1586  * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
     1585 * @global $wp_settings_sections Storage array of all settings sections added to admin pages.
     1586 * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections.
    15871587 * @since 2.7.0
    15881588 *
    1589  * @param string $page The slug name of the page whose settings sections you want to output
     1589 * @param string $page The slug name of the page whose settings sections you want to output.
    15901590 */
    15911591function do_settings_sections( $page ) {
     
    16151615
    16161616/**
    1617  * Print out the settings fields for a particular settings section
     1617 * Print out the settings fields for a particular settings section.
    16181618 *
    16191619 * Part of the Settings API. Use this in a settings page to output
     
    16211621 * rather than directly.
    16221622 *
    1623  * @global $wp_settings_fields Storage array of settings fields and their pages/sections
     1623 * @global $wp_settings_fields Storage array of settings fields and their pages/sections.
    16241624 *
    16251625 * @since 2.7.0
     
    16581658
    16591659/**
    1660  * Register a settings error to be displayed to the user
     1660 * Register a settings error to be displayed to the user.
    16611661 *
    16621662 * Part of the Settings API. Use this to show messages to users about settings validation
     
    16741674 * @global array $wp_settings_errors Storage array of errors registered during this pageload
    16751675 *
    1676  * @param string $setting Slug title of the setting to which this error applies
     1676 * @param string $setting Slug title of the setting to which this error applies.
    16771677 * @param string $code    Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
    16781678 * @param string $message The formatted message text to display to the user (will be shown inside styled
     
    16931693
    16941694/**
    1695  * Fetch settings errors registered by add_settings_error()
     1695 * Fetch settings errors registered by add_settings_error().
    16961696 *
    16971697 * Checks the $wp_settings_errors array for any errors declared during the current
     
    17131713 * @param string $setting Optional slug title of a specific setting whose errors you want.
    17141714 * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
    1715  * @return array Array of settings errors
     1715 * @return array Array of settings errors.
    17161716 */
    17171717function get_settings_errors( $setting = '', $sanitize = false ) {
     
    22402240 *                                       used as the button's id.
    22412241 * @param bool         $wrap             True if the output button should be wrapped in a paragraph tag,
    2242  *                                       false otherwise. Defaults to true
     2242 *                                       false otherwise. Defaults to true.
    22432243 * @param array|string $other_attributes Other attributes that should be output with the button, mapping
    22442244 *                                       attributes to their values, such as setting tabindex to 1, etc.
  • trunk/src/wp-admin/includes/theme-install.php

    r43571 r44643  
    5252
    5353/**
    54  * Retrieve list of WordPress theme features (aka theme tags)
     54 * Retrieve list of WordPress theme features (aka theme tags).
    5555 *
    5656 * @since 2.8.0
  • trunk/src/wp-admin/includes/theme.php

    r44524 r44643  
    244244
    245245/**
    246  * Retrieve list of WordPress theme features (aka theme tags)
     246 * Retrieve list of WordPress theme features (aka theme tags).
    247247 *
    248248 * @since 3.1.0
  • trunk/src/wp-admin/includes/user.php

    r44628 r44643  
    2626 *
    2727 * @param int $user_id Optional. User ID.
    28  * @return int|WP_Error user id of the updated user
     28 * @return int|WP_Error user id of the updated user.
    2929 */
    3030function edit_user( $user_id = 0 ) {
     
    548548 * @since 2.7.0
    549549 *
    550  * @param object $user User data object
     550 * @param object $user User data object.
    551551 */
    552552function use_ssl_preference( $user ) {
Note: See TracChangeset for help on using the changeset viewer.