WordPress.org

Make WordPress Core

Changeset 28004


Ignore:
Timestamp:
04/07/2014 08:37:17 PM (7 years ago)
Author:
DrewAPicture
Message:

General PHPDoc improvements in wp-includes/media.php for 3.9 functionality.

See #27700.

File:
1 edited

Legend:

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

    r27979 r28004  
    10101010
    10111011/**
    1012  * Output the templates used by playlists
     1012 * Output the templates used by playlists.
    10131013 *
    10141014 * @since 3.9.0
     
    10521052 * @since 3.9.0
    10531053 *
    1054  * @param string $type Type of playlist: "audio" or "video."
     1054 * @param string $type Type of playlist. Accepts 'audio' or 'video'.
    10551055 */
    10561056function wp_playlist_scripts( $type ) {
     
    10651065
    10661066/**
    1067  * The Playlist shortcode.
    1068  *
    1069  * This implements the functionality of the Playlist Shortcode for displaying
     1067 * The playlist shortcode.
     1068 *
     1069 * This implements the functionality of the playlist shortcode for displaying
    10701070 * a collection of WordPress audio or video files in a post.
    10711071 *
    10721072 * @since 3.9.0
    10731073 *
    1074  * @param array  $attr Attributes of the shortcode.
     1074 * @param array $attr Playlist shortcode attributes.
    10751075 * @return string Playlist output. Empty string if the passed type is unsupported.
    10761076 */
     
    12611261         * @since 3.9.0
    12621262         *
    1263          * @param string $type   Type of playlist: "audio" or "video."
    1264          * @param string $style  The "theme" for the playlist. Core provides "light" and "dark."
     1263         * @param string $type  Type of playlist. Possible values are 'audio' or 'video'.
     1264         * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.
    12651265         */
    12661266        do_action( 'wp_playlist_scripts', $type, $style );
     
    13181318 * @since 3.9.0
    13191319 *
    1320  * @param WP_Post $attachment The attachment in question, provided for context.
     1320 * @param WP_Post $attachment The current attachment, provided for context.
    13211321 * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.
    1322  * @return array
     1322 * @return array Key/value pairs of field keys to labels.
    13231323 */
    13241324function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
     
    27352735
    27362736/**
    2737  * If an attachment is missing its metadata, try to generate it.
     2737 * Maybe attempt to generate attachment metadata, if missing.
    27382738 *
    27392739 * @since 3.9.0
    27402740 *
    2741  * @param post $attachment Post object.
     2741 * @param WP_Post $attachment Attachment object.
    27422742 */
    27432743function wp_maybe_generate_attachment_metadata( $attachment ) {
     
    27602760
    27612761/**
    2762  * Determine if a post supports thumbnails based on the passed $post
     2762 * Determine if a post supports thumbnails based on the passed post object.
    27632763 *
    27642764 * @since 3.9.0
    27652765 *
    2766  * @param WP_Post $post
    2767  *
    2768  * @return boolean
     2766 * @param WP_Post $post Post object.
     2767 *
     2768 * @return bool Whether the post type supports thumbnails.
    27692769 */
    27702770function post_supports_thumbnails( $post ) {
     
    27812781
    27822782/**
    2783  * Determine if a theme supports thumbnails based on the passed $post
     2783 * Determine if a theme supports thumbnails based on the passed post object.
    27842784 *
    27852785 * @since 3.9.0
    27862786 *
    2787  * @param WP_Post $post
    2788  *
    2789  * @return boolean
     2787 * @param WP_Post $post Post object.
     2788 *
     2789 * @return bool Whether the current theme supports thumbnails.
    27902790 */
    27912791function theme_supports_thumbnails( $post ) {
Note: See TracChangeset for help on using the changeset viewer.