WordPress.org
Get WordPress

Make WordPress Core

Changeset 30680


Ignore:
Timestamp:
12/01/2014 12:59:43 AM (10 years ago)
Author:
wonderboymusic
Message:

Improve various @param docs for src/wp-admin/*.

See #30224.

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

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-upgrader-skins.php

    r30384 r30680  
    2828    }
    2929
     30    /**
     31     * @param WP_Upgrader $upgrader
     32     */
    3033    public function set_upgrader(&$upgrader) {
    3134        if ( is_object($upgrader) )
    … …  
    217220    }
    218221
     222    /**
     223     * @param string $string
     224     */
    219225    public function feedback($string) {
    220226        if ( isset( $this->upgrader->strings[$string] ) )
    … …  
    722728    }
    723729
     730    /**
     731     * @param string|array|WP_Error $data
     732     */
    724733    public function feedback( $data ) {
    725734        if ( is_wp_error( $data ) )

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

    r30648 r30680  
    433433 * @since 2.5.0
    434434 *
    435  * @param array $content_func
     435 * @param string|callable $content_func
    436436 */
    437437function wp_iframe($content_func /* ... */) {
    … …  
    917917 * @since 2.7.0
    918918 *
    919  * @param object $post
     919 * @param WP_Post $post
    920920 * @param string $checked
    921921 * @return string
    … …  
    945945 * @since 2.7.0
    946946 *
    947  * @param object $post
     947 * @param WP_Post $post
    948948 * @param bool|string $check
    949949 * @return array
    … …  
    10171017 * @since 2.7.0
    10181018 *
    1019  * @param object $post
     1019 * @param WP_Post $post
    10201020 * @param string $url_type
    10211021 * @return string
    … …  
    29312931 *
    29322932 * @param string $file Path to file.
    2933  * @return array|boolean Returns array of metadata, if found.
     2933 * @return array|bool Returns array of metadata, if found.
    29342934 */
    29352935function wp_read_video_metadata( $file ) {

  • trunk/src/wp-admin/includes/plugin-install.php

    r30555 r30680  
    191191 * @since 2.8.0
    192192 *
    193  * @param string $page
     193 * @param integer $page
    194194 */
    195195function install_plugins_upload( $page = 1 ) {

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

    r30648 r30680  
    11211121 * @since 2.5.0
    11221122 *
    1123  * @param int|object $id    Post ID or post object.
     1123 * @param integer $id    Post ID or post object.
    11241124 * @param string $title (optional) Title
    11251125 * @param string $name (optional) Name
    … …  
    11861186 * @since 2.5.0
    11871187 *
    1188  * @param int|object $id Post ID or post object.
     1188 * @param integer $id Post ID or post object.
    11891189 * @param string $new_title Optional. New title.
    11901190 * @param string $new_slug Optional. New slug.
    … …  
    13091309 *
    13101310 * @param int $post_id ID of the post to check for editing
    1311  * @return bool|int False: not locked or locked by current user. Int: user ID of user with lock.
     1311 * @return integer False: not locked or locked by current user. Int: user ID of user with lock.
    13121312 */
    13131313function wp_check_post_lock( $post_id ) {

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

    r30648 r30680  
    6161 * @since 2.7.0
    6262 *
    63  * @param string|WP_Screen $screen
     63 * @param WP_Screen $screen
    6464 */
    6565function meta_box_prefs( $screen ) {
    … …  
    651651     * @param string $key    Optional. Specific array key for when the option is an array.
    652652     *                       Default false.
    653      * @return mixed The option value if set, null otherwise.
     653     * @return string The option value if set, null otherwise.
    654654     */
    655655    public function get_option( $option, $key = false ) {

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

    r30641 r30680  
    404404 * @since 2.7.0
    405405 *
    406  * @param string|int $position
     406 * @param int $position
    407407 * @param bool $checkbox
    408408 * @param string $mode
    … …  
    708708 * @since 0.71
    709709 *
    710  * @param int|bool $edit      Accepts 1|true for editing the date, 0|false for adding the date.
    711  * @param int|bool $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
    712  * @param int|bool $tab_index The tabindex attribute to add. Default 0.
    713  * @param int|bool $multi     Optional. Whether the additional fields and buttons should be added.
     710 * @param int $edit      Accepts 1|true for editing the date, 0|false for adding the date.
     711 * @param int $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
     712 * @param int $tab_index The tabindex attribute to add. Default 0.
     713 * @param int $multi     Optional. Whether the additional fields and buttons should be added.
    714714 *                            Default 0|false.
    715715 */
    … …  
    814814 * @param int $level   Optional. Page depth level. Default 0.
    815815 *
    816  * @return void|bool Boolean False if page has no children, otherwise print out html elements
     816 * @return null|false Boolean False if page has no children, otherwise print out html elements
    817817 */
    818818function parent_dropdown( $default = 0, $parent = 0, $level = 0 ) {
    … …  
    993993 * @since 2.5.0
    994994 *
    995  * @param string|object $screen Screen identifier
     995 * @staticvar bool $already_sorted
     996 * @param string|WP_Screen $screen Screen identifier
    996997 * @param string $context box context
    997998 * @param mixed $object gets passed to the box callback function as first parameter

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

    r29856 r30680  
    139139 *
    140140 * @param WP_Theme $theme WP_Theme object.
    141  * @return string|bool HTML for the update link, or false if invalid info was passed.
     141 * @return false|string HTML for the update link, or false if invalid info was passed.
    142142 */
    143143function get_theme_update_available( $theme ) {

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

    r30202 r30680  
    3131 * @param string $user_email User's email.
    3232 * @param bool $public Whether blog is public.
    33  * @param null $deprecated Optional. Not used.
     33 * @param string $deprecated Optional. Not used.
    3434 * @param string $user_password Optional. User's chosen password. Will default to a random password.
    3535 * @param string $language Optional. Language chosen.
    … …  
    15331533 * @since 1.2.0
    15341534 *
    1535  * @return array List of options.
     1535 * @return stdClass List of options.
    15361536 */
    15371537function get_alloptions_110() {
    … …  
    19761976 * @param string $theme_name
    19771977 * @param string $template
    1978  * @return bool|null
     1978 * @return null|false
    19791979 */
    19801980function make_site_theme_from_default($theme_name, $template) {
    … …  
    20402040 * @since 1.5.0
    20412041 *
    2042  * @return string|bool
     2042 * @return false|string
    20432043 */
    20442044function make_site_theme() {
Note: See TracChangeset for help on using the changeset viewer.