WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

phpdoc cleanups for general-template.php. Props c3mdigital, SergeyBiryukov. fixes #21893 

git-svn-id: http://core.svn.wordpress.org/trunk@21926 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Ryan Boren 2012-09-20 13:52:36 +00:00
parent 9e9d4ebd50
commit d422b1e475
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
wp-includes/general-template.php
View File

@ -147,6 +147,7 @@ function get_template_part( $slug, $name = null ) {
* *
* @since 2.7.0 * @since 2.7.0
* @param boolean $echo Default to echo and not return the form. * @param boolean $echo Default to echo and not return the form.
* @return string|null String when retrieving, null when displaying or if searchform.php exists.
*/ */
function get_search_form($echo = true) { function get_search_form($echo = true) {
do_action( 'get_search_form' ); do_action( 'get_search_form' );
@ -181,6 +182,7 @@ function get_search_form($echo = true) {
* *
* @param string $redirect Optional path to redirect to on login/logout. * @param string $redirect Optional path to redirect to on login/logout.
* @param boolean $echo Default to echo and not return the link. * @param boolean $echo Default to echo and not return the link.
* @return string|null String when retrieving, null when displaying.
*/ */
function wp_loginout($redirect = '', $echo = true) { function wp_loginout($redirect = '', $echo = true) {
if ( ! is_user_logged_in() ) if ( ! is_user_logged_in() )
@ -205,6 +207,7 @@ function wp_loginout($redirect = '', $echo = true) {
* @uses apply_filters() calls 'logout_url' hook on final logout url * @uses apply_filters() calls 'logout_url' hook on final logout url
* *
* @param string $redirect Path to redirect to on logout. * @param string $redirect Path to redirect to on logout.
* @return string A log out URL.
*/ */
function wp_logout_url($redirect = '') { function wp_logout_url($redirect = '') {
$args = array( 'action' => 'logout' ); $args = array( 'action' => 'logout' );
@ -229,7 +232,7 @@ function wp_logout_url($redirect = '') {
* *
* @param string $redirect Path to redirect to on login. * @param string $redirect Path to redirect to on login.
* @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false. * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
* @return string A log in url * @return string A log in URL.
*/ */
function wp_login_url($redirect = '', $force_reauth = false) { function wp_login_url($redirect = '', $force_reauth = false) {
$login_url = site_url('wp-login.php', 'login'); $login_url = site_url('wp-login.php', 'login');
@ -248,8 +251,8 @@ function wp_login_url($redirect = '', $force_reauth = false) {
* the HTML immediately. Pass array('echo'=>false) to return the string instead. * the HTML immediately. Pass array('echo'=>false) to return the string instead.
* *
* @since 3.0.0 * @since 3.0.0
* @param array $args Configuration options to modify the form output * @param array $args Configuration options to modify the form output.
* @return Void, or string containing the form * @return string|null String when retrieving, null when displaying.
*/ */
function wp_login_form( $args = array() ) { function wp_login_form( $args = array() ) {
$defaults = array( 'echo' => true, $defaults = array( 'echo' => true,
@ -305,6 +308,7 @@ function wp_login_form( $args = array() ) {
* @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url * @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url
* *
* @param string $redirect Path to redirect to on login. * @param string $redirect Path to redirect to on login.
* @return string Lost password URL.
*/ */
function wp_lostpassword_url( $redirect = '' ) { function wp_lostpassword_url( $redirect = '' ) {
$args = array( 'action' => 'lostpassword' ); $args = array( 'action' => 'lostpassword' );
@ -328,6 +332,7 @@ function wp_lostpassword_url( $redirect = '' ) {
* @param string $before Text to output before the link (defaults to <li>). * @param string $before Text to output before the link (defaults to <li>).
* @param string $after Text to output after the link (defaults to </li>). * @param string $after Text to output after the link (defaults to </li>).
* @param boolean $echo Default to echo and not return the link. * @param boolean $echo Default to echo and not return the link.
* @return string|null String when retrieving, null when displaying.
*/ */
function wp_register( $before = '<li>', $after = '</li>', $echo = true ) { function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
@ -861,6 +866,7 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
* @since 1.2.0 * @since 1.2.0
* *
* @param string|array $args Optional. Override defaults. * @param string|array $args Optional. Override defaults.
* @return string|null String when retrieving, null when displaying.
*/ */
function wp_get_archives($args = '') { function wp_get_archives($args = '') {
global $wpdb, $wp_locale; global $wpdb, $wp_locale;
@ -1062,6 +1068,7 @@ function calendar_week_mod($num) {
* *
* @param bool $initial Optional, default is true. Use initial calendar names. * @param bool $initial Optional, default is true. Use initial calendar names.
* @param bool $echo Optional, default is true. Set to false for return. * @param bool $echo Optional, default is true. Set to false for return.
* @return string|null String when retrieving, null when displaying.
*/ */
function get_calendar($initial = true, $echo = true) { function get_calendar($initial = true, $echo = true) {
global $wpdb, $m, $monthnum, $year, $wp_locale, $posts; global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
@ -2255,8 +2262,8 @@ function disabled( $disabled, $current = true, $echo = true ) {
* @since 2.8.0 * @since 2.8.0
* @access private * @access private
* *
* @param any $helper One of the values to compare * @param mixed $helper One of the values to compare
* @param any $current (true) The other value to compare if not just true * @param mixed $current (true) The other value to compare if not just true
* @param bool $echo Whether to echo or just return the string * @param bool $echo Whether to echo or just return the string
* @param string $type The type of checked|selected|disabled we are doing * @param string $type The type of checked|selected|disabled we are doing
* @return string html attribute or empty string * @return string html attribute or empty string