WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/28/2020 02:00:26 PM (17 months ago)
Author:
SergeyBiryukov
Message:

Docs: Replace "html" and "xhtml" instances in DocBlocks and comments with "HTML" and "XHTML".

This ensures consistent capitalization where appropriate.

Props navidos, desrosj.
Fixes #50473.

File:
1 edited

Legend:

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

    r48197 r48199  
    380380 * @see get_bookmarks()
    381381 *
    382  * @param string $cat_name Optional. The category name to use. If no match is found uses all.
    383  * @param string $before Optional. The html to output before the link.
    384  * @param string $after Optional. The html to output after the link.
    385  * @param string $between Optional. The html to output between the link/image and its description. Not used if no image or $show_images is true.
    386  * @param bool $show_images Optional. Whether to show images (if defined).
    387  * @param string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner.
    388  *      If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a
    389  *      random order.
    390  * @param bool $show_description Optional. Whether to show the description if show_images=false/not defined.
    391  * @param bool $show_rating Optional. Show rating stars/chars.
    392  * @param int $limit        Optional. Limit to X entries. If not specified, all entries are shown.
    393  * @param int $show_updated Optional. Whether to show last updated timestamp
     382 * @param string $cat_name         Optional. The category name to use. If no match is found, uses all.
     383 *                                 Default 'noname'.
     384 * @param string $before           Optional. The HTML to output before the link. Default empty.
     385 * @param string $after            Optional. The HTML to output after the link. Default '<br />'.
     386 * @param string $between          Optional. The HTML to output between the link/image and its description.
     387 *                                 Not used if no image or $show_images is true. Default ' '.
     388 * @param bool   $show_images      Optional. Whether to show images (if defined). Default true.
     389 * @param string $orderby          Optional. The order to output the links. E.g. 'id', 'name', 'url',
     390 *                                 'description', 'rating', or 'owner'. Default 'id'.
     391 *                                 If you start the name with an underscore, the order will be reversed.
     392 *                                 Specifying 'rand' as the order will return links in a random order.
     393 * @param bool   $show_description Optional. Whether to show the description if show_images=false/not defined.
     394 *                                 Default true.
     395 * @param bool   $show_rating      Optional. Show rating stars/chars. Default false.
     396 * @param int    $limit            Optional. Limit to X entries. If not specified, all entries are shown.
     397 *                                 Default -1.
     398 * @param int    $show_updated     Optional. Whether to show last updated timestamp. Default 0.
    394399 */
    395400function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',
     
    448453 * @see get_bookmarks()
    449454 *
    450  * @param string $cat_name The category name to use. If no match is found uses all.
    451  * @param string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'.
    452  *      Or maybe owner. If you start the name with an underscore the order will be reversed. You can also
    453  *      specify 'rand' as the order which will return links in a random order.
    454  * @param int $limit Limit to X entries. If not specified, all entries are shown.
     455 * @param string $cat_name Optional. The category name to use. If no match is found, uses all.
     456 *                         Default 'noname'.
     457 * @param string $orderby  Optional. The order to output the links. E.g. 'id', 'name', 'url',
     458 *                         'description', 'rating', or 'owner'. Default 'name'.
     459 *                         If you start the name with an underscore, the order will be reversed.
     460 *                         Specifying 'rand' as the order will return links in a random order.
     461 * @param int    $limit    Optional. Limit to X entries. If not specified, all entries are shown.
     462 *                         Default -1.
    455463 * @return array
    456464 */
     
    498506 * @see get_bookmarks()
    499507 *
    500  * @param int $category The category to use. If no category supplied uses all
    501  * @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
    502  *      'description', or 'rating'. Or maybe owner. If you start the name with an
    503  *      underscore the order will be reversed. You can also specify 'rand' as the
    504  *      order which will return links in a random order.
    505  * @param int $limit Limit to X entries. If not specified, all entries are shown.
     508 * @param int    $category Optional. The category to use. If no category supplied, uses all.
     509 *                         Default 0.
     510 * @param string $orderby  Optional. The order to output the links. E.g. 'id', 'name', 'url',
     511 *                         'description', 'rating', or 'owner'. Default 'name'.
     512 *                         If you start the name with an underscore, the order will be reversed.
     513 *                         Specifying 'rand' as the order will return links in a random order.
     514 * @param int    $limit    Optional. Limit to X entries. If not specified, all entries are shown.
     515 *                         Default 0.
    506516 * @return array
    507517 */
     
    525535 * @see get_bookmarks()
    526536 *
    527  * @param string $cat_name The category name to use. If no match is found uses all
    528  * @param string $before The html to output before the link
    529  * @param string $after The html to output after the link
    530  * @param string $between The html to output between the link/image and its description. Not used if no image or show_images is true
    531  * @param bool $show_images Whether to show images (if defined).
    532  * @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
    533  *      'description', or 'rating'. Or maybe owner. If you start the name with an
    534  *      underscore the order will be reversed. You can also specify 'rand' as the
    535  *      order which will return links in a random order.
    536  * @param bool $show_description Whether to show the description if show_images=false/not defined
    537  * @param int $limit Limit to X entries. If not specified, all entries are shown.
    538  * @param int $show_updated Whether to show last updated timestamp
     537 * @param string $cat_name         Optional. The category name to use. If no match is found, uses all.
     538 *                                 Default 'noname'.
     539 * @param string $before           Optional. The HTML to output before the link. Default empty.
     540 * @param string $after            Optional. The HTML to output after the link. Default '<br />'.
     541 * @param string $between          Optional. The HTML to output between the link/image and its description.
     542 *                                 Not used if no image or $show_images is true. Default ' '.
     543 * @param bool   $show_images      Optional. Whether to show images (if defined). Default true.
     544 * @param string $orderby          Optional. The order to output the links. E.g. 'id', 'name', 'url',
     545 *                                 'description', 'rating', or 'owner'. Default 'id'.
     546 *                                 If you start the name with an underscore, the order will be reversed.
     547 *                                 Specifying 'rand' as the order will return links in a random order.
     548 * @param bool   $show_description Optional. Whether to show the description if show_images=false/not defined.
     549 *                                 Default true.
     550 * @param int    $limit            Optional. Limit to X entries. If not specified, all entries are shown.
     551 *                                 Default -1.
     552 * @param int    $show_updated     Optional. Whether to show last updated timestamp. Default 0.
    539553 */
    540554function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '<br />', $between = " ",
     
    552566 * @see get_bookmarks()
    553567 *
    554  * @param int $category The category to use. If no category supplied uses all
    555  * @param string $before The html to output before the link
    556  * @param string $after The html to output after the link
    557  * @param string $between The html to output between the link/image and its description. Not used if no image or show_images == true
    558  * @param bool $show_images Whether to show images (if defined).
    559  * @param string $orderby The order to output the links. E.g. 'id', 'name', 'url',
    560  *      'description', or 'rating'. Or maybe owner. If you start the name with an
    561  *      underscore the order will be reversed. You can also specify 'rand' as the
    562  *      order which will return links in a random order.
    563  * @param bool $show_description Whether to show the description if show_images=false/not defined.
    564  * @param int $limit Limit to X entries. If not specified, all entries are shown.
    565  * @param int $show_updated Whether to show last updated timestamp
     568 * @param int    $category         Optional. The category to use. If no category supplied, uses all.
     569 *                                 Default 0.
     570 * @param string $before           Optional. The HTML to output before the link. Default empty.
     571 * @param string $after            Optional. The HTML to output after the link. Default '<br />'.
     572 * @param string $between          Optional. The HTML to output between the link/image and its description.
     573 *                                 Not used if no image or $show_images is true. Default ' '.
     574 * @param bool   $show_images      Optional. Whether to show images (if defined). Default true.
     575 * @param string $orderby          Optional. The order to output the links. E.g. 'id', 'name', 'url',
     576 *                                 'description', 'rating', or 'owner'. Default 'id'.
     577 *                                 If you start the name with an underscore, the order will be reversed.
     578 *                                 Specifying 'rand' as the order will return links in a random order.
     579 * @param bool   $show_description Optional. Whether to show the description if show_images=false/not defined.
     580 *                                 Default true.
     581 * @param int    $limit            Optional. Limit to X entries. If not specified, all entries are shown.
     582 *                                 Default -1.
     583 * @param int    $show_updated     Optional. Whether to show last updated timestamp. Default 0.
    566584 */
    567585function get_links_withrating($category = -1, $before = '', $after = '<br />', $between = " ", $show_images = true,
     
    905923 * @see get_bookmarks()
    906924 *
    907  * @param int $category The category to use. If no category supplied uses all
    908  * @param string $before the html to output before the link
    909  * @param string $after the html to output after the link
    910  * @param string $between the html to output between the link/image and its description.
    911  *      Not used if no image or show_images == true
    912  * @param bool $show_images whether to show images (if defined).
    913  * @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
    914  *      'description', or 'rating'. Or maybe owner. If you start the name with an
    915  *      underscore the order will be reversed. You can also specify 'rand' as the order
    916  *      which will return links in a random order.
    917  * @param bool $show_description whether to show the description if show_images=false/not defined.
    918  * @param bool $show_rating show rating stars/chars
    919  * @param int $limit Limit to X entries. If not specified, all entries are shown.
    920  * @param int $show_updated whether to show last updated timestamp
    921  * @param bool $echo whether to echo the results, or return them instead
     925 * @param int    $category         Optional. The category to use. If no category supplied uses all.
     926 *                                 Default 0.
     927 * @param string $before           Optional. The HTML to output before the link. Default empty.
     928 * @param string $after            Optional. The HTML to output after the link. Default '<br />'.
     929 * @param string $between          Optional. The HTML to output between the link/image and its description.
     930 *                                 Not used if no image or $show_images is true. Default ' '.
     931 * @param bool   $show_images      Optional. Whether to show images (if defined). Default true.
     932 * @param string $orderby          Optional. The order to output the links. E.g. 'id', 'name', 'url',
     933 *                                 'description', 'rating', or 'owner'. Default 'name'.
     934 *                                 If you start the name with an underscore, the order will be reversed.
     935 *                                 Specifying 'rand' as the order will return links in a random order.
     936 * @param bool   $show_description Optional. Whether to show the description if show_images=false/not defined.
     937 *                                 Default true.
     938 * @param bool   $show_rating      Optional. Show rating stars/chars. Default false.
     939 * @param int    $limit            Optional. Limit to X entries. If not specified, all entries are shown.
     940 *                                 Default -1.
     941 * @param int    $show_updated     Optional. Whether to show last updated timestamp. Default 1.
     942 * @param bool   $echo             Whether to echo the results, or return them instead.
    922943 * @return null|string
    923944 */
     
    16291650 * Display the post content for the feed.
    16301651 *
    1631  * For encoding the html or the $encode_html parameter, there are three possible
    1632  * values. '0' will make urls footnotes and use make_url_footnote(). '1' will
    1633  * encode special characters and automatically display all of the content. The
    1634  * value of '2' will strip all HTML tags from the content.
    1635  *
    1636  * Also note that you cannot set the amount of words and not set the html
    1637  * encoding. If that is the case, then the html encoding will default to 2,
    1638  * which will strip all HTML tags.
    1639  *
    1640  * To restrict the amount of words of the content, you can use the cut
    1641  * parameter. If the content is less than the amount, then there won't be any
    1642  * dots added to the end. If there is content left over, then dots will be added
    1643  * and the rest of the content will be removed.
     1652 * For encoding the HTML or the $encode_html parameter, there are three possible values:
     1653 * - '0' will make urls footnotes and use make_url_footnote().
     1654 * - '1' will encode special characters and automatically display all of the content.
     1655 * - '2' will strip all HTML tags from the content.
     1656 *
     1657 * Also note that you cannot set the amount of words and not set the HTML encoding.
     1658 * If that is the case, then the HTML encoding will default to 2, which will strip
     1659 * all HTML tags.
     1660 *
     1661 * To restrict the amount of words of the content, you can use the cut parameter.
     1662 * If the content is less than the amount, then there won't be any dots added to the end.
     1663 * If there is content left over, then dots will be added and the rest of the content
     1664 * will be removed.
    16441665 *
    16451666 * @since 0.71
     
    16481669 * @see the_content_feed()
    16491670 *
    1650  * @param string $more_link_text Optional. Text to display when more content is available but not displayed.
    1651  * @param int $stripteaser Optional. Default is 0.
    1652  * @param string $more_file Optional.
    1653  * @param int $cut Optional. Amount of words to keep for the content.
    1654  * @param int $encode_html Optional. How to encode the content.
     1671 * @param string $more_link_text Optional. Text to display when more content is available
     1672 *                               but not displayed. Default '(more...)'.
     1673 * @param int    $stripteaser    Optional. Default 0.
     1674 * @param string $more_file      Optional.
     1675 * @param int    $cut            Optional. Amount of words to keep for the content.
     1676 * @param int    $encode_html    Optional. How to encode the content.
    16551677 */
    16561678function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) {
     
    17051727 * @deprecated 2.9.0
    17061728 *
    1707  * @param string $content Content to get links
     1729 * @param string $content Content to get links.
    17081730 * @return string HTML stripped out of content with links at the bottom.
    17091731 */
     
    17431765 * @see _x()
    17441766 *
    1745  * @param string $text Text to translate
    1746  * @param string $domain Optional. Domain to retrieve the translated text
    1747  * @return string Translated context string without pipe
     1767 * @param string $text Text to translate.
     1768 * @param string $domain Optional. Domain to retrieve the translated text.
     1769 * @return string Translated context string without pipe.
    17481770 */
    17491771function _c( $text, $domain = 'default' ) {
     
    17601782 * @see _x()
    17611783 *
    1762  * @param string $text Text to translate
    1763  * @param string $domain Domain to retrieve the translated text
    1764  * @return string Translated text
     1784 * @param string $text Text to translate.
     1785 * @param string $domain Domain to retrieve the translated text.
     1786 * @return string Translated text.
    17651787 */
    17661788function translate_with_context( $text, $domain = 'default' ) {
Note: See TracChangeset for help on using the changeset viewer.