Make WordPress Core


Ignore:
Timestamp:
12/12/2015 03:36:36 PM (8 years ago)
Author:
swissspidy
Message:

Docs: Fix some minor DocBlock alignment issues.

See #32246.

File:
1 edited

Legend:

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

    r35704 r35885  
    686686 * @param int    $post_id   Optional post ID. Default to current post.
    687687 * @param string $feed      Optional. Feed format.
    688 */
     688 */
    689689function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
    690690    $url = get_post_comments_feed_link( $post_id, $feed );
     
    717717 * @param string $feed      Optional. Feed type.
    718718 * @return string Link to the feed for the author specified by $author_id.
    719 */
     719 */
    720720function get_author_feed_link( $author_id, $feed = '' ) {
    721721    $author_id = (int) $author_id;
     
    761761 * @param string $feed   Optional. Feed type.
    762762 * @return string Link to the feed for the category specified by $cat_id.
    763 */
     763 */
    764764function get_category_feed_link( $cat_id, $feed = '' ) {
    765765    return get_term_feed_link( $cat_id, 'category', $feed );
     
    778778 * @param string $feed     Optional. Feed type.
    779779 * @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
    780 */
     780 */
    781781function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
    782782    $term_id = ( int ) $term_id;
     
    27202720 * @param string|array $args Optional args. See paginate_links().
    27212721 * @return string|void Markup for pagination links.
    2722 */
     2722 */
    27232723function paginate_comments_links($args = array()) {
    27242724    global $wp_rewrite;
     
    29252925 *                             'http', 'https', 'relative', 'rest', or null. Default null.
    29262926 * @return string Home url link with optional path appended.
    2927 */
     2927 */
    29282928function home_url( $path = '', $scheme = null ) {
    29292929    return get_home_url( null, $path, $scheme );
     
    29472947 *                                  'http', 'https', 'relative', 'rest', or null. Default null.
    29482948 * @return string Home URL link with optional path appended.
    2949 */
     2949 */
    29502950function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
    29512951    global $pagenow;
     
    29992999 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
    30003000 * @return string Site url link with optional path appended.
    3001 */
     3001 */
    30023002function site_url( $path = '', $scheme = null ) {
    30033003    return get_site_url( null, $path, $scheme );
     
    30193019 *                        'relative'. Default null.
    30203020 * @return string Site url link with optional path appended.
    3021 */
     3021 */
    30223022function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
    30233023    if ( empty( $blog_id ) || !is_multisite() ) {
     
    30563056 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    30573057 * @return string Admin url link with optional path appended.
    3058 */
     3058 */
    30593059function admin_url( $path = '', $scheme = 'admin' ) {
    30603060    return get_admin_url( null, $path, $scheme );
     
    30723072 *                        {@see force_ssl_admin()} and {@see is_ssl()}.
    30733073 * @return string Admin url link with optional path appended.
    3074 */
     3074 */
    30753075function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
    30763076    $url = get_site_url($blog_id, 'wp-admin/', $scheme);
     
    30993099 * @param string $scheme Optional. Scheme to give the includes url context.
    31003100 * @return string Includes url link with optional path appended.
    3101 */
     3101 */
    31023102function includes_url( $path = '', $scheme = null ) {
    31033103    $url = site_url( '/' . WPINC . '/', $scheme );
     
    31253125 * @param string $path Optional. Path relative to the content url.
    31263126 * @return string Content url link with optional path appended.
    3127 */
     3127 */
    31283128function content_url($path = '') {
    31293129    $url = set_url_scheme( WP_CONTENT_URL );
     
    31573157 *                        Typically this is done by passing `__FILE__` as the argument.
    31583158 * @return string Plugins URL link with optional paths appended.
    3159 */
     3159 */
    31603160function plugins_url( $path = '', $plugin = '' ) {
    31613161
     
    32073207 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
    32083208 * @return string Site url link with optional path appended.
    3209 */
     3209 */
    32103210function network_site_url( $path = '', $scheme = null ) {
    32113211    if ( ! is_multisite() )
     
    32493249 *                        'http', 'https', or 'relative'. Default null.
    32503250 * @return string Home url link with optional path appended.
    3251 */
     3251 */
    32523252function network_home_url( $path = '', $scheme = null ) {
    32533253    if ( ! is_multisite() )
     
    32903290 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    32913291 * @return string Admin url link with optional path appended.
    3292 */
     3292 */
    32933293function network_admin_url( $path = '', $scheme = 'admin' ) {
    32943294    if ( ! is_multisite() )
     
    33203320 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    33213321 * @return string Admin url link with optional path appended.
    3322 */
     3322 */
    33233323function user_admin_url( $path = '', $scheme = 'admin' ) {
    33243324    $url = network_site_url('wp-admin/user/', $scheme);
     
    33473347 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    33483348 * @return string Admin url link with optional path appended.
    3349 */
     3349 */
    33503350function self_admin_url($path = '', $scheme = 'admin') {
    33513351    if ( is_network_admin() )
     
    34903490 *
    34913491 * @since 2.9.0
    3492 */
     3492 */
    34933493function rel_canonical() {
    34943494    if ( ! is_singular() ) {
Note: See TracChangeset for help on using the changeset viewer.