WordPress.org

Make WordPress Core

Changeset 36382


Ignore:
Timestamp:
01/22/2016 08:21:40 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: List out possible values for the $show parameter in the description for get_bloginfo().

Fixes #35581.

File:
1 edited

Legend:

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

    r36380 r36382  
    601601
    602602/**
    603  * Retrieve information about the blog.
    604  *
    605  * Some show parameter values are deprecated and will be removed in future
    606  * versions. These options will trigger the {@see _deprecated_argument()}
    607  * function. The deprecated blog info options are listed in the function
    608  * contents.
    609  *
    610  * The possible values for the 'show' parameter are listed below.
    611  *
    612  * 1. url - Blog URI to homepage.
    613  * 2. wpurl - Blog URI path to WordPress.
    614  * 3. description - Secondary title
    615  *
    616  * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
    617  * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
    618  * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
    619  * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
     603 * Retrieves information about the current site.
     604 *
     605 * Possible values for `$show` include:
     606 *
     607 * - 'name' - Site title (set in Settings > General)
     608 * - 'description' - Site tagline (set in Settings > General)
     609 * - 'wpurl' - The WordPress address (URL) (set in Settings > General)
     610 * - 'url' - The Site address (URL) (set in Settings > General)
     611 * - 'admin_email' - Admin email (set in Settings > General)
     612 * - 'charset' - The "Encoding for pages and feeds"  (set in Settings > Reading)
     613 * - 'version' - The current WordPress version
     614 * - 'html_type' - The content-type (default: "text/html"). Themes and plugins
     615 *   can override the default value using the {@see 'pre_option_html_type'} filter
     616 * - 'text_direction' - The text direction determined by the site's language. is_rtl()
     617 *   should be used instead
     618 * - 'language' - Language code for the current site
     619 * - 'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme
     620 *   will take precedence over this value
     621 * - 'stylesheet_directory' - Directory path for the active theme.  An active child theme
     622 *   will take precedence over this value
     623 * - 'template_url' / 'template_directory' - URL of the active theme's directory. An active
     624 *   child theme will NOT take precedence over this value
     625 * - 'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php)
     626 * - 'atom_url' - The Atom feed URL (/feed/atom)
     627 * - 'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rfd)
     628 * - 'rss_url' - The RSS 0.92 feed URL (/feed/rss)
     629 * - 'rss2_url' - The RSS 2.0 feed URL (/feed)
     630 * - 'comments_atom_url' - The comments Atom feed URL (/comments/feed)
     631 * - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed)
     632 *
     633 * Some `$show` values are deprecated and will be removed in future versions.
     634 * These options will trigger the _deprecated_argument() function.
     635 *
     636 * Deprecated arguments include:
     637 *
     638 * - 'siteurl' - Use 'url' instead
     639 * - 'home' - Use 'url' instead
    620640 *
    621641 * @since 0.71
     
    623643 * @global string $wp_version
    624644 *
    625  * @param string $show   Blog info to retrieve.
    626  * @param string $filter How to filter what is retrieved.
     645 * @param string $show   Optional. Site info to retrieve. Default empty (site name).
     646 * @param string $filter Optional. How to filter what is retrieved. Default 'raw'.
    627647 * @return string Mostly string values, might be empty.
    628648 */
Note: See TracChangeset for help on using the changeset viewer.