WordPress.org
Get WordPress

Make WordPress Core

Changeset 53514


Ignore:
Timestamp:
06/16/2022 11:08:25 PM (2 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs for function descriptions in the WP_Screen API.

See #55646.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-screen.php

    r53062 r53514  
    431431
    432432    /**
    433      * Indicates whether the screen is in a particular admin
     433     * Indicates whether the screen is in a particular admin.
    434434     *
    435435     * @since 3.5.0
    … …  
    476476
    477477    /**
    478      * Set the parent information for the screen.
     478     * Sets the parent information for the screen.
    479479     *
    480480     * This is called in admin-header.php after the menu parent for the screen has been determined.
    … …  
    506506
    507507    /**
    508      * Remove an option from the screen.
     508     * Removes an option from the screen.
    509509     *
    510510     * @since 3.8.0
    … …  
    517517
    518518    /**
    519      * Remove all options from the screen.
     519     * Removes all options from the screen.
    520520     *
    521521     * @since 3.8.0
    … …  
    526526
    527527    /**
    528      * Get the options registered for the screen.
     528     * Gets the options registered for the screen.
    529529     *
    530530     * @since 3.8.0
    … …  
    607607
    608608    /**
    609      * Add a help tab to the contextual help for the screen.
     609     * Adds a help tab to the contextual help for the screen.
    610610     *
    611611     * Call this on the `load-$pagenow` hook for the relevant screen,
    … …  
    683683
    684684    /**
    685      * Add a sidebar to the contextual help for the screen.
     685     * Adds a sidebar to the contextual help for the screen.
    686686     *
    687687     * Call this in template files after admin.php is loaded and before admin-header.php is loaded
    … …  
    714714
    715715    /**
    716      * Get the accessible hidden headings and text used in the screen.
     716     * Gets the accessible hidden headings and text used in the screen.
    717717     *
    718718     * @since 4.4.0
    … …  
    727727
    728728    /**
    729      * Get a screen reader text string.
     729     * Gets a screen reader text string.
    730730     *
    731731     * @since 4.4.0
    … …  
    742742
    743743    /**
    744      * Add accessible hidden headings and text for the screen.
     744     * Adds accessible hidden headings and text for the screen.
    745745     *
    746746     * @since 4.4.0
    … …  
    769769
    770770    /**
    771      * Remove all the accessible hidden headings and text for the screen.
     771     * Removes all the accessible hidden headings and text for the screen.
    772772     *
    773773     * @since 4.4.0
    … …  
    778778
    779779    /**
    780      * Render the screen's help section.
     780     * Renders the screen's help section.
    781781     *
    782782     * This will trigger the deprecated filters for backward compatibility.
    … …  
    10351035
    10361036    /**
    1037      * Render the screen options tab.
     1037     * Renders the screen options tab.
    10381038     *
    10391039     * @since 3.3.0
    … …  
    10981098
    10991099    /**
    1100      * Render the meta boxes preferences.
     1100     * Renders the meta boxes preferences.
    11011101     *
    11021102     * @since 4.4.0
    … …  
    11411141
    11421142    /**
    1143      * Render the list table columns preferences.
     1143     * Renders the list table columns preferences.
    11441144     *
    11451145     * @since 4.4.0
    … …  
    11891189
    11901190    /**
    1191      * Render the option for number of columns on the page
     1191     * Renders the option for number of columns on the page.
    11921192     *
    11931193     * @since 3.3.0
    … …  
    12211221
    12221222    /**
    1223      * Render the items per page option
     1223     * Renders the items per page option.
    12241224     *
    12251225     * @since 3.3.0
    … …  
    12851285
    12861286    /**
    1287      * Render the list table view mode preferences.
     1287     * Renders the list table view mode preferences.
    12881288     *
    12891289     * @since 4.4.0
    … …  
    13391339
    13401340    /**
    1341      * Render screen reader text.
     1341     * Renders screen reader text.
    13421342     *
    13431343     * @since 4.4.0
Note: See TracChangeset for help on using the changeset viewer.