Make WordPress Core


Ignore:
Timestamp:
07/14/2008 11:39:11 PM (17 years ago)
Author:
ryan
Message:

phpdoc for site_url() and friends

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/link-template.php

    r8323 r8333  
    773773}
    774774
    775 // return the site_url option, using https if is_ssl() is true
    776 // if $scheme is 'http' or 'https' it will override is_ssl()
     775/** Return the site url
     776 *
     777 *
     778 * @package WordPress
     779 * @since 2.6
     780 *
     781 * Returns the 'site_url' option with the appropriate protocol,  'https' if is_ssl() and 'http' otherwise.
     782 * If $scheme is 'http' or 'https', is_ssl() is overridden.
     783 *
     784 * @param string $path Optional path relative to the site url
     785 * @param string $scheme Optional scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'
     786 * @return string Site url link with optional path appended
     787*/
    777788function site_url($path = '', $scheme = null) {
    778789    // should the list of allowed schemes be maintained elsewhere?
     
    796807}
    797808
     809/** Return the admin url
     810 *
     811 *
     812 * @package WordPress
     813 * @since 2.6
     814 *
     815 * Returns the url to the admin area
     816 *
     817 * @param string $path Optional path relative to the admin url
     818 * @return string Admin url link with optional path appended
     819*/
    798820function admin_url($path = '') {
    799821    $url = site_url('wp-admin/', 'admin');
     
    805827}
    806828
     829/** Return the includes url
     830 *
     831 *
     832 * @package WordPress
     833 * @since 2.6
     834 *
     835 * Returns the url to the includes directory
     836 *
     837 * @param string $path Optional path relative to the includes url
     838 * @return string Includes url link with optional path appended
     839*/
    807840function includes_url($path = '') {
    808841    $url = site_url() . '/' . WPINC . '/';
     
    814847}
    815848
     849/** Return the content url
     850 *
     851 *
     852 * @package WordPress
     853 * @since 2.6
     854 *
     855 * Returns the url to the content directory
     856 *
     857 * @param string $path Optional path relative to the content url
     858 * @return string Content url link with optional path appended
     859*/
    816860function content_url($path = '') {
    817861    $scheme = ( is_ssl() ? 'https' : 'http' );
Note: See TracChangeset for help on using the changeset viewer.