Make WordPress Core


Ignore:
Timestamp:
03/28/2022 09:43:57 AM (2 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs for function descriptions in wp-includes/template.php, per the documentation standards.

See #54729.

File:
1 edited

Legend:

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

    r52978 r52999  
    2020
    2121/**
    22  * Output an unordered list of checkbox input elements labeled with category names.
     22 * Outputs an unordered list of checkbox input elements labeled with category names.
    2323 *
    2424 * @since 2.5.1
     
    5353
    5454/**
    55  * Output an unordered list of checkbox input elements labelled with term names.
     55 * Outputs an unordered list of checkbox input elements labelled with term names.
    5656 *
    5757 * Taxonomy-independent version of wp_category_checklist().
     
    192192
    193193/**
    194  * Retrieve a list of the most popular terms from the specified taxonomy.
     194 * Retrieves a list of the most popular terms from the specified taxonomy.
    195195 *
    196196 * If the $echo argument is true then the elements for a list of checkbox
     
    532532
    533533/**
    534  * Output 'undo move to Trash' text for comments
     534 * Outputs 'undo move to Trash' text for comments.
    535535 *
    536536 * @since 2.9.0
     
    775775
    776776/**
    777  * Print out HTML form date elements for editing post or comment publish date.
     777 * Prints out HTML form date elements for editing post or comment publish date.
    778778 *
    779779 * @since 0.71
     
    870870
    871871/**
    872  * Print out option HTML elements for the page templates drop-down.
     872 * Prints out option HTML elements for the page templates drop-down.
    873873 *
    874874 * @since 1.5.0
     
    890890
    891891/**
    892  * Print out option HTML elements for the page parents drop-down.
     892 * Prints out option HTML elements for the page parents drop-down.
    893893 *
    894894 * @since 1.5.0
     
    928928
    929929/**
    930  * Print out option HTML elements for role selectors.
     930 * Prints out option HTML elements for role selectors.
    931931 *
    932932 * @since 2.1.0
     
    11241124
    11251125/**
    1126  * Function that renders a "fake" meta box with an information message,
     1126 * Renders a "fake" meta box with an information message,
    11271127 * shown on the block editor, when an incompatible meta box is found.
    11281128 *
     
    15411541
    15421542/**
    1543  * Add a new section to a settings page.
     1543 * Adds a new section to a settings page.
    15441544 *
    15451545 * Part of the Settings API. Use this to define new settings sections for an admin page.
     
    15991599
    16001600/**
    1601  * Add a new field to a section of a settings page.
     1601 * Adds a new field to a section of a settings page.
    16021602 *
    16031603 * Part of the Settings API. Use this to define a settings field that will show
     
    17091709
    17101710/**
    1711  * Print out the settings fields for a particular settings section.
     1711 * Prints out the settings fields for a particular settings section.
    17121712 *
    17131713 * Part of the Settings API. Use this in a settings page to output
     
    17521752
    17531753/**
    1754  * Register a settings error to be displayed to the user.
     1754 * Registers a settings error to be displayed to the user.
    17551755 *
    17561756 * Part of the Settings API. Use this to show messages to users about settings validation
     
    17881788
    17891789/**
    1790  * Fetch settings errors registered by add_settings_error().
     1790 * Fetches settings errors registered by add_settings_error().
    17911791 *
    17921792 * Checks the $wp_settings_errors array for any errors declared during the current
     
    18591859
    18601860/**
    1861  * Display settings errors registered by add_settings_error().
     1861 * Displays settings errors registered by add_settings_error().
    18621862 *
    18631863 * Part of the Settings API. Outputs a div for each error retrieved by
     
    19791979
    19801980/**
    1981  * Get the post title.
     1981 * Gets the post title.
    19821982 *
    19831983 * The post title is fetched and if it is blank then a default string is
     
    20102010
    20112011/**
    2012  * Generic Iframe header for use with Thickbox
     2012 * Generic Iframe header for use with Thickbox.
    20132013 *
    20142014 * @since 2.7.0
     
    20982098
    20992099/**
    2100  * Generic Iframe footer for use with Thickbox
     2100 * Generic Iframe footer for use with Thickbox.
    21012101 *
    21022102 * @since 2.7.0
     
    21332133
    21342134/**
    2135  * Function to echo or return the post states as HTML.
     2135 * Echoes or returns the post states as HTML.
    21362136 *
    21372137 * @since 2.7.0
     
    23662366
    23672367/**
    2368  * Test support for compressing JavaScript from PHP
     2368 * Tests support for compressing JavaScript from PHP.
    23692369 *
    23702370 * Outputs JavaScript that tests if compression from PHP works as expected
     
    24562456
    24572457/**
    2458  * Returns a submit button, with provided text and appropriate class
     2458 * Returns a submit button, with provided text and appropriate class.
    24592459 *
    24602460 * @since 3.1.0
     
    25592559
    25602560/**
    2561  * Convert a screen string to a screen object
     2561 * Converts a screen string to a screen object.
    25622562 *
    25632563 * @since 3.0.0
     
    26092609
    26102610/**
    2611  * Output a HTML element with a star rating for a given rating.
     2611 * Outputs a HTML element with a star rating for a given rating.
    26122612 *
    26132613 * Outputs a HTML element with the star rating exposed on a 0..5 scale in
Note: See TracChangeset for help on using the changeset viewer.