Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Re: Issue #40 lots of phpDoc updates
  • Loading branch information
chipbennett committed Oct 19, 2011
1 parent 727b659 commit 97420ae
Show file tree
Hide file tree
Showing 30 changed files with 227 additions and 340 deletions.
4 changes: 3 additions & 1 deletion 404.php
Expand Up @@ -5,6 +5,8 @@
* This file is the Error 404 Page template file, which is output whenever
* the server encounters a "404 - file not found" error.
*
* @uses oenology_hook_post_404() Defined in /functions/hooks.php
*
* @link http://codex.wordpress.org/Function_Reference/get_header get_header()
* @link http://codex.wordpress.org/Function_Reference/get_footer get_footer()
* @link http://codex.wordpress.org/Function_Reference/get_sidebar get_sidebar()
Expand Down Expand Up @@ -85,7 +87,7 @@
* via "sidebar.php", or in the Error 404 Page context only, via
* "sidebar-404.php"
*/
get_sidebar( oenology_get_context() );
get_sidebar( '404' );
?>

<?php
Expand Down
13 changes: 8 additions & 5 deletions footer.php
Expand Up @@ -13,11 +13,14 @@
* template part file on static Pages, a Child Theme would
* include the file "footer-page.php".
*
* @uses oenology_hook_extent_after()
* @uses oenology_hook_site_footer()
* @uses oenology_hook_site_footer_after()
* @uses oenology_hook_site_footer_before()
* @uses wp_footer()
* @uses oenology_hook_extent_after() Defined in /functions/hooks.php
* @uses oenology_hook_site_footer() Defined in /functions/hooks.php
* @uses oenology_hook_site_footer_after() Defined in /functions/hooks.php
* @uses oenology_hook_site_footer_before() Defined in /functions/hooks.php
*
* @link http://codex.wordpress.org/Function_Reference/has_nav_menu has_nav_menu()
* @link http://codex.wordpress.org/Function_Reference/wp_footer wp_footer()
* @link http://codex.wordpress.org/Function_Reference/wp_nav_menu wp_nav_menu()
*
* @package Oenology
* @copyright Copyright (c) 2010, Chip Bennett
Expand Down
6 changes: 4 additions & 2 deletions header.php
Expand Up @@ -14,8 +14,10 @@
* template part file on static Pages, a Child Theme would
* include the file "header-page.php".
*
* @uses oenology_get_context()
* @uses oenology_hook_extent_before()
* @uses oenology_get_context() Defined in /functions/custom.php
* @uses oenology_get_options() Defined in /functions/options.php
* @uses oenology_hook_extent_before() Defined in /functions/hooks.php
*
* @link http://codex.wordpress.org/Function_Reference/bloginfo bloginfo()
* @link http://codex.wordpress.org/Function_Reference/body_class body_class()
* @link http://codex.wordpress.org/Function_Reference/get_option get_option()
Expand Down
2 changes: 1 addition & 1 deletion index.php
Expand Up @@ -5,7 +5,7 @@
* This file is the master/default template file, used when no other file matches in
* the {@link http://codex.wordpress.org/Template_Hierarchy Template Hierarchy}.
*
* @uses oenology_get_context()
* @uses oenology_get_context() Defined in /functions/custom.php
*
* @link http://codex.wordpress.org/Function_Reference/get_header get_header()
* @link http://codex.wordpress.org/Function_Reference/get_footer get_footer()
Expand Down
110 changes: 11 additions & 99 deletions infobar.php
Expand Up @@ -4,15 +4,16 @@
*
* Includes the navigation breadcrumb, Login/Admin links, and search form.
*
* @uses function_exists()
* @uses yoast_breadcrumb()
* @uses oenology_breadcrumb()
* @uses oenology_infobar_navigation()
* @uses is_user_logged_in()
* @uses wp_get_current_user()
* @uses wp_register()
* @uses wp_loginout()
* @uses get_search_form()
* @uses oenology_breadcrumb() Defined in /functions/custom.php
* @uses oenology_infobar_navigation() Defined in /functions/custom.php
*
* @link function_exists()
* @link yoast_breadcrumb()
* @link is_user_logged_in()
* @link wp_get_current_user()
* @link wp_register()
* @link wp_loginout()
* @link get_search_form()
*
* @package Oenology
* @copyright Copyright (c) 2010, Chip Bennett
Expand Down Expand Up @@ -80,93 +81,4 @@ function_exists('yoast_breadcrumb')
get_search_form();
?>
</li>
</ul>
<?php
/*
Reference:
=============================================================================
The following functions, tags, and hooks are used (or referenced) in this Theme template file:
***********************
get_search_form()
----------------------------------
get_search_form() is a WordPress function.
Codex reference: http://codex.wordpress.org/Function_Reference/get_search_form
get_search_form() is used to display the search form. If the Theme includes a
searchform.php template file, it will be used. Otherwise, the built-in search form
will be used.
get_search_form() accepts no arguments.
***********************
is_user_logged_in()
----------------------------------
is_user_logged_in() is a WordPress conditional tag.
Codex reference: http://codex.wordpress.org/Function_Reference/is_user_logged_in
is_user_logged_in() is a boolean (returns TRUE or FALSE) conditional tag that returns
true if the current user is logged in; otherwise it returns false.
is_user_logged_in() accepts no arguments.
***********************
oenology_breadcrumb()
----------------------------------
oenology_breadcrumb() is a custom Theme function.
Codex reference: N/A
Defined in: functions.php
oenology_breadcrumb() is used to output breadcrumb links.
oenology_breadcrumb() outputs a home link, followed by appropriate breadcrumb links,
including categories (hierarchical), tags, search query, etc.
oenology_breadcrumb() accepts no arguments.
***********************
wp_get_current_user()
----------------------------------
wp_get_current_user() is a WordPress function.
Codex reference: http://codex.wordpress.org/Function_Reference/wp_get_current_user
wp_get_current_user() is used to retrieve the information contained in the
$current_user global variable.
wp_get_current_user() accepts no arguments.
Example:
wp_get_current_user();
echo $current_user->display_name; will display e.g. "John Smith"
***********************
wp_loginout()
----------------------------------
wp_loginout() is a WordPress function.
Codex reference: http://codex.wordpress.org/Function_Reference/wp_loginout
wp_loginout() displays a login link if user is logged out, or a logout link if user is logged in.
wp_loginout() accepts 1 argument:
- $redirect: redirect location after login/out. Defaults to no redirect (current location)
***********************
wp_register()
----------------------------------
wp_register() is a WordPress function.
Codex reference: http://codex.wordpress.org/Function_Reference/wp_register
wp_register() displays a registration link if user is logged out and user registration is
permitted; otherwise, displays a link to site admin (Dashboard) if user is logged in.
wp_register() accepts 3 arguments:
- $before: string to display before link. Defaults to '<li>'
- $after: string to display after link. Defaults to '</li>'
- $echo: return result boolean (true/false). Defaults to 'true'
Example:
<?php wp_register( '' , '' ); ?> returns the Registration or Site Admin link, without wrapping
in <li></li> tags.
=============================================================================
*/ ?>
</ul>

0 comments on commit 97420ae

Please sign in to comment.