WordPress.org

Make WordPress Core

Changeset 37537


Ignore:
Timestamp:
05/23/2016 05:27:19 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Apply inline @see tags to hooks referenced in DocBlocks for wp-admin/* files.

Applying these specially-crafted @see tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See #36921.

Location:
trunk/src/wp-admin
Files:
10 edited

Legend:

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

    r37488 r37537  
    162162 * It runs on admin-ajax.php and admin-post.php as well.
    163163 *
    164  * This is roughly analogous to the more general 'init' hook, which fires earlier.
     164 * This is roughly analogous to the more general {@see 'init'} hook, which fires earlier.
    165165 *
    166166 * @since 2.5.0
  • trunk/src/wp-admin/includes/ajax-actions.php

    r37488 r37537  
    25532553 *
    25542554 * Generates the HTML to send an attachment to the editor.
    2555  * Backward compatible with the media_send_to_editor filter
     2555 * Backward compatible with the {@see 'media_send_to_editor'} filter
    25562556 * and the chain of filters that follow.
    25572557 *
  • trunk/src/wp-admin/includes/class-wp-press-this.php

    r37488 r37537  
    135135
    136136        /**
    137          * Filters the post data of a Press This post before saving/updating, after
    138          * side_load_images action had run.
     137         * Filters the post data of a Press This post before saving/updating.
     138         *
     139         * The {@see 'side_load_images'} action has already run at this point.
    139140         *
    140141         * @since 4.5.0
  • trunk/src/wp-admin/includes/dashboard.php

    r37488 r37537  
    12621262 * Display file upload quota on dashboard.
    12631263 *
    1264  * Runs on the activity_box_end hook in wp_dashboard_right_now().
     1264 * Runs on the {@see 'activity_box_end'} hook in wp_dashboard_right_now().
    12651265 *
    12661266 * @since 3.0.0
  • trunk/src/wp-admin/includes/file.php

    r37488 r37537  
    421421
    422422/**
    423  * Wrapper for _wp_handle_upload(), passes 'wp_handle_upload' action.
     423 * Wrapper for _wp_handle_upload().
     424 *
     425 * Passes the {@see 'wp_handle_upload'} action.
    424426 *
    425427 * @since 2.0.0
     
    427429 * @see _wp_handle_upload()
    428430 *
    429  * @param array      $file      Reference to a single element of $_FILES. Call the function once for
     431 * @param array      $file      Reference to a single element of `$_FILES`. Call the function once for
    430432 *                              each uploaded file.
    431433 * @param array|bool $overrides Optional. An associative array of names=>values to override default
     
    449451
    450452/**
    451  * Wrapper for _wp_handle_upload(), passes 'wp_handle_sideload' action
     453 * Wrapper for _wp_handle_upload().
     454 *
     455 * Passes the {@see 'wp_handle_sideload'} action.
    452456 *
    453457 * @since 2.6.0
     
    455459 * @see _wp_handle_upload()
    456460 *
    457  * @param array      $file      An array similar to that of a PHP $_FILES POST array
     461 * @param array      $file      An array similar to that of a PHP `$_FILES` POST array
    458462 * @param array|bool $overrides Optional. An associative array of names=>values to override default
    459463 *                              variables. Default false.
  • trunk/src/wp-admin/includes/media.php

    r37488 r37537  
    571571     * Filters the legacy (pre-3.5.0) media buttons.
    572572     *
     573     * Use {@see 'media_buttons'} action instead.
     574     *
    573575     * @since 2.5.0
    574      * @deprecated 3.5.0 Use 'media_buttons' action instead.
     576     * @deprecated 3.5.0 Use {@see 'media_buttons'} action instead.
    575577     *
    576578     * @param string $string Media buttons context. Default empty.
     
    11331135 * post_title from the file name if none supplied.
    11341136 *
    1135  * Illustrates the use of the attachment_fields_to_save filter
     1137 * Illustrates the use of the {@see 'attachment_fields_to_save'} filter
    11361138 * which can be used to add default values to any field before saving to DB.
    11371139 *
  • trunk/src/wp-admin/includes/misc.php

    r37488 r37537  
    2121     *
    2222     * This filter was previously used to force URL rewriting for other servers,
    23      * like nginx. Use the got_url_rewrite filter in got_url_rewrite() instead.
     23     * like nginx. Use the {@see 'got_url_rewrite'} filter in got_url_rewrite() instead.
    2424     *
    2525     * @since 2.5.0
  • trunk/src/wp-admin/includes/plugin.php

    r37485 r37537  
    18161816
    18171817/**
    1818  * Refreshes the value of the options whitelist available via the 'whitelist_options' filter.
     1818 * Refreshes the value of the options whitelist available via the 'whitelist_options' hook.
     1819 *
     1820 * See the {@see 'whitelist_options'} filter.
    18191821 *
    18201822 * @since 2.7.0
  • trunk/src/wp-admin/includes/template.php

    r37488 r37537  
    13841384 * Use the $sanitize argument to manually re-sanitize the option before returning errors.
    13851385 * This is useful if you have errors or notices you want to show even when the user
    1386  * hasn't submitted data (i.e. when they first load an options page, or in admin_notices action hook)
     1386 * hasn't submitted data (i.e. when they first load an options page, or in the {@see 'admin_notices'}
     1387 * action hook).
    13871388 *
    13881389 * @since 3.0.0
  • trunk/src/wp-admin/includes/user.php

    r37488 r37537  
    276276 *
    277277 * If the $reassign parameter is not assigned to a User ID, then all posts will
    278  * be deleted of that user. The action 'delete_user' that is passed the User ID
     278 * be deleted of that user. The action {@see 'delete_user'} that is passed the User ID
    279279 * being deleted will be run after the posts are either reassigned or deleted.
    280280 * The user meta will also be deleted that are for that User ID.
     
    491491 * Optional SSL preference that can be turned on by hooking to the 'personal_options' action.
    492492 *
     493 * See the {@see 'personal_options'} action.
     494 *
    493495 * @since 2.7.0
    494496 *
Note: See TracChangeset for help on using the changeset viewer.