WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
04/11/2022 09:46:11 PM (3 years ago)
Author:
audrasjb
Message:

Docs: Misc. docblock fixes in wp-admin/includes/mic.php, as per documentation standards.

See #54729.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/misc.php

    r53145 r53146  
    330330
    331331/**
    332  * Update the "recently-edited" file for the plugin or theme file editor.
     332 * Updates the "recently-edited" file for the plugin or theme file editor.
    333333 *
    334334 * @since 1.5.0
    … …  
    567567
    568568/**
    569  * Resets global variables based on $_GET and $_POST
     569 * Resets global variables based on $_GET and $_POST.
    570570 *
    571571 * This function resets global variables based on the names passed
    … …  
    802802
    803803/**
    804  * Check if rewrite rule for WordPress already exists in the IIS 7+ configuration file
     804 * Checks if rewrite rule for WordPress already exists in the IIS 7+ configuration file.
    805805 *
    806806 * @since 2.8.0
    807807 *
    808  * @param string $filename The file path to the configuration file
     808 * @param string $filename The file path to the configuration file.
    809809 * @return bool
    810810 */
    … …  
    835835
    836836/**
    837  * Delete WordPress rewrite rule from web.config file if it exists there
     837 * Deletes WordPress rewrite rule from web.config file if it exists there.
    838838 *
    839839 * @since 2.8.0
    840840 *
    841  * @param string $filename Name of the configuration file
     841 * @param string $filename Name of the configuration file.
    842842 * @return bool
    843843 */
    … …  
    874874
    875875/**
    876  * Add WordPress rewrite rule to the IIS 7+ configuration file.
     876 * Adds WordPress rewrite rule to the IIS 7+ configuration file.
    877877 *
    878878 * @since 2.8.0
    879879 *
    880  * @param string $filename The file path to the configuration file
    881  * @param string $rewrite_rule The XML fragment with URL Rewrite rule
     880 * @param string $filename     The file path to the configuration file.
     881 * @param string $rewrite_rule The XML fragment with URL Rewrite rule.
    882882 * @return bool
    883883 */
    … …  
    962962
    963963/**
    964  * Saves the XML document into a file
     964 * Saves the XML document into a file.
    965965 *
    966966 * @since 2.8.0
    … …  
    979979
    980980/**
    981  * Display the default admin color scheme picker (Used in user-edit.php)
     981 * Displays the default admin color scheme picker (Used in user-edit.php).
    982982 *
    983983 * @since 3.0.0
    … …  
    11111111
    11121112/**
    1113  * Check lock status for posts displayed on the Posts screen
     1113 * Checks lock status for posts displayed on the Posts screen.
    11141114 *
    11151115 * @since 3.6.0
    … …  
    11621162
    11631163/**
    1164  * Check lock status on the New/Edit Post screen and refresh the lock
     1164 * Checks lock status on the New/Edit Post screen and refresh the lock.
    11651165 *
    11661166 * @since 3.6.0
    … …  
    12161216
    12171217/**
    1218  * Check nonce expiration on the New/Edit Post screen and refresh if needed
     1218 * Checks nonce expiration on the New/Edit Post screen and refresh if needed.
    12191219 *
    12201220 * @since 3.6.0
    … …  
    12561256
    12571257/**
    1258  * Add the latest Heartbeat and REST-API nonce to the Heartbeat response.
     1258 * Adds the latest Heartbeat and REST-API nonce to the Heartbeat response.
    12591259 *
    12601260 * @since 5.0.0
    … …  
    12741274
    12751275/**
    1276  * Disable suspension of Heartbeat on the Add/Edit Post screens.
     1276 * Disables suspension of Heartbeat on the Add/Edit Post screens.
    12771277 *
    12781278 * @since 3.8.0
    … …  
    12941294
    12951295/**
    1296  * Autosave with heartbeat
     1296 * Performs autosave with heartbeat.
    12971297 *
    12981298 * @since 3.9.0
    … …  
    13311331
    13321332/**
    1333  * Remove single-use URL parameters and create canonical link based on new URL.
    1334  *
    1335  * Remove specific query string parameters from a URL, create the canonical link,
     1333 * Removes single-use URL parameters and create canonical link based on new URL.
     1334 *
     1335 * Removes specific query string parameters from a URL, create the canonical link,
    13361336 * put it in the admin header, and change the current URL to match.
    13371337 *
    … …  
    13591359
    13601360/**
    1361  * Send a referrer policy header so referrers are not sent externally from administration screens.
     1361 * Sends a referrer policy header so referrers are not sent externally from administration screens.
    13621362 *
    13631363 * @since 4.9.0
    … …  
    14001400
    14011401/**
    1402  * Send a confirmation request email when a change of site admin email address is attempted.
     1402 * Sends a confirmation request email when a change of site admin email address is attempted.
    14031403 *
    14041404 * The new site admin address will not become active until confirmed.
Note: See TracChangeset for help on using the changeset viewer.