Changeset 8333

Timestamp:

07/14/08 23:39:11 (4 months ago)

Author:

ryan

Message:

phpdoc for site_url() and friends

Files:

• trunk/wp-includes/link-template.php (modified) (4 diffs)

trunk/wp-includes/link-template.php

@@ -773 +773 @@
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-function site_url($path = '', $scheme = null) {
-    // should the list of allowed schemes be maintained elsewhere?
@@ -796 +807 @@
-}
-
+/** Return the admin url
+ *
+ *
+ * @package WordPress
+ * @since 2.6
+ *
+ * Returns the url to the admin area
+ *
+ * @param string $path Optional path relative to the admin url
+ * @return string Admin url link with optional path appended
+*/
-function admin_url($path = '') {
-    $url = site_url('wp-admin/', 'admin');
@@ -805 +827 @@
-}
-
+/** Return the includes url
+ *
+ *
+ * @package WordPress
+ * @since 2.6
+ *
+ * Returns the url to the includes directory
+ *
+ * @param string $path Optional path relative to the includes url
+ * @return string Includes url link with optional path appended
+*/
-function includes_url($path = '') {
-    $url = site_url() . '/' . WPINC . '/';
@@ -814 +847 @@
-}
-
+/** Return the content url
+ *
+ *
+ * @package WordPress
+ * @since 2.6
+ *
+ * Returns the url to the content directory
+ *
+ * @param string $path Optional path relative to the content url
+ * @return string Content url link with optional path appended
+*/
-function content_url($path = '') {
-    $scheme = ( is_ssl() ? 'https' : 'http' );