WordPress.org

Make WordPress Core

Changeset 38125


Ignore:
Timestamp:
07/20/2016 07:32:05 PM (4 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 2/2.

Fixes #37318.

Location:
trunk/src/wp-includes
Files:
11 edited

Legend:

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

    r37985 r38125  
    35983598 *
    35993599 * @since 2.9.0
    3600  * @since 4.6.0 Adjusted to use `wp_get_canonical_url()`.
     3600 * @since 4.6.0 Adjusted to use wp_get_canonical_url().
    36013601 */
    36023602function rel_canonical() {
  • trunk/src/wp-includes/meta.php

    r38108 r38125  
    10961096 * @since 4.6.0
    10971097 *
    1098  * @param string $object_type    The type of object.
    1099  * @param string $meta_key       The meta key.
    1100  *
     1098 * @param string $object_type The type of object.
     1099 * @param string $meta_key    The meta key.
    11011100 * @return bool True if successful. False if the meta key was not registered.
    11021101 */
     
    11341133 *
    11351134 * @param string $object_type The type of object. Post, comment, user, term.
    1136  *
    11371135 * @return array List of registered meta keys.
    11381136 */
     
    11561154 * @param string $meta_key    Optional. Registered metadata key. If not specified, retrieve all registered
    11571155 *                            metadata for the specified object.
    1158  *
    11591156 * @return mixed A single value or array of values for a key if specified. An array of all registered keys
    11601157 *               and values for an object ID if not.
  • trunk/src/wp-includes/ms-blogs.php

    r38055 r38125  
    462462     * @since 4.6.0
    463463     *
    464      * @param int     $id Blog ID.
    465      * @param WP_Site $blog
     464     * @param int     $id              Blog ID.
     465     * @param WP_Site $blog            Site object.
    466466     * @param string  $domain_path_key md5 hash of domain and path.
    467467     */
     
    521521 *
    522522 * @see update_site_cache()
    523  *
    524523 * @global wpdb $wpdb WordPress database abstraction object.
    525524 *
     
    10901089 * @global WP_Network $current_site
    10911090 *
    1092  * @param WP_Network|int|null $network Network to retrieve.
     1091 * @param WP_Network|int|null $network Network to retrieve, passed by reference.
    10931092 * @return WP_Network|null The network object or null if not found.
    10941093 */
  • trunk/src/wp-includes/ms-load.php

    r37985 r38125  
    138138 * @since 3.9.0
    139139 * @since 4.4.0 Converted to leverage WP_Network
    140  * @since 4.6.0 Converted to use `get_network()`
     140 * @since 4.6.0 Converted to use get_network()
    141141 *
    142142 * @param object|int $network The network's database row or ID.
     
    284284 * @param string $domain    The requested domain.
    285285 * @param string $path      The requested path.
    286  * @param bool   $subdomain Whether a subdomain (true) or subdirectory (false) configuration.
     286 * @param bool   $subdomain Optional. Whether a subdomain (true) or subdirectory (false) configuration.
     287 *                          Default false.
    287288 * @return bool|string True if bootstrap successfully populated `$current_blog` and `$current_site`.
    288289 *                     False if bootstrap could not be properly completed.
  • trunk/src/wp-includes/plugin.php

    r38061 r38125  
    670670 * @param array  $args        Array of additional function arguments to be passed to apply_filters().
    671671 * @param string $version     The version of WordPress that deprecated the hook.
    672  * @param string $replacement Optional. The hook that should have been used.
    673  * @param string $message     Optional. A message regarding the change.
     672 * @param string $replacement Optional. The hook that should have been used. Default false.
     673 * @param string $message     Optional. A message regarding the change. Default null.
    674674 */
    675675function apply_filters_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
     
    10041004
    10051005/**
    1006  * Back up global variables used for actions and filters.
     1006 * Backs up global variables used for actions and filters.
    10071007 *
    10081008 * Prevents redefinition of these globals in advanced-cache.php from accidentally
     
    10171017 * @global array $wp_current_filter Stores the list of current filters with the current one last.
    10181018 * @staticvar array $backup_globals Backed up globals.
     1019 *
    10191020 * @return array the staticvar from the first time it is set.
    10201021 */
    10211022function _backup_plugin_globals(){
    10221023    global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
     1024
    10231025    static $backup_globals = array();
     1026
    10241027    if ( empty( $backup_globals ) ) {
    10251028        $backup_globals = array(
     
    10341037
    10351038/**
    1036  * Safely restore backed up global variables used for actions and filters.
     1039 * Safely restores backed up global variables used for actions and filters.
    10371040 *
    10381041 * @since 4.6.0
     
    10471050function _restore_plugin_globals(){
    10481051    global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
     1052
    10491053    $backup_globals = _backup_plugin_globals();
     1054
    10501055    if ( $wp_filter !== $backup_globals['backup_wp_filter'] ){
    10511056        $wp_filter = array_merge_recursive( $wp_filter, $backup_globals['backup_wp_filter'] );
  • trunk/src/wp-includes/post.php

    r38118 r38125  
    43174317 *
    43184318 * @since 1.5.0
    4319  * @since 4.6.0 The $page parameter is optional.
     4319 * @since 4.6.0 Converted the `$page` parameter to optional.
    43204320 *
    43214321 * @param WP_Post|object|int $page Optional. Page ID or WP_Post object. Default is global $post.
     
    49564956 * @since 4.6.0
    49574957 *
    4958  * @param int $post_id Optional. Attachment ID. Default 0.
     4958 * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`.
    49594959 * @return string|false False on failure. Attachment caption on success.
    49604960 */
  • trunk/src/wp-includes/query.php

    r37985 r38125  
    14741474     *              Introduced the `$comment_status` and `$ping_status` parameters.
    14751475     *              Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
    1476      * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced `$lazy_load_term_meta`.
     1476     * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
    14771477     * @access public
    14781478     *
  • trunk/src/wp-includes/script-loader.php

    r38119 r38125  
    919919 *
    920920 * @link http://api.jqueryui.com/datepicker/#options
     921 *
    921922 * @global WP_Locale $wp_locale The WordPress date and time locale object.
    922923 */
  • trunk/src/wp-includes/taxonomy.php

    r38077 r38125  
    12261226     *
    12271227     * @since 2.3.0
    1228      * @since 4.6.0 Added `$term_query`.
     1228     * @since 4.6.0 Added the `$term_query` parameter.
    12291229     *
    12301230     * @param array         $terms      Array of found terms.
  • trunk/src/wp-includes/user.php

    r37985 r38125  
    23342334
    23352335/**
    2336  * Initiate email notifications related to the creation of new users.
     2336 * Initiates email notifications related to the creation of new users.
    23372337 *
    23382338 * Notifications are sent both to the site admin and to the newly created user.
    23392339 *
    23402340 * @since 4.4.0
    2341  * @since 4.6.0 The `$notify` parameter accepts 'user' for sending notification only to the user created.
     2341 * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending
     2342 *              notifications only to the user created.
    23422343 *
    23432344 * @param int    $user_id ID of the newly created user.
    2344  * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin' or an empty string
    2345  *                        (admin only), 'user', or 'both' (admin and user). Default 'both'.
     2345 * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin'
     2346 *                        or an empty string (admin only), 'user', or 'both' (admin and user).
     2347 *                        Default 'both'.
    23462348 */
    23472349function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
  • trunk/src/wp-includes/wp-db.php

    r37985 r38125  
    757757
    758758    /**
    759      * Given a charset and collation, determine the best charset and collation to use.
     759     * Determines the best charset and collation to use given a charset and collation.
    760760     *
    761761     * For example, when able, utf8mb4 should be used instead of utf8.
    762762     *
    763763     * @since 4.6.0
    764      *
    765      * @param  string $charset The character set to check.
    766      * @param  string $collate The collation to check.
    767      *
     764     * @access public
     765     *
     766     * @param string $charset The character set to check.
     767     * @param string $collate The collation to check.
    768768     * @return array The most appropriate character set and collation to use.
    769769     */
     
    32373237     *
    32383238     * @since 2.7.0
    3239      * @since 4.1.0 Support was added for the 'utf8mb4' feature.
    3240      * @since 4.6.0 Support was added for the 'utf8mb4_520' feature.
     3239     * @since 4.1.0 Added support for the 'utf8mb4' feature.
     3240     * @since 4.6.0 Added support for the 'utf8mb4_520' feature.
    32413241     *
    32423242     * @see wpdb::db_version()
     
    32773277                    return version_compare( $client_version, '5.5.3', '>=' );
    32783278                }
    3279             case 'utf8mb4_520' :  // @since 4.6.0
     3279            case 'utf8mb4_520' : // @since 4.6.0
    32803280                return version_compare( $version, '5.6', '>=' );
    32813281        }
Note: See TracChangeset for help on using the changeset viewer.