WordPress.org

Make WordPress Core

Changeset 32595


Ignore:
Timestamp:
05/25/2015 04:10:59 PM (6 years ago)
Author:
wonderboymusic
Message:

Add missing doc blocks to wp-includes/functions.php.

See #32444.

File:
1 edited

Legend:

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

    r32513 r32595  
    7878 *
    7979 * @since 0.71
     80 *
     81 * @global WP_Locale $wp_locale
    8082 *
    8183 * @param string   $dateformatstring Format to display the date.
     
    161163 *
    162164 * @since 2.3.0
     165 *
     166 * @global WP_Locale $wp_locale
    163167 *
    164168 * @param int $number   The number to convert based on locale.
     
    492496 * @since 1.5.0
    493497 *
    494  * @see $wpdb
     498 * @global wpdb $wpdb
    495499 *
    496500 * @param string $content Post Content.
    497  * @param int $post_ID Post ID.
     501 * @param int    $post_ID Post ID.
    498502 */
    499503function do_enclose( $content, $post_ID ) {
     
    872876 * @since 2.0.0
    873877 *
     878 * @global WP       $wp_locale
     879 * @global WP_Query $wp_query
     880 * @global WP_Query $wp_the_query
     881 *
    874882 * @param string|array $query_vars Default WP_Query arguments.
    875883 */
     
    886894 *
    887895 * @since 2.3.0
     896 *
     897 * @global array $wp_header_to_desc
    888898 *
    889899 * @param int $code HTTP status code.
     
    11261136 * @since 2.1.0
    11271137 *
    1128  * @uses $wp_query Used to tell if the use a comment feed.
     1138 * @global WP_Query $wp_query Used to tell if the use a comment feed.
    11291139 */
    11301140function do_feed() {
     
    16071617 * @since 2.5.0
    16081618 *
     1619 * @staticvar string $temp
     1620 *
    16091621 * @return string Writable temporary directory.
    16101622 */
     
    16311643        return $temp;
    16321644
    1633     $temp = '/tmp/';
    1634     return $temp;
     1645    return '/tmp/';
    16351646}
    16361647
     
    20022013 *
    20032014 * @param string $ext The extension to search.
    2004  * @return string|null The file type, example: audio, video, document, spreadsheet, etc.
    2005  *                     Null if not found.
     2015 * @return string|void The file type, example: audio, video, document, spreadsheet, etc.
    20062016 */
    20072017function wp_ext2type( $ext ) {
     
    20332043        if ( in_array( $ext, $exts ) )
    20342044            return $type;
    2035 
    2036     return null;
    20372045}
    20382046
     
    20862094 */
    20872095function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
    2088 
    20892096    $proper_filename = false;
    20902097
     
    25952602 * @access private
    25962603 *
     2604 * @global wp_xmlrpc_server $wp_xmlrpc_server
     2605 *
    25972606 * @param string       $message Error message.
    25982607 * @param string       $title   Optional. Error title. Default empty.
     
    26532662 * @param int   $depth   Optional. Maximum depth to walk through $data. Must be
    26542663 *                       greater than 0. Default 512.
    2655  * @return bool|string The JSON encoded string, or false if it cannot be encoded.
     2664 * @return string|false The JSON encoded string, or false if it cannot be encoded.
    26562665 */
    26572666function wp_json_encode( $data, $options = 0, $depth = 512 ) {
     
    27582767 *
    27592768 * @see _wp_json_sanity_check()
     2769 *
     2770 * @staticvar bool $use_mb
    27602771 *
    27612772 * @param string $string The string which is to be converted.
     
    32613272 *
    32623273 * @since 2.2.0
     3274 *
     3275 * @global array $submenu
    32633276 */
    32643277function wp_widgets_add_menu() {
     
    35873600 * @since 2.5.0
    35883601 *
     3602 * @global bool $is_apache
     3603 *
    35893604 * @param string $mod     The module, e.g. mod_rewrite.
    35903605 * @param bool   $default Optional. The default return value if the module is not found. Default false.
     
    36153630 *
    36163631 * @since 2.8.0
     3632 *
     3633 * @global bool $is_iis7
    36173634 *
    36183635 * @return bool Whether IIS7 supports permalinks.
     
    36563673 *
    36573674 * @param string $file File path.
    3658  * @param array $allowed_files List of allowed files.
     3675 * @param array  $allowed_files List of allowed files.
    36593676 * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
    36603677 */
     
    37123729 *
    37133730 * @since 2.6.0
     3731 *
     3732 * @staticvar bool $forced
    37143733 *
    37153734 * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
     
    37893808 * @since 3.3.0
    37903809 *
     3810 * @staticvar bool $_suspend
     3811 *
    37913812 * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
    37923813 * @return bool The current suspend setting
     
    38103831 * @since 2.7.0
    38113832 *
     3833 * @global bool $_wp_suspend_cache_invalidation
     3834 *
    38123835 * @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true.
    38133836 * @return bool The current suspend setting.
     
    38253848 *
    38263849 * @since 3.0.0
     3850 *
     3851 * @global object $current_site
    38273852 *
    38283853 * @param int $site_id Optional. Site ID to test. Defaults to current site.
     
    38493874 * @since 3.7.0
    38503875 *
     3876 * @global wpdb $wpdb
     3877 *
    38513878 * @param int $network_id Optional. Network ID to test. Defaults to current network.
    38523879 * @return bool True if $network_id is the main network, or if not running Multisite.
     
    38853912 *
    38863913 * @since 3.0.0
     3914 *
     3915 * @staticvar bool $global_terms
    38873916 *
    38883917 * @return bool True if multisite and global terms enabled.
     
    39213950 * @since 2.8.0
    39223951 *
    3923  * @return float|bool Timezone GMT offset, false otherwise.
     3952 * @return float|false Timezone GMT offset, false otherwise.
    39243953 */
    39253954function wp_timezone_override_offset() {
     
    39884017 *
    39894018 * @since 2.9.0
     4019 *
     4020 * @staticvar bool $mo_loaded
    39904021 *
    39914022 * @param string $selected_zone Selected timezone.
     
    41354166 *
    41364167 * @since 2.9.0
     4168 *
     4169 * @global wpdb $wpdb
    41374170 */
    41384171function wp_scheduled_delete() {
     
    42454278 * @see __return_false()
    42464279 *
    4247  * @return bool True.
     4280 * @return true True.
    42484281 */
    42494282function __return_true() {
     
    42604293 * @see __return_true()
    42614294 *
    4262  * @return bool False.
     4295 * @return false False.
    42634296 */
    42644297function __return_false() {
     
    44464479 * @see esc_url()
    44474480 *
     4481 * @staticvar array $protocols
     4482 *
    44484483 * @return array Array of allowed protocols.
    44494484 */
     
    46964731 * @since 3.6.0
    46974732 *
    4698  * @param array|object $response  The Heartbeat response object or array.
    4699  * @return array|object $response The Heartbeat response object or array with 'wp-auth-check'
    4700  *                                value set.
     4733 * @global int $login_grace_period
     4734 *
     4735 * @param array $response  The Heartbeat response.
     4736 * @return array $response The Heartbeat response with 'wp-auth-check' value set.
    47014737 */
    47024738function wp_auth_check( $response ) {
     
    47704806 *
    47714807 * @see reset_mbstring_encoding()
     4808 *
     4809 * @staticvar array $encodings
     4810 * @staticvar bool  $overloaded
    47724811 *
    47734812 * @param bool $reset Optional. Whether to reset the encoding back to a previously-set encoding.
Note: See TracChangeset for help on using the changeset viewer.