WordPress.org

Make WordPress Core


Ignore:
Timestamp:
07/20/2016 04:56:21 PM (5 years ago)
Author:
DrewAPicture
Message:

Docs: Fix formatting, tense, verb conjugation, and other syntax for wp-includes/* elements introduced or changed in 4.6.

Part 1/2.

See #37318.

File:
1 edited

Legend:

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

    r38095 r38121  
    24392439
    24402440/**
    2441  * Retrieve list of common file extensions and their types.
     2441 * Retrieves the list of common file extensions and their types.
    24422442 *
    24432443 * @since 4.6.0
     
    31193119
    31203120/**
    3121  * Check that a JSONP callback is a valid JavaScript callback.
     3121 * Checks that a JSONP callback is a valid JavaScript callback.
    31223122 *
    31233123 * Only allows alphanumeric characters and the dot character in callback
     
    39033903 * Marks a deprecated action or filter hook as deprecated and throws a notice.
    39043904 *
    3905  * Use the 'deprecated_hook_run' action to get the backtrace describing where the
    3906  * deprecated hook was called.
    3907  *
    3908  * Default behavior is to trigger a user error if WP_DEBUG is true.
     3905 * Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where
     3906 * the deprecated hook was called.
     3907 *
     3908 * Default behavior is to trigger a user error if `WP_DEBUG` is true.
    39093909 *
    39103910 * This function is called by the do_action_deprecated() and apply_filters_deprecated()
     
    39333933
    39343934    /**
    3935      * Filter whether to trigger deprecated hook errors.
     3935     * Filters whether to trigger deprecated hook errors.
    39363936     *
    39373937     * @since 4.6.0
     
    53655365 * @since 4.6.0
    53665366 *
    5367  * @param string $context  Context in which the function is called.
    5368  *                         Either 'admin', 'image' or an arbitrary other context.
    5369  *                         Defaults to 'admin'.
    5370  *                         If an arbitrary context is passed, the similarly arbitrary
    5371  *                         "{$context}_memory_limit" filter will be invoked.
     5367 * @param string $context Optional. Context in which the function is called. Accepts either 'admin',
     5368 *                        'image', or an arbitrary other context. If an arbitrary context is passed,
     5369 *                        the similarly arbitrary {@see '{$context}_memory_limit'} filter will be
     5370 *                        invoked. Default 'admin'.
    53725371 * @return bool|int|string The limit that was set or false on failure.
    53735372 */
     
    53945393             * Filters the maximum memory limit available for administration screens.
    53955394             *
    5396              * This only applies to administrators, who may require more memory for tasks like updates.
    5397              * Memory limits when processing images (uploaded or edited by users of any role) are
    5398              * handled separately.
     5395             * This only applies to administrators, who may require more memory for tasks
     5396             * like updates. Memory limits when processing images (uploaded or edited by
     5397             * users of any role) are handled separately.
    53995398             *
    5400              * The WP_MAX_MEMORY_LIMIT constant specifically defines the maximum memory limit available
    5401              * when in the administration back end. The default is 256M (256 megabytes
    5402              * of memory) or the original `memory_limit` php.ini value if this is higher.
     5399             * The `WP_MAX_MEMORY_LIMIT` constant specifically defines the maximum memory
     5400             * limit available when in the administration back end. The default is 256M
     5401             * (256 megabytes of memory) or the original `memory_limit` php.ini value if
     5402             * this is higher.
    54035403             *
    54045404             * @since 3.0.0
    5405              * @since 4.6.0 The default takes the original `memory_limit` into account.
     5405             * @since 4.6.0 The default now takes the original `memory_limit` into account.
    54065406             *
    5407              * @param int|string $filtered_limit The maximum WordPress memory limit.
    5408              *                                   Accepts an integer (bytes), or a shorthand string
    5409              *                                   notation, such as '256M'.
     5407             * @param int|string $filtered_limit The maximum WordPress memory limit. Accepts an integer
     5408             *                                   (bytes), or a shorthand string notation, such as '256M'.
    54105409             */
    54115410            $filtered_limit = apply_filters( 'admin_memory_limit', $filtered_limit );
     
    54175416             *
    54185417             * @since 3.5.0
    5419              * @since 4.6.0 The default takes the original `memory_limit` into account.
     5418             * @since 4.6.0 The default now takes the original `memory_limit` into account.
    54205419             *
    54215420             * @param int|string $filtered_limit Maximum memory limit to allocate for images.
    5422              *                                   Default WP_MAX_MEMORY_LIMIT or the original
    5423              *                                   php.ini memory_limit, whichever is higher.
     5421             *                                   Default `WP_MAX_MEMORY_LIMIT` or the original
     5422             *                                   php.ini `memory_limit`, whichever is higher.
    54245423             *                                   Accepts an integer (bytes), or a shorthand string
    54255424             *                                   notation, such as '256M'.
     
    54395438             *
    54405439             * @param int|string $filtered_limit Maximum memory limit to allocate for images.
    5441              *                                   Default 256M or the original php.ini memory_limit,
    5442              *                                   whichever is higher.
    5443              *                                   Accepts an integer (bytes), or a shorthand string
    5444              *                                   notation, such as '256M'.
     5440             *                                   Default '256M' or the original php.ini `memory_limit`,
     5441             *                                   whichever is higher. Accepts an integer (bytes), or a
     5442             *                                   shorthand string notation, such as '256M'.
    54455443             */
    54465444            $filtered_limit = apply_filters( "{$context}_memory_limit", $filtered_limit );
Note: See TracChangeset for help on using the changeset viewer.