Changeset 8092

Timestamp:

06/15/08 09:38:32 (5 months ago)

Author:

westi

Message:

PHPDoc updates for functions.php. See #5639 props jacobsantos.

Files:

• trunk/wp-includes/functions.php (modified) (37 diffs)

trunk/wp-includes/functions.php

@@ -1 +1 @@
-<?php
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function mysql2date( $dateformatstring, $mysqlstring, $translate = true ) {
-    global $wp_locale;
@@ -52 +74 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function current_time( $type, $gmt = 0 ) {
-    switch ( $type ) {
@@ -89 +125 @@
-}
-
-
+
+
+
+
+
+
+
+
+
-function number_format_i18n( $number, $decimals = null ) {
-    global $wp_locale;
@@ -98 +142 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function size_format( $bytes, $decimals = null ) {
-    // technically the correct unit names for powers of 1024 are KiB, MiB etc
-    // see http://en.wikipedia.org/wiki/Byte
-    $quant = array(
-        // ========================= Origin ====
@@ -145 +207 @@
-}
-
-
+
+
+
+
+
+
+
+
-function maybe_unserialize( $original ) {
-    if ( is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
@@ -153 +222 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function is_serialized( $data ) {
-    // if it isn't a string, it isn't serialized
@@ -180 +259 @@
-}
-
-
+
+
+
+
+
+
+
+
-function is_serialized_string( $data ) {
-    // if it isn't a string, it isn't a serialized string
@@ -191 +277 @@
-}
-
-
-/* Options functions */
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function get_option( $setting ) {
-    global $wpdb;
@@ -244 +340 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function wp_protect_special_option( $option ) {
-    $protected = array( 'alloptions', 'notoptions' );
@@ -251 +357 @@
-}
-
+/**
+ * Print option value after sanitizing for forms.
+ *
+ * @uses attribute_escape Sanitizes value.
+ * @since 1.5.0
+ * @package WordPress
+ * @subpackage Option
+ *
+ * @param string $option Option name.
+ */
-function form_option( $option ) {
-    echo attribute_escape (get_option( $option ) );
@@ -537 +653 @@
-}
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_get_http( $url, $file_path = false, $red = 1 ) {
-    global $wp_version;
@@ -611 +737 @@
-}
-
+/**
+ * Retrieve HTTP Headers from URL.
+ *
+ * @since 1.5.1
+ *
+ * @param string $url
+ * @param int $red Optional. Number of redirects.
+ * @return bool|string False on failure, headers on success.
+ */
-function wp_get_http_headers( $url, $red = 1 ) {
-    return wp_get_http( $url, false, $red );
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function is_new_day() {
-    global $day, $previousday;
@@ -629 +774 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function add_query_arg() {
-    $ret = '';
@@ -705 +855 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    if ( is_array( $key ) ) { // removing multiple keys
-        foreach ( (array) $key as $k )
-FALSE
+false
-        return $query;
-    }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-function add_magic_quotes( $array ) {
-    global $wpdb;
@@ -783 +938 @@
-}
-
-
+
+
+
+
+
+
+
+
-function get_status_header_desc( $code ) {
-    global $wp_header_to_desc;
@@ -863 +1025 @@
-}
-
-
+
+
+
+
+
+
+
+
-function nocache_headers() {
-    // why are these @-silenced when other header calls aren't?
@@ -872 +1041 @@
-}
-
-
+
+
+
+
+
-function cache_javascript_headers() {
-    $expiresOffset = 864000; // 10 days
@@ -880 +1053 @@
-}
-
-
+
+
+
+
+
+
+
-function get_num_queries() {
-    global $wpdb;
@@ -886 +1065 @@
-}
-
-
+
+
+
+
+
+
+
+
-function bool_from_yn( $yn ) {
-    return ( strtolower( $yn ) == 'y' );
@@ -912 +1098 @@
-}
-
-
+
+
+
+
+
-function do_feed_rdf() {
-    load_template( ABSPATH . WPINC . '/feed-rdf.php' );
-}
-
-
+
+
+
+
+
-function do_feed_rss() {
-    load_template( ABSPATH . WPINC . '/feed-rss.php' );
-}
-
-
+
+
+
+
+
+
+
-function do_feed_rss2( $for_comments ) {
-    if ( $for_comments )
@@ -930 +1130 @@
-}
-
-
+
+
+
+
+
+
+
-function do_feed_atom( $for_comments ) {
-    if ($for_comments)
@@ -938 +1144 @@
-}
-
+/**
+ * Display the robot.txt file content.
+ *
+ * The echo content should be with usage of the permalinks or for creating the
+ * robot.txt file.
+ *
+ * @since 2.1.0
+ * @uses do_action() Calls 'do_robotstxt' hook for displaying robot.txt rules.
+ */
-function do_robots() {
-    header( 'Content-Type: text/plain; charset=utf-8' );
@@ -1512 +1727 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_parse_args( $args, $defaults = '' ) {
-    if ( is_object( $args ) )
@@ -1526 +1752 @@
-}
-
-
+
+
+
+
+
+
+
+
+
-function wp_maybe_load_widgets() {
-    if ( !function_exists( 'dynamic_sidebar' ) ) {
@@ -1534 +1768 @@
-}
-
-
+
+
+
+
+
+
-function wp_widgets_add_menu() {
-    global $submenu;
@@ -1541 +1780 @@
-}
-
-
-
-
+
+
+
+
+
+
+
-function wp_ob_end_flush_all() {
-    while ( @ob_end_flush() );
@@ -1549 +1792 @@
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
- */
-function require_wp_db() {
@@ -1565 +1810 @@
-}
-
+
+/**
+ * Load custom DB error or display WordPress DB error.
+ *
+ * If a file exists in the wp-content directory named db-error.php, then it will
+ * be loaded instead of displaying the WordPress DB error. If it is not found,
+ * then the WordPress DB error will be displayed instead.
+ *
+ * The WordPress DB error sets the HTTP status header to 500 to try to prevent
+ * search engines from caching the message. Custom DB messages should do the
+ * same.
+ *
+ * @since 2.5
+ * @uses $wpdb
+ */
-function dead_db() {
-    global $wpdb;
@@ -1598 +1858 @@
-}
-
-
-
+
+
+
+
+
+
- * @param mixed $maybeint data you wish to have convered to an absolute integer
- * @return int an absolute integer
@@ -1607 +1871 @@
-}
-
-
-
-
+
+
+
+
+
+
+
+
+
+
- */
-function url_is_accessable_via_ssl($url)
@@ -1634 +1905 @@
-}
-
+
+/**
+ * Secure URL, if available or the given URL.
+ *
+ * @since 2.5
+ *
+ * @param string $url Complete URL path with transport.
+ * @return string Secure or regular URL path.
+ */
-function atom_service_url_filter($url)
-{
-    if ( url_is_accessable_via_ssl($url) )
- 
+
-    else
-        return $url;
-}
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
- *
- * This function is to be used in every function in depreceated.php
@@ -1677 +1960 @@
-}
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
- *
- * This function is to be used in every file that is depreceated
@@ -1712 +1998 @@
-}
-
-
-
+
+
+
+
+
- *
- * @return bool Whether the server is running lighttpd < 1.5.0
@@ -1723 +2012 @@
-}
-
-
-
+
+
+
+
+
- *
- * @param string $mod e.g. mod_rewrite
@@ -1750 +2042 @@
-}
-
+
+/**
+ * File validates against allowed set of defined rules.
+ *
+ * A return value of '1' means that the $file contains either '..' or './'. A
+ * return value of '2' means that the $file contains ':' after the first
+ * character. A return value of '3' means that the file is not in the allowed
+ * files list.
+ *
+ * @since 2.6
+ *
+ * @param string $file File path.
+ * @param array $allowed_files List of allowed files.
+ * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
+ */
-function validate_file( $file, $allowed_files = '' ) {
-    if ( false !== strpos( $file, '..' ))
@@ -1766 +2073 @@
-}
-
+
+/**
+ * Determine if SSL is used.
+ *
+ * @since 2.6
+ *
+ * @return bool True if SSL, false if not used.
+ */
-function is_ssl() {
-    return ( 'on' == strtolower($_SERVER['HTTPS']) ) ? true : false; 
-}
-
+
+/**
+ * Whether SSL login should be forced.
+ *
+ * @since 2.6
+ *
+ * @param string|bool $force Optional.
+ * @return bool True if forced, false if not forced.
+ */
-function force_ssl_login($force = '') {
-    static $forced;
@@ -1782 +2106 @@
-}
-
+
+/**
+ * Whether to force SSL used for the Administration Panels.
+ *
+ * @since 2.6
+ *
+ * @param string|bool $force
+ * @return bool True if forced, false if not forced.
+ */
-function force_ssl_admin($force = '') {
-    static $forced;