Make WordPress Core

Changeset 55916


Ignore:
Timestamp:
06/14/2023 12:55:11 PM (20 months ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs in various function descriptions, as per docblocks standards.

Follow-up to [55911].

Props costdev, audrasjb.
See #57840.

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

Legend:

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

    r55854 r55916  
    1313
    1414/**
    15  * Ajax handler for the Heartbeat API in the no-privilege context.
     15 * Handles the Heartbeat API in the no-privilege context via AJAX .
    1616 *
    1717 * Runs when the user is not logged in.
     
    7777
    7878/**
    79  * Ajax handler for fetching a list table.
     79 * Handles fetching a list table via AJAX.
    8080 *
    8181 * @since 3.1.0
     
    100100
    101101/**
    102  * Ajax handler for tag search.
     102 * Handles tag search via AJAX.
    103103 *
    104104 * @since 3.1.0
     
    179179
    180180/**
    181  * Ajax handler for compression testing.
     181 * Handles compression testing via AJAX.
    182182 *
    183183 * @since 3.1.0
     
    249249
    250250/**
    251  * Ajax handler for image editor previews.
     251 * Handles image editor previews via AJAX.
    252252 *
    253253 * @since 3.1.0
     
    271271
    272272/**
    273  * Ajax handler for oEmbed caching.
     273 * Handles oEmbed caching via AJAX.
    274274 *
    275275 * @since 3.1.0
     
    283283
    284284/**
    285  * Ajax handler for user autocomplete.
     285 * Handles user autocomplete via AJAX.
    286286 *
    287287 * @since 3.4.0
     
    410410
    411411/**
    412  * Ajax handler for dashboard widgets.
     412 * Handles dashboard widgets via AJAX.
    413413 *
    414414 * @since 3.4.0
     
    431431
    432432/**
    433  * Ajax handler for Customizer preview logged-in status.
     433 * Handles Customizer preview logged-in status via AJAX.
    434434 *
    435435 * @since 3.4.0
     
    579579
    580580/**
    581  * Ajax handler for adding a hierarchical term.
     581 * Handles adding a hierarchical term via AJAX.
    582582 *
    583583 * @since 3.1.0
     
    709709
    710710/**
    711  * Ajax handler for deleting a comment.
     711 * Handles deleting a comment via AJAX.
    712712 *
    713713 * @since 3.1.0
     
    779779
    780780/**
    781  * Ajax handler for deleting a tag.
     781 * Handles deleting a tag via AJAX.
    782782 *
    783783 * @since 3.1.0
     
    806806
    807807/**
    808  * Ajax handler for deleting a link.
     808 * Handles deleting a link via AJAX.
    809809 *
    810810 * @since 3.1.0
     
    832832
    833833/**
    834  * Ajax handler for deleting meta.
     834 * Handles deleting meta via AJAX.
    835835 *
    836836 * @since 3.1.0
     
    858858
    859859/**
    860  * Ajax handler for deleting a post.
     860 * Handles deleting a post via AJAX.
    861861 *
    862862 * @since 3.1.0
     
    888888
    889889/**
    890  * Ajax handler for sending a post to the Trash.
     890 * Handles sending a post to the Trash via AJAX.
    891891 *
    892892 * @since 3.1.0
     
    924924
    925925/**
    926  * Ajax handler to restore a post from the Trash.
     926 * Handles restoring a post from the Trash via AJAX.
    927927 *
    928928 * @since 3.1.0
     
    939939
    940940/**
    941  * Ajax handler to delete a page.
     941 * Handles deleting a page via AJAX.
    942942 *
    943943 * @since 3.1.0
     
    969969
    970970/**
    971  * Ajax handler to dim a comment.
     971 * Handles dimming a comment via AJAX.
    972972 *
    973973 * @since 3.1.0
     
    10251025
    10261026/**
    1027  * Ajax handler for adding a link category.
     1027 * Handles adding a link category via AJAX.
    10281028 *
    10291029 * @since 3.1.0
     
    10781078
    10791079/**
    1080  * Ajax handler to add a tag.
     1080 * Handles adding a tag via AJAX.
    10811081 *
    10821082 * @since 3.1.0
     
    11701170
    11711171/**
    1172  * Ajax handler for getting a tagcloud.
     1172 * Handles getting a tagcloud via AJAX.
    11731173 *
    11741174 * @since 3.1.0
     
    12301230
    12311231/**
    1232  * Ajax handler for getting comments.
     1232 * Handles getting comments via AJAX.
    12331233 *
    12341234 * @since 3.1.0
     
    12931293
    12941294/**
    1295  * Ajax handler for replying to a comment.
     1295 * Handles replying to a comment via AJAX.
    12961296 *
    12971297 * @since 3.1.0
     
    14531453
    14541454/**
    1455  * Ajax handler for editing a comment.
     1455 * Handles editing a comment via AJAX.
    14561456 *
    14571457 * @since 3.1.0
     
    15081508
    15091509/**
    1510  * Ajax handler for adding a menu item.
     1510 * Handles adding a menu item via AJAX.
    15111511 *
    15121512 * @since 3.1.0
     
    15961596
    15971597/**
    1598  * Ajax handler for adding meta.
     1598 * Handles adding meta via AJAX.
    15991599 *
    16001600 * @since 3.1.0
     
    17181718
    17191719/**
    1720  * Ajax handler for adding a user.
     1720 * Handles adding a user via AJAX.
    17211721 *
    17221722 * @since 3.1.0
     
    17731773
    17741774/**
    1775  * Ajax handler for closed post boxes.
     1775 * Handles closed post boxes via AJAX.
    17761776 *
    17771777 * @since 3.1.0
     
    18101810
    18111811/**
    1812  * Ajax handler for hidden columns.
     1812 * Handles hidden columns via AJAX.
    18131813 *
    18141814 * @since 3.1.0
     
    18341834
    18351835/**
    1836  * Ajax handler for updating whether to display the welcome panel.
     1836 * Handles updating whether to display the welcome panel via AJAX.
    18371837 *
    18381838 * @since 3.1.0
     
    18511851
    18521852/**
    1853  * Ajax handler for retrieving menu meta boxes.
     1853 * Handles for retrieving menu meta boxes via AJAX.
    18541854 *
    18551855 * @since 3.1.0
     
    19021902
    19031903/**
    1904  * Ajax handler for internal linking.
     1904 * Handles internal linking via AJAX.
    19051905 *
    19061906 * @since 3.1.0
     
    19381938
    19391939/**
    1940  * Ajax handler for menu locations save.
     1940 * Handles saving menu locations via AJAX.
    19411941 *
    19421942 * @since 3.1.0
     
    19581958
    19591959/**
    1960  * Ajax handler for saving the meta box order.
     1960 * Handles saving the meta box order via AJAX.
    19611961 *
    19621962 * @since 3.1.0
     
    19941994
    19951995/**
    1996  * Ajax handler for menu quick searching.
     1996 * Handles menu quick searching via AJAX.
    19971997 *
    19981998 * @since 3.1.0
     
    20112011
    20122012/**
    2013  * Ajax handler to retrieve a permalink.
     2013 * Handles retrieving a permalink via AJAX.
    20142014 *
    20152015 * @since 3.1.0
     
    20222022
    20232023/**
    2024  * Ajax handler to retrieve a sample permalink.
     2024 * Handles retrieving a sample permalink via AJAX.
    20252025 *
    20262026 * @since 3.1.0
     
    20352035
    20362036/**
    2037  * Ajax handler for Quick Edit saving a post from a list table.
     2037 * Handles Quick Edit saving a post from a list table via AJAX.
    20382038 *
    20392039 * @since 3.1.0
     
    21542154
    21552155/**
    2156  * Ajax handler for quick edit saving for a term.
     2156 * Handles Quick Edit saving for a term via AJAX.
    21572157 *
    21582158 * @since 3.1.0
     
    22142214
    22152215/**
    2216  * Ajax handler for querying posts for the Find Posts modal.
     2216 * Handles querying posts for the Find Posts modal via AJAX.
    22172217 *
    22182218 * @see window.findPosts
     
    22832283
    22842284/**
    2285  * Ajax handler for saving the widgets order.
     2285 * Handles saving the widgets order via AJAX.
    22862286 *
    22872287 * @since 3.1.0
     
    23252325
    23262326/**
    2327  * Ajax handler for saving a widget.
     2327 * Handles saving a widget via AJAX.
    23282328 *
    23292329 * @since 3.1.0
     
    24342434
    24352435/**
    2436  * Ajax handler for updating a widget.
     2436 * Handles updating a widget via AJAX.
    24372437 *
    24382438 * @since 3.9.0
     
    24462446
    24472447/**
    2448  * Ajax handler for removing inactive widgets.
     2448 * Handles removing inactive widgets via AJAX.
    24492449 *
    24502450 * @since 4.4.0
     
    24832483
    24842484/**
    2485  * Ajax handler for creating missing image sub-sizes for just uploaded images.
     2485 * Handles creating missing image sub-sizes for just uploaded images via AJAX.
    24862486 *
    24872487 * @since 5.3.0
     
    25402540
    25412541/**
    2542  * Ajax handler for uploading attachments
     2542 * Handles uploading attachments via AJAX.
    25432543 *
    25442544 * @since 3.3.0
     
    26532653
    26542654/**
    2655  * Ajax handler for image editing.
     2655 * Handles image editing via AJAX.
    26562656 *
    26572657 * @since 3.1.0
     
    27082708
    27092709/**
    2710  * Ajax handler for setting the featured image.
     2710 * Handles setting the featured image via AJAX.
    27112711 *
    27122712 * @since 3.1.0
     
    27462746
    27472747/**
    2748  * Ajax handler for retrieving HTML for the featured image.
     2748 * Handles retrieving HTML for the featured image via AJAX.
    27492749 *
    27502750 * @since 4.6.0
     
    27712771
    27722772/**
    2773  * Ajax handler for setting the featured image for an attachment.
     2773 * Handles setting the featured image for an attachment via AJAX.
    27742774 *
    27752775 * @since 4.0.0
     
    28262826
    28272827/**
    2828  * Ajax handler for date formatting.
     2828 * Handles formatting a date via AJAX.
    28292829 *
    28302830 * @since 3.1.0
     
    28352835
    28362836/**
    2837  * Ajax handler for time formatting.
     2837 * Handles formatting a time via AJAX.
    28382838 *
    28392839 * @since 3.1.0
     
    28442844
    28452845/**
    2846  * Ajax handler for saving posts from the fullscreen editor.
     2846 * Handles saving posts from the fullscreen editor via AJAX.
    28472847 *
    28482848 * @since 3.1.0
     
    28882888
    28892889/**
    2890  * Ajax handler for removing a post lock.
     2890 * Handles removing a post lock via AJAX.
    28912891 *
    28922892 * @since 3.1.0
     
    29302930
    29312931/**
    2932  * Ajax handler for dismissing a WordPress pointer.
     2932 * Handles dismissing a WordPress pointer via AJAX.
    29332933 *
    29342934 * @since 3.1.0
     
    29572957
    29582958/**
    2959  * Ajax handler for getting an attachment.
     2959 * Handles getting an attachment via AJAX.
    29602960 *
    29612961 * @since 3.5.0
     
    29932993
    29942994/**
    2995  * Ajax handler for querying attachments.
     2995 * Handles querying attachments via AJAX.
    29962996 *
    29972997 * @since 3.5.0
     
    30843084
    30853085/**
    3086  * Ajax handler for updating attachment attributes.
     3086 * Handles updating attachment attributes via AJAX.
    30873087 *
    30883088 * @since 3.5.0
     
    31703170
    31713171/**
    3172  * Ajax handler for saving backward compatible attachment attributes.
     3172 * Handles saving backward compatible attachment attributes via AJAX.
    31733173 *
    31743174 * @since 3.5.0
     
    32283228
    32293229/**
    3230  * Ajax handler for saving the attachment order.
     3230 * Handles saving the attachment order via AJAX.
    32313231 *
    32323232 * @since 3.5.0
     
    32813281
    32823282/**
    3283  * Ajax handler for sending an attachment to the editor.
     3283 * Handles sending an attachment to the editor via AJAX.
    32843284 *
    32853285 * Generates the HTML to send an attachment to the editor.
     
    33553355
    33563356/**
    3357  * Ajax handler for sending a link to the editor.
     3357 * Handles sending a link to the editor via AJAX.
    33583358 *
    33593359 * Generates the HTML to send a non-image embed link to the editor.
     
    34273427
    34283428/**
    3429  * Ajax handler for the Heartbeat API.
     3429 * Handles the Heartbeat API via AJAX.
    34303430 *
    34313431 * Runs when the user is logged in.
     
    35143514
    35153515/**
    3516  * Ajax handler for getting revision diffs.
     3516 * Handles getting revision diffs via AJAX.
    35173517 *
    35183518 * @since 3.6.0
     
    35543554
    35553555/**
    3556  * Ajax handler for auto-saving the selected color scheme for
    3557  * a user's own profile.
     3556 * Handles auto-saving the selected color scheme for
     3557 * a user's own profile via AJAX.
    35583558 *
    35593559 * @since 3.8.0
     
    35843584
    35853585/**
    3586  * Ajax handler for getting themes from themes_api().
     3586 * Handles getting themes from themes_api() via AJAX.
    35873587 *
    35883588 * @since 3.9.0
     
    37153715
    37163716/**
    3717  * Apply [embed] Ajax handlers to a string.
     3717 * Applies [embed] Ajax handlers to a string.
    37183718 *
    37193719 * @since 4.0.0
     
    39273927
    39283928/**
    3929  * Ajax handler for destroying multiple open sessions for a user.
     3929 * Handles destroying multiple open sessions for a user via AJAX.
    39303930 *
    39313931 * @since 4.1.0
     
    39653965
    39663966/**
    3967  * Ajax handler for cropping an image.
     3967 * Handles cropping an image via AJAX.
    39683968 *
    39693969 * @since 4.3.0
     
    41044104
    41054105/**
    4106  * Ajax handler for generating a password.
     4106 * Handles generating a password via AJAX.
    41074107 *
    41084108 * @since 4.4.0
     
    41134113
    41144114/**
    4115  * Ajax handler for generating a password in the no-privilege context.
     4115 * Handles generating a password in the no-privilege context via AJAX.
    41164116 *
    41174117 * @since 5.7.0
     
    41224122
    41234123/**
    4124  * Ajax handler for saving the user's WordPress.org username.
     4124 * Handles saving the user's WordPress.org username via AJAX.
    41254125 *
    41264126 * @since 4.4.0
     
    41434143
    41444144/**
    4145  * Ajax handler for installing a theme.
     4145 * Handles installing a theme via AJAX.
    41464146 *
    41474147 * @since 4.6.0
     
    42694269
    42704270/**
    4271  * Ajax handler for updating a theme.
     4271 * Handles updating a theme via AJAX.
    42724272 *
    42734273 * @since 4.6.0
     
    43644364
    43654365/**
    4366  * Ajax handler for deleting a theme.
     4366 * Handles deleting a theme via AJAX.
    43674367 *
    43684368 * @since 4.6.0
     
    44384438
    44394439/**
    4440  * Ajax handler for installing a plugin.
     4440 * Handles installing a plugin via AJAX.
    44414441 *
    44424442 * @since 4.6.0
     
    45474547
    45484548/**
    4549  * Ajax handler for updating a plugin.
     4549 * Handles updating a plugin via AJAX.
    45504550 *
    45514551 * @since 4.2.0
     
    46554655
    46564656/**
    4657  * Ajax handler for deleting a plugin.
     4657 * Handles deleting a plugin via AJAX.
    46584658 *
    46594659 * @since 4.6.0
     
    47324732
    47334733/**
    4734  * Ajax handler for searching plugins.
     4734 * Handles searching plugins via AJAX.
    47354735 *
    47364736 * @since 4.6.0
     
    47894789
    47904790/**
    4791  * Ajax handler for searching plugins to install.
     4791 * Handles searching plugins to install via AJAX.
    47924792 *
    47934793 * @since 4.6.0
     
    48394839
    48404840/**
    4841  * Ajax handler for editing a theme or plugin file.
     4841 * Handles editing a theme or plugin file via AJAX.
    48424842 *
    48434843 * @since 4.9.0
     
    48684868
    48694869/**
    4870  * Ajax handler for exporting a user's personal data.
     4870 * Handles exporting a user's personal data via AJAX.
    48714871 *
    48724872 * @since 4.9.6
     
    50585058
    50595059/**
    5060  * Ajax handler for erasing personal data.
     5060 * Handles erasing personal data via AJAX.
    50615061 *
    50625062 * @since 4.9.6
     
    52875287
    52885288/**
    5289  * Ajax handler for site health checks on server communication.
     5289 * Handles site health checks on server communication via AJAX.
    52905290 *
    52915291 * @since 5.2.0
     
    53205320
    53215321/**
    5322  * Ajax handler for site health checks on background updates.
     5322 * Handles site health checks on background updates via AJAX.
    53235323 *
    53245324 * @since 5.2.0
     
    53535353
    53545354/**
    5355  * Ajax handler for site health checks on loopback requests.
     5355 * Handles site health checks on loopback requests via AJAX.
    53565356 *
    53575357 * @since 5.2.0
     
    53865386
    53875387/**
    5388  * Ajax handler for site health check to update the result status.
     5388 * Handles site health check to update the result status via AJAX.
    53895389 *
    53905390 * @since 5.2.0
     
    54035403
    54045404/**
    5405  * Ajax handler for site health check to get directories and database sizes.
     5405 * Handles site health check to get directories and database sizes via AJAX.
    54065406 *
    54075407 * @since 5.2.0
     
    54695469
    54705470/**
    5471  * Ajax handler to renew the REST API nonce.
     5471 * Handles renewing the REST API nonce via AJAX.
    54725472 *
    54735473 * @since 5.3.0
     
    54785478
    54795479/**
    5480  * Ajax handler to enable or disable plugin and theme auto-updates.
     5480 * Handles enabling or disable plugin and theme auto-updates via AJAX.
    54815481 *
    54825482 * @since 5.5.0
     
    55485548
    55495549/**
    5550  * Ajax handler sends a password reset link.
     5550 * Handles sending a password reset link via AJAX.
    55515551 *
    55525552 * @since 5.7.0
  • trunk/src/wp-admin/includes/class-wp-importer.php

    r55664 r55916  
    188188
    189189    /**
    190      * GET URL
     190     * Gets URL.
    191191     *
    192192     * @param string $url
  • trunk/src/wp-admin/includes/class-wp-internal-pointers.php

    r54133 r55916  
    105105
    106106    /**
    107      * Print the pointer JavaScript data.
     107     * Prints the pointer JavaScript data.
    108108     *
    109109     * @since 3.3.0
  • trunk/src/wp-admin/includes/credits.php

    r55703 r55916  
    99
    1010/**
    11  * Retrieve the contributor credits.
     11 * Retrieves the contributor credits.
    1212 *
    1313 * @since 3.2.0
     
    6262
    6363/**
    64  * Retrieve the link to a contributor's WordPress.org profile page.
     64 * Retrieves the link to a contributor's WordPress.org profile page.
    6565 *
    6666 * @access private
     
    7676
    7777/**
    78  * Retrieve the link to an external library used in WordPress.
     78 * Retrieves the link to an external library used in WordPress.
    7979 *
    8080 * @access private
  • trunk/src/wp-admin/includes/dashboard.php

    r55895 r55916  
    533533
    534534/**
    535  * The Quick Draft widget display and creation of drafts.
     535 * Displays the Quick Draft widget.
    536536 *
    537537 * @since 3.8.0
     
    921921
    922922/**
    923  * Callback function for Activity widget.
     923 * Outputs the Activity widget.
     924 *
     925 * Callback function for {@see 'dashboard_activity'}.
    924926 *
    925927 * @since 3.8.0
     
    12281230
    12291231/**
    1230  * The RSS dashboard widget control.
    1231  *
    1232  * Sets up $args to be used as input to wp_widget_rss_form(). Handles POST data
    1233  * from RSS-type widgets.
     1232 * Sets up the RSS dashboard widget control and $args to be used as input to wp_widget_rss_form().
     1233 *
     1234 * Handles POST data from RSS-type widgets.
    12341235 *
    12351236 * @since 2.5.0
     
    20242025
    20252026/**
    2026  * Empty function usable by plugins to output empty dashboard widget (to be populated later by JS).
     2027 * Outputs empty dashboard widget to be populated by JS later.
     2028 *
     2029 * Usable by plugins.
    20272030 *
    20282031 * @since 2.5.0
Note: See TracChangeset for help on using the changeset viewer.