Make WordPress Core

Changeset 55911


Ignore:
Timestamp:
06/14/2023 06:32:14 AM (14 months ago)
Author:
audrasjb
Message:

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

Props costdev, audrasjb.
See #57840.

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

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-core-upgrader.php

    r55899 r55911  
    2222
    2323    /**
    24      * Initialize the upgrade strings.
     24     * Initializes the upgrade strings.
    2525     *
    2626     * @since 2.8.0
     
    4040
    4141    /**
    42      * Upgrade WordPress core.
     42     * Upgrades WordPress core.
    4343     *
    4444     * @since 2.8.0
     
    386386
    387387    /**
    388      * Compare the disk file checksums against the expected checksums.
     388     * Compares the disk file checksums against the expected checksums.
    389389     *
    390390     * @since 3.7.0
  • trunk/src/wp-admin/includes/class-file-upload-upgrader.php

    r55703 r55911  
    116116
    117117    /**
    118      * Delete the attachment/uploaded file.
     118     * Deletes the attachment/uploaded file.
    119119     *
    120120     * @since 3.2.2
  • trunk/src/wp-admin/includes/class-language-pack-upgrader.php

    r55899 r55911  
    106106
    107107    /**
    108      * Initialize the upgrade strings.
     108     * Initializes the upgrade strings.
    109109     *
    110110     * @since 3.7.0
     
    124124
    125125    /**
    126      * Upgrade a language pack.
     126     * Upgrades a language pack.
    127127     *
    128128     * @since 3.7.0
     
    148148
    149149    /**
    150      * Bulk upgrade language packs.
     150     * Upgrades several language packs at once.
    151151     *
    152152     * @since 3.7.0
     
    361361
    362362    /**
    363      * Get the name of an item being updated.
     363     * Gets the name of an item being updated.
    364364     *
    365365     * @since 3.7.0
  • trunk/src/wp-admin/includes/class-plugin-installer-skin.php

    r55595 r55911  
    4747
    4848    /**
    49      * Action to perform before installing a plugin.
     49     * Performs an action before installing a plugin.
    5050     *
    5151     * @since 2.8.0
     
    8282
    8383    /**
    84      * Action to perform following a plugin install.
     84     * Performs an action following a plugin install.
    8585     *
    8686     * @since 2.8.0
     
    178178
    179179    /**
    180      * Check if the plugin can be overwritten and output the HTML for overwriting a plugin on upload.
     180     * Checks if the plugin can be overwritten and outputs the HTML for overwriting a plugin on upload.
    181181     *
    182182     * @since 5.5.0
  • trunk/src/wp-admin/includes/class-plugin-upgrader-skin.php

    r49539 r55911  
    7373
    7474    /**
    75      * Action to perform following a single plugin update.
     75     * Performs an action following a single plugin update.
    7676     *
    7777     * @since 2.8.0
  • trunk/src/wp-admin/includes/class-plugin-upgrader.php

    r55899 r55911  
    5050
    5151    /**
    52      * Initialize the upgrade strings.
     52     * Initializes the upgrade strings.
    5353     *
    5454     * @since 2.8.0
     
    6868
    6969    /**
    70      * Initialize the installation strings.
     70     * Initializes the installation strings.
    7171     *
    7272     * @since 2.8.0
     
    174174
    175175    /**
    176      * Upgrade a plugin.
     176     * Upgrades a plugin.
    177177     *
    178178     * @since 2.8.0
     
    266266
    267267    /**
    268      * Bulk upgrade several plugins at once.
     268     * Upgrades several plugins at once.
    269269     *
    270270     * @since 2.8.0
     
    480480
    481481    /**
    482      * Retrieve the path to the file that contains the plugin info.
     482     * Retrieves the path to the file that contains the plugin info.
    483483     *
    484484     * This isn't used internally in the class, but is called by the skins.
  • trunk/src/wp-admin/includes/class-theme-installer-skin.php

    r55595 r55911  
    4747
    4848    /**
    49      * Action to perform before installing a theme.
     49     * Performs an action before installing a theme.
    5050     *
    5151     * @since 2.8.0
     
    8282
    8383    /**
    84      * Action to perform following a single theme install.
     84     * Performs an action following a single theme install.
    8585     *
    8686     * @since 2.8.0
     
    189189
    190190    /**
    191      * Check if the theme can be overwritten and output the HTML for overwriting a theme on upload.
     191     * Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
    192192     *
    193193     * @since 5.5.0
  • trunk/src/wp-admin/includes/class-theme-upgrader-skin.php

    r55276 r55911  
    5252
    5353    /**
    54      * Action to perform following a single theme update.
     54     * Performs an action following a single theme update.
    5555     *
    5656     * @since 2.8.0
  • trunk/src/wp-admin/includes/class-theme-upgrader.php

    r55899 r55911  
    4949
    5050    /**
    51      * Initialize the upgrade strings.
     51     * Initializes the upgrade strings.
    5252     *
    5353     * @since 2.8.0
     
    6666
    6767    /**
    68      * Initialize the installation strings.
     68     * Initializes the installation strings.
    6969     *
    7070     * @since 2.8.0
     
    111111
    112112    /**
    113      * Check if a child theme is being installed and we need to install its parent.
     113     * Checks if a child theme is being installed and its parent also needs to be installed.
    114114     *
    115115     * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::install().
     
    279279
    280280    /**
    281      * Upgrade a theme.
     281     * Upgrades a theme.
    282282     *
    283283     * @since 2.8.0
     
    365365
    366366    /**
    367      * Upgrade several themes at once.
     367     * Upgrades several themes at once.
    368368     *
    369369     * @since 3.0.0
     
    633633
    634634    /**
    635      * Turn on maintenance mode before attempting to upgrade the active theme.
     635     * Turns on maintenance mode before attempting to upgrade the active theme.
    636636     *
    637637     * Hooked to the {@see 'upgrader_pre_install'} filter by Theme_Upgrader::upgrade() and
     
    665665
    666666    /**
    667      * Turn off maintenance mode after upgrading the active theme.
     667     * Turns off maintenance mode after upgrading the active theme.
    668668     *
    669669     * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::upgrade()
     
    703703
    704704    /**
    705      * Delete the old theme during an upgrade.
     705     * Deletes the old theme during an upgrade.
    706706     *
    707707     * Hooked to the {@see 'upgrader_clear_destination'} filter by Theme_Upgrader::upgrade()
     
    741741
    742742    /**
    743      * Get the WP_Theme object for a theme.
     743     * Gets the WP_Theme object for a theme.
    744744     *
    745745     * @since 2.8.0
  • trunk/src/wp-admin/includes/class-wp-automatic-updater.php

    r55594 r55911  
    618618
    619619    /**
    620      * If we tried to perform a core update, check if we should send an email,
    621      * and if we need to avoid processing future updates.
     620     * Checks whether to send an email and avoid processing future updates after
     621     * attempting a core update.
    622622     *
    623623     * @since 3.7.0
     
    968968
    969969    /**
    970      * If we tried to perform plugin or theme updates, check if we should send an email.
     970     * Checks whether an email should be sent after attempting plugin or theme updates.
    971971     *
    972972     * @since 5.5.0
  • trunk/src/wp-admin/includes/class-wp-links-list-table.php

    r55732 r55911  
    152152
    153153    /**
    154      * Get the name of the default primary column.
     154     * Gets the name of the default primary column.
    155155     *
    156156     * @since 4.3.0
  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r55857 r55911  
    174174
    175175    /**
    176      * Make private properties readable for backward compatibility.
     176     * Makes private properties readable for backward compatibility.
    177177     *
    178178     * @since 4.0.0
     
    188188
    189189    /**
    190      * Make private properties settable for backward compatibility.
     190     * Makes private properties settable for backward compatibility.
    191191     *
    192192     * @since 4.0.0
     
    203203
    204204    /**
    205      * Make private properties checkable for backward compatibility.
     205     * Makes private properties checkable for backward compatibility.
    206206     *
    207207     * @since 4.0.0
     
    219219
    220220    /**
    221      * Make private properties un-settable for backward compatibility.
     221     * Makes private properties un-settable for backward compatibility.
    222222     *
    223223     * @since 4.0.0
     
    232232
    233233    /**
    234      * Make private/protected methods readable for backward compatibility.
     234     * Makes private/protected methods readable for backward compatibility.
    235235     *
    236236     * @since 4.0.0
     
    270270
    271271    /**
    272      * An internal method that sets all the necessary pagination arguments
     272     * Sets all the necessary pagination arguments.
    273273     *
    274274     * @since 3.1.0
     
    321321
    322322    /**
    323      * Whether the table has items to display or not
     323     * Determines whether the table has items to display or not
    324324     *
    325325     * @since 3.1.0
     
    11511151
    11521152    /**
     1153     * Gets the name of the primary column.
     1154     *
    11531155     * Public wrapper for WP_List_Table::get_default_primary_column_name().
    11541156     *
     
    14521454
    14531455    /**
    1454      * Extra controls to be displayed between bulk actions and pagination.
     1456     * Displays extra controls between bulk actions and pagination.
    14551457     *
    14561458     * @since 3.1.0
  • trunk/src/wp-admin/includes/class-wp-media-list-table.php

    r55732 r55911  
    264264
    265265    /**
    266      * Override parent views so we can use the filter bar display.
     266     * Overrides parent views to use the filter bar display.
    267267     *
    268268     * @global string $mode List table view mode.
  • trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php

    r55732 r55911  
    316316
    317317    /**
    318      * Extra controls to be displayed between bulk actions and pagination.
     318     * Displays extra controls between bulk actions and pagination.
    319319     *
    320320     * @since 5.3.0
     
    622622
    623623    /**
    624      * Maybe output comma-separated site states.
     624     * Determines whether to output comma-separated site states.
    625625     *
    626626     * @since 5.3.0
  • trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

    r55732 r55911  
    3131
    3232    /**
    33      * Return the list of known plugins.
     33     * Returns the list of known plugins.
    3434     *
    3535     * Uses the transient data from the updates API to determine the known
  • trunk/src/wp-admin/includes/class-wp-posts-list-table.php

    r55732 r55911  
    227227
    228228    /**
    229      * Determine if the current view is the "All" view.
     229     * Determines if the current view is the "All" view.
    230230     *
    231231     * @since 4.2.0
     
    247247
    248248    /**
    249      * Helper to create links to edit.php with params.
     249     * Creates a link to edit.php with params.
    250250     *
    251251     * @since 4.4.0
     
    918918
    919919    /**
    920      * Given a top level page ID, display the nested hierarchy of sub-pages
    921      * together with paging support
     920     * Displays the nested hierarchy of sub-pages together with paging
     921     * support, based on a top level page ID.
    922922     *
    923923     * @since 3.1.0 (Standalone function exists since 2.6.0)
  • trunk/src/wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php

    r49259 r55911  
    3737
    3838    /**
    39      * Actions column.
     39     * Outputs the Actions column.
    4040     *
    4141     * @since 4.9.6
     
    109109
    110110    /**
    111      * Next steps column.
     111     * Outputs the Next steps column.
    112112     *
    113113     * @since 4.9.6
  • trunk/src/wp-admin/includes/class-wp-privacy-requests-table.php

    r54215 r55911  
    3232
    3333    /**
    34      * Get columns to show in the list table.
     34     * Gets columns to show in the list table.
    3535     *
    3636     * @since 4.9.6
     
    5050
    5151    /**
    52      * Normalize the admin URL to the current page (by request_type).
     52     * Normalizes the admin URL to the current page (by request_type).
    5353     *
    5454     * @since 5.3.0
     
    6767
    6868    /**
    69      * Get a list of sortable columns.
     69     * Gets a list of sortable columns.
    7070     *
    7171     * @since 4.9.6
     
    8888
    8989    /**
    90      * Default primary column.
     90     * Returns the default primary column.
    9191     *
    9292     * @since 4.9.6
     
    9999
    100100    /**
    101      * Count number of requests for each status.
     101     * Counts the number of requests for each status.
    102102     *
    103103     * @since 4.9.6
     
    138138
    139139    /**
    140      * Get an associative array ( id => link ) with the list of views available on this table.
     140     * Gets an associative array ( id => link ) with the list of views available on this table.
    141141     *
    142142     * @since 4.9.6
     
    201201
    202202    /**
    203      * Get bulk actions.
     203     * Gets bulk actions.
    204204     *
    205205     * @since 4.9.6
     
    355355
    356356    /**
    357      * Prepare items to output.
     357     * Prepares items to output.
    358358     *
    359359     * @since 4.9.6
     
    408408
    409409    /**
    410      * Checkbox column.
     410     * Returns the markup for the Checkbox column.
    411411     *
    412412     * @since 4.9.6
     
    457457
    458458    /**
    459      * Convert timestamp for display.
     459     * Converts a timestamp for display.
    460460     *
    461461     * @since 4.9.6
     
    480480
    481481    /**
    482      * Default column handler.
     482     * Handles the default column.
    483483     *
    484484     * @since 4.9.6
     
    504504
    505505    /**
    506      * Created timestamp column. Overridden by children.
     506     * Returns the markup for the Created timestamp column. Overridden by children.
    507507     *
    508508     * @since 5.7.0
     
    528528
    529529    /**
    530      * Next steps column. Overridden by children.
     530     * Returns the markup for the next steps column. Overridden by children.
    531531     *
    532532     * @since 4.9.6
     
    552552
    553553    /**
    554      * Embed scripts used to perform actions. Overridden by children.
     554     * Embeds scripts used to perform actions. Overridden by children.
    555555     *
    556556     * @since 4.9.6
  • trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php

    r54378 r55911  
    545545
    546546    /**
    547      * Check to see if the theme is already installed.
     547     * Checks to see if the theme is already installed.
    548548     *
    549549     * @since 3.4.0
  • trunk/src/wp-admin/includes/class-wp-upgrader-skin.php

    r55595 r55911  
    212212
    213213    /**
    214      * Action to perform before an update.
     214     * Performs an action before an update.
    215215     *
    216216     * @since 2.8.0
     
    219219
    220220    /**
    221      * Action to perform following an update.
     221     * Performs and action following an update.
    222222     *
    223223     * @since 2.8.0
     
    226226
    227227    /**
    228      * Output JavaScript that calls function to decrement the update counts.
     228     * Outputs JavaScript that calls function to decrement the update counts.
    229229     *
    230230     * @since 3.9.0
  • trunk/src/wp-admin/includes/class-wp-upgrader.php

    r55720 r55911  
    150150
    151151    /**
    152      * Initialize the upgrader.
     152     * Initializes the upgrader.
    153153     *
    154154     * This will set the relationship between the skin being used and this upgrader,
     
    181181
    182182    /**
    183      * Add the generic strings to WP_Upgrader::$strings.
     183     * Adds the generic strings to WP_Upgrader::$strings.
    184184     *
    185185     * @since 2.8.0
     
    218218
    219219    /**
    220      * Connect to the filesystem.
     220     * Connects to the filesystem.
    221221     *
    222222     * @since 2.8.0
     
    290290
    291291    /**
    292      * Download a package.
     292     * Downloads a package.
    293293     *
    294294     * @since 2.8.0
     
    340340
    341341    /**
    342      * Unpack a compressed package file.
     342     * Unpacks a compressed package file.
    343343     *
    344344     * @since 2.8.0
     
    398398
    399399    /**
    400      * Flatten the results of WP_Filesystem_Base::dirlist() for iterating over.
     400     * Flattens the results of WP_Filesystem_Base::dirlist() for iterating over.
    401401     *
    402402     * @since 4.9.0
     
    713713
    714714    /**
    715      * Run an upgrade/installation.
     715     * Runs an upgrade/installation.
    716716     *
    717717     * Attempts to download the package (if it is not a local file), unpack it, and
     
    961961
    962962    /**
    963      * Toggle maintenance mode for the site.
     963     * Toggles maintenance mode for the site.
    964964     *
    965965     * Creates/deletes the maintenance file to enable/disable maintenance mode.
  • trunk/src/wp-admin/includes/class-wp-users-list-table.php

    r55864 r55911  
    5959
    6060    /**
    61      * Check the current user's permissions.
     61     * Checks the current user's permissions.
    6262     *
    6363     * @since 3.1.0
     
    7474
    7575    /**
    76      * Prepare the users list for display.
     76     * Prepares the users list for display.
    7777     *
    7878     * @since 3.1.0
     
    151151
    152152    /**
    153      * Output 'no users' message.
     153     * Outputs 'no users' message.
    154154     *
    155155     * @since 3.1.0
     
    160160
    161161    /**
    162      * Return an associative array listing all the views that can be used
     162     * Returns an associative array listing all the views that can be used
    163163     * with this table.
    164164     *
     
    263263
    264264    /**
    265      * Retrieve an associative array of bulk actions available on this table.
     265     * Retrieves an associative array of bulk actions available on this table.
    266266     *
    267267     * @since 3.1.0
     
    291291
    292292    /**
    293      * Output the controls to allow user roles to be changed in bulk.
     293     * Outputs the controls to allow user roles to be changed in bulk.
    294294     *
    295295     * @since 3.1.0
     
    344344
    345345    /**
    346      * Capture the bulk action required, and return it.
     346     * Captures the bulk action required, and return it.
    347347     *
    348348     * Overridden from the base class implementation to capture
     
    362362
    363363    /**
    364      * Get a list of columns for the list table.
     364     * Gets a list of columns for the list table.
    365365     *
    366366     * @since 3.1.0
     
    386386
    387387    /**
    388      * Get a list of sortable columns for the list table.
     388     * Gets a list of sortable columns for the list table.
    389389     *
    390390     * @since 3.1.0
     
    402402
    403403    /**
    404      * Generate the list table rows.
     404     * Generates the list table rows.
    405405     *
    406406     * @since 3.1.0
     
    418418
    419419    /**
    420      * Generate HTML for a single row on the users.php admin panel.
     420     * Generates HTML for a single row on the users.php admin panel.
    421421     *
    422422     * @since 3.1.0
Note: See TracChangeset for help on using the changeset viewer.