WordPress.org

Making WordPress.org

Changeset 6374


Ignore:
Timestamp:
01/12/2018 07:08:37 PM (3 years ago)
Author:
obenland
Message:

WP.tv: Add docs for globals.

Also updates some existing docs.

Props rushabh4486 for initial patch.
Fixes #3134.

Location:
sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2
Files:
15 edited

Legend:

Unmodified
Added
Removed
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/404.php

    r1024 r6374  
    11<?php
    2 /*
     2/**
    33 * WordCamp.tv Index Fallback
    44 *
    55 * It will be weird if somebody sees this (but okay if 404)
     6 *
     7 * @global WP_Query          $wp_query
     8 * @global WP_Post           $post
     9 * @global WordPressTV_Theme $wptv
    610 */
    711
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/archive.php

    r1640 r6374  
    11<?php
    2 /*
     2/**
    33 * WordCamp.tv Archives
    44 *
    55 * Yearly, monthly, daily, author and whatever falls back to archive.php.
     6 *
     7 * @global WP_Query          $wp_query
     8 * @global WP_Post           $post
     9 * @global WordPressTV_Theme $wptv
    610 */
    711
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/breadcrumbs.php

    r1024 r6374  
    22/**
    33 * Breadcrumbs template part, use with get_template_part()
     4 *
     5 * @global WordPressTV_Theme $wptv
    46 */
    57
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/category-wordcamptv.php

    r2334 r6374  
    11<?php
    2 /*
     2/**
    33 * WordCampTV Category Archives
    44 *
    55 * Requires a special display, hence the template.
     6 *
     7 * @global WordPressTV_Theme $wptv
    68 */
    79
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/category.php

    r1024 r6374  
    11<?php
    2 /*
     2/**
    33 * Category Archives
    44 *
    55 * Used for categories display, especially the to-do category.
    66 * Fallback to others as well.
     7 *
     8 * @global WP_Query          $wp_query
     9 * @global WordPressTV_Theme $wptv
    710 */
    811
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/comments.php

    r5844 r6374  
    22/**
    33 * WordPress.tv Comments Template
    4  * @uses global $wptv->list_comments
     4 *
     5 * @global WordPressTV_Theme $wptv
    56 */
    67
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/front-page.php

    r2334 r6374  
    22/**
    33 * WordPress.tv Front Page Template
     4 *
     5 * @global WordPressTV_Theme $wptv
    46 */
    57
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/functions.php

    r6373 r6374  
    4545    /**
    4646     * Different posts_per_page settings for different views. Runs during pre_get_posts.
     47     *
     48     * @param WP_Query $query The WP_Query instance.
    4749     */
    4850    function posts_per_page( $query ) {
     
    170172    /**
    171173     * Render the Video Info box
     174     *
     175     * @global WP_Post $post
    172176     */
    173177    function render_video_info_metabox() {
     
    190194     * Save the values of meta box fields
    191195     *
    192      * @param int $post_id
     196     * @param int     $post_id
    193197     * @param WP_Post $post
    194198     */
     
    256260     * @todo optimize the get_tax_query part.
    257261     *
    258      * @param string $search
     262     * @param string   $search
    259263     * @param WP_Query $query
    260      *
    261264     * @return string
    262265     */
     
    311314     * search. Make sure this filter runs only once per WP_Query request.
    312315     *
    313      * @param string $join
     316     * @param string   $join
    314317     * @param WP_Query $query
    315      *
    316318     * @return string
    317319     */
     
    336338     * This filter glues all duplicates. Use only once per WP_Query.
    337339     *
    338      * @param string $group_by
     340     * @param string   $group_by
    339341     * @param WP_Query $query
    340      *
    341342     * @return string
    342343     */
     
    355356     *
    356357     * @param string $search
    357      *
    358358     * @return array
    359359     */
     
    396396     *
    397397     * @param object $comment
    398      * @param array $args
    399      * @param int $depth
     398     * @param array  $args
     399     * @param int    $depth
    400400     */
    401401    function list_comments( $comment, $args, $depth ) {
     
    445445     *
    446446     * @param string $code
    447      *
    448447     * @return string
    449448     */
     
    541540     * Outputs the video image
    542541     *
    543      * @param int $h
    544      * @param int $w
     542     * @param int  $h
     543     * @param int  $w
    545544     * @param bool $arrow
    546545     * @param bool $html_code
     
    597596     *
    598597     * @param string $content
    599      *
    600598     * @return mixed
    601599     */
     
    610608     *
    611609     * @param string $path
    612      *
    613610     * @return mixed|void
    614611     */
     
    662659     * @param string $sep
    663660     * @param string $after
    664      * @param bool $display_count
     661     * @param bool   $display_count
     662     * @return bool|void False if there are no terms.
    665663     */
    666664    public function the_terms( $taxonomy = 'post_tag', $before = '', $sep = '', $after = '', $display_count = true ) {
     
    719717     * @param string $output
    720718     * @param object $item
    721      * @param int $depth
    722      * @param array $args
    723      * @param int $id
     719     * @param int    $depth
     720     * @param array  $args
     721     * @param int    $id
    724722     */
    725723    function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
     
    787785 *
    788786 * @param string $title Default title text for current view.
    789  * @param string $sep Optional separator.
    790  *
     787 * @param string $sep   Optional separator.
    791788 * @return string The filtered title.
    792789 */
     
    820817 *
    821818 * @param string $excerpt
    822  *
    823819 * @return string
    824820 */
     
    841837 *
    842838 * @param string $username
    843  *
    844839 * @return bool
    845840 */
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/header.php

    r4075 r6374  
    33 * WordPress.tv Header Template
    44 *
    5  * @global $wptv
     5 * @global WordPressTV_Theme $wptv
    66 */
    77
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/index.php

    r1024 r6374  
    11<?php
    2 /*
     2/**
    33 * WordCamp.tv Index Fallback
    44 *
    55 * It will be weird if somebody sees this (but okay if 404)
     6 *
     7 * @global WP_Query          $wp_query
     8 * @global WP_Post           $post
     9 * @global WordPressTV_Theme $wptv
    610 */
    711
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/pagination.php

    r1024 r6374  
    22/**
    33 * Pagination template part, use with get_template_part()
     4 *
     5 * @global WP_Query $wp_query
    46 */
    57
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/search.php

    r1024 r6374  
    11<?php
     2/**
     3 *
     4 * @global WP_Query $wp_query
     5 */
     6
    27global $wp_query;
    38
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/sidebar-single.php

    r1724 r6374  
    1 <?php global $wptv, $originalcontent; ?>
     1<?php
     2/**
     3 *
     4 * @global WordPressTV_Theme $wptv
     5 * @global string            $originalcontent
     6 */
     7
     8global $wptv, $originalcontent;
     9?>
    210
    311<div class="secondary-content video-info">
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/single.php

    r1024 r6374  
    22/**
    33 * Single Video Template
     4 *
     5 * @global WordPressTV_Theme $wptv
     6 * @global string            $originalcontent
    47 */
     8
    59global $wptv, $originalcontent;
    6 get_header(); the_post();
     10
     11get_header();
     12the_post();
    713?>
    814<div class="wptv-hero group">
  • sites/trunk/wordpress.tv/public_html/wp-content/themes/wptv2/taxonomy-event.php

    r1024 r6374  
    11<?php
    2 /*
     2/**
    33 * Event Taxonomy Archives
    44 *
    55 * Displays for event listings like individual WordCamps.
     6 *
     7 * @global WP_Query          $wp_query
     8 * @global WordPressTV_Theme $wptv
    69 *
    710 * @todo cleanup and merge with category.php
Note: See TracChangeset for help on using the changeset viewer.