WordPress.org

Make WordPress Core


Ignore:
Timestamp:
12/01/2014 01:33:34 AM (6 years ago)
Author:
wonderboymusic
Message:

Improve various @param docs for src/wp-includes/*.

See #30224.

File:
1 edited

Legend:

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

    r30538 r30681  
    428428 * @param string $category The category to use.
    429429 * @param string $args
    430  * @return bool|null
     430 * @return string|null
    431431 */
    432432function wp_get_linksbyname($category, $args = '') {
     
    579579 *      order which will return links in a random order.
    580580 * @param bool $show_description Whether to show the description if show_images=false/not defined.
    581  * @param string $limit Limit to X entries. If not specified, all entries are shown.
     581 * @param int $limit Limit to X entries. If not specified, all entries are shown.
    582582 * @param int $show_updated Whether to show last updated timestamp
    583583 */
     
    628628 * @param string $exclude
    629629 * @param bool $hierarchical
    630  * @return string
     630 * @return false|null
    631631 */
    632632function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
     
    647647 *
    648648 * @param string|array $args
    649  * @return string
     649 * @return false|null|string
    650650 */
    651651function wp_list_cats($args = '') {
     
    11571157 * @param bool $echo
    11581158 * @param int $cat_ID
    1159  * @return string|null
     1159 * @return string
    11601160 */
    11611161function get_category_rss_link($echo = false, $cat_ID = 1) {
     
    11791179 * @param bool $echo
    11801180 * @param int $author_id
    1181  * @return string|null
     1181 * @return string
    11821182 */
    11831183function get_author_rss_link($echo = false, $author_id = 1) {
     
    16581658 * @see get_the_author_meta()
    16591659 *
    1660  * @return int The author's ID.
     1660 * @return string|int The author's ID.
    16611661 */
    16621662function get_the_author_ID() {
     
    17021702 *
    17031703 * @param string $more_link_text Optional. Text to display when more content is available but not displayed.
    1704  * @param int|bool $stripteaser Optional. Default is 0.
     1704 * @param int $stripteaser Optional. Default is 0.
    17051705 * @param string $more_file Optional.
    17061706 * @param int $cut Optional. Amount of words to keep for the content.
     
    19611961 * @param bool $fullsize Optional, default to false. Whether to have full size image.
    19621962 * @param array $max_dims Optional. Dimensions of image.
    1963  * @return string HTML content.
     1963 * @return false|string HTML content.
    19641964 */
    19651965function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) {
     
    20182018 * @param bool $fullsize Optional, default to false. Whether to have full size image.
    20192019 * @param array $max_dims Optional. Dimensions of image.
    2020  * @return string
     2020 * @return false|string
    20212021 */
    20222022function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) {
     
    30423042 * @see remove_theme_support()
    30433043 *
    3044  * @return bool Whether support was removed.
     3044 * @return null|bool Whether support was removed.
    30453045 */
    30463046function remove_custom_image_header() {
     
    30793079 * @see add_custom_background()
    30803080 *
    3081  * @return bool Whether support was removed.
     3081 * @return null|bool Whether support was removed.
    30823082 */
    30833083function remove_custom_background() {
     
    32933293 * @param int $postid Post ID.
    32943294 * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A.
    3295  * @return object|array Post object or array holding post contents and information
     3295 * @return WP_Post|null Post object or array holding post contents and information
    32963296 */
    32973297function wp_get_single_post( $postid = 0, $mode = OBJECT ) {
Note: See TracChangeset for help on using the changeset viewer.