Changeset 48102
- Timestamp:
- 06/20/2020 11:16:12 AM (3 years ago)
- Location:
- trunk/src
- Files:
-
- 29 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/wp-admin/includes/class-wp-media-list-table.php
r47234 r48102 659 659 * @param WP_Post $post 660 660 * @param string $att_title 661 *662 661 * @return array 663 662 */ -
trunk/src/wp-admin/includes/class-wp-site-health.php
r47815 r48102 149 149 * 150 150 * @param $callback 151 *152 151 * @return mixed|void 153 152 */ … … 791 790 * @param string $constant Optional. The constant name to test for. Default null. 792 791 * @param string $class Optional. The class name to test for. Default null. 793 *794 792 * @return bool Whether or not the extension and function are available. 795 793 */ -
trunk/src/wp-admin/includes/comment.php
r47808 r48102 22 22 * @param string $comment_date Date of the comment. 23 23 * @param string $timezone Timezone. Accepts 'blog' or 'gmt'. Default 'blog'. 24 *25 24 * @return mixed Comment post ID on success. 26 25 */ -
trunk/src/wp-admin/includes/file.php
r48067 r48102 1977 1977 * the post. Default null. 1978 1978 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false. 1979 *1980 1979 * @return bool|array True if no filesystem credentials are required, false if they are required but have not been 1981 1980 * provided, array of credentials if they are required and have been provided. -
trunk/src/wp-admin/includes/misc.php
r48100 r48102 1402 1402 * @param string $title Page title. 1403 1403 * @param WP_Post $page Page data object. 1404 *1405 1404 * @return string Page title. 1406 1405 */ -
trunk/src/wp-admin/includes/revision.php
r47557 r48102 16 16 * @param int $compare_from The revision ID to compare from. 17 17 * @param int $compare_to The revision ID to come to. 18 *19 18 * @return array|bool Associative array of a post's revisioned fields and their diffs. 20 19 * Or, false on failure. … … 162 161 * @param int $selected_revision_id The selected revision ID. 163 162 * @param int $from Optional. The revision ID to compare from. 164 *165 163 * @return array An associative array of revision data and related settings. 166 164 */ -
trunk/src/wp-content/themes/twentynineteen/inc/customizer.php
r46827 r48102 142 142 * 143 143 * @param string $choice Whether image filter is active. 144 *145 144 * @return string 146 145 */ -
trunk/src/wp-content/themes/twentyseventeen/functions.php
r48101 r48102 590 590 * 591 591 * @param string $template front-page.php. 592 * 593 * @return string The template to be used: blank if is_home() is true (defaults to index.php), else $template.592 * @return string The template to be used: blank if is_home() is true (defaults to index.php), 593 * otherwise $template. 594 594 */ 595 595 function twentyseventeen_front_page_template( $template ) { … … 618 618 619 619 /** 620 * Get unique ID.620 * Gets unique ID. 621 621 * 622 622 * This is a PHP implementation of Underscore's uniqueId method. A static variable -
trunk/src/wp-content/themes/twentytwenty/classes/class-twentytwenty-customize.php
r46827 r48102 417 417 * @since Twenty Twenty 1.0 418 418 * @param array $value The value we want to sanitize. 419 * @return array 419 * @return array Returns sanitized value. Each item in the array gets sanitized separately. 420 420 */ 421 421 public static function sanitize_accent_accessible_colors( $value ) { … … 439 439 * @param string $input The input from the setting. 440 440 * @param object $setting The selected setting. 441 * 442 * @return string $input|$setting->default The input from the setting or the default setting. 441 * @return string The input from the setting or the default setting. 443 442 */ 444 443 public static function sanitize_select( $input, $setting ) { … … 452 451 * 453 452 * @param bool $checked Whether or not a box is checked. 454 *455 453 * @return bool 456 454 */ -
trunk/src/wp-content/themes/twentytwenty/classes/class-twentytwenty-non-latin-languages.php
r47122 r48102 22 22 * 23 23 * @param string $type Whether to return CSS for the "front-end", "block-editor" or "classic-editor". 24 *25 24 * @return void 26 25 */ -
trunk/src/wp-content/themes/twentytwenty/functions.php
r47933 r48102 272 272 * 273 273 * @param string $html The HTML output from get_custom_logo (core function). 274 * 275 * @return string $html 274 * @return string 276 275 */ 277 276 function twentytwenty_get_custom_logo( $html ) { … … 428 427 * 429 428 * @param array $mce_init TinyMCE styles. 430 * 431 * @return array $mce_init TinyMCE styles. 429 * @return array TinyMCE styles. 432 430 */ 433 431 function twentytwenty_add_classic_editor_customizer_styles( $mce_init ) { … … 452 450 * 453 451 * @param array $mce_init TinyMCE styles. 454 * 455 * @return array $mce_init TinyMCE styles. 452 * @return array TinyMCE styles. 456 453 */ 457 454 function twentytwenty_add_classic_editor_non_latin_styles( $mce_init ) { … … 570 567 * 571 568 * @param string $html The default output HTML for the more tag. 572 * 573 * @return string $html 569 * @return string 574 570 */ 575 571 function twentytwenty_read_more_tag( $html ) { -
trunk/src/wp-content/themes/twentytwenty/inc/starter-content.php
r47388 r48102 16 16 * 17 17 * @since Twenty Twenty 1.0 18 * @return array a filtered array of args for the starter_content. 18 * 19 * @return array A filtered array of args for the starter_content. 19 20 */ 20 21 function twentytwenty_get_starter_content() { -
trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php
r47799 r48102 22 22 * Logo & Description 23 23 */ 24 24 25 /** 25 26 * Displays the site logo, either text or image. … … 27 28 * @param array $args Arguments for displaying the site logo either as an image or text. 28 29 * @param boolean $echo Echo or return the HTML. 29 * 30 * @return string $html Compiled HTML based on our arguments. 30 * @return string Compiled HTML based on our arguments. 31 31 */ 32 32 function twentytwenty_site_logo( $args = array(), $echo = true ) { … … 90 90 * 91 91 * @param boolean $echo Echo or return the html. 92 * 93 * @return string $html The HTML to display. 92 * @return string The HTML to display. 94 93 */ 95 94 function twentytwenty_site_description( $echo = true ) { … … 125 124 * Comments 126 125 */ 127 /** 128 * Check if the specified comment is written by the author of the post commented on. 126 127 /** 128 * Checks if the specified comment is written by the author of the post commented on. 129 129 * 130 130 * @param object $comment Comment data. 131 *132 131 * @return bool 133 132 */ … … 150 149 151 150 /** 152 * Filter comment reply link to not JS scroll. 151 * Filters comment reply link to not JS scroll. 152 * 153 153 * Filter the comment reply link to add a class indicating it should not use JS slow-scroll, as it 154 154 * makes it scroll to the wrong position on the page. 155 155 * 156 156 * @param string $link Link to the top of the page. 157 * 158 * @return string $link Link to the top of the page. 157 * @return string Link to the top of the page. 159 158 */ 160 159 function twentytwenty_filter_comment_reply_link( $link ) { … … 170 169 * Post Meta 171 170 */ 172 /** 173 * Get and Output Post Meta. 174 * If it's a single post, output the post meta values specified in the Customizer settings. 175 * 176 * @param int $post_id The ID of the post for which the post meta should be output. 171 172 /** 173 * Retrieves and displays the post meta. 174 * 175 * If it's a single post, outputs the post meta values specified in the Customizer settings. 176 * 177 * @param int $post_id The ID of the post for which the post meta should be output. 177 178 * @param string $location Which post meta location to output – single or preview. 178 179 */ … … 221 222 222 223 /** 223 * Getthe post meta.224 * Retrieves the post meta. 224 225 * 225 226 * @param int $post_id The ID of the post. … … 234 235 235 236 /** 236 * Filters post types array 237 * 238 * This filter can be used to hide post meta information of post, page or custom post type registerd by child themes or plugins 237 * Filters post types array. 238 * 239 * This filter can be used to hide post meta information of post, page or custom post type 240 * registered by child themes or plugins. 239 241 * 240 242 * @since Twenty Twenty 1.0 … … 243 245 */ 244 246 $disallowed_post_types = apply_filters( 'twentytwenty_disallowed_post_types_for_meta_output', array( 'page' ) ); 247 245 248 // Check whether the post type is allowed to output post meta. 246 249 if ( in_array( get_post_type( $post_id ), $disallowed_post_types, true ) ) { … … 254 257 if ( 'single-top' === $location ) { 255 258 /** 256 * Filters post meta info visibility257 *258 * Use this filter to hide post meta information like Author, Post date, Comments, Is sticky status259 *260 * @since Twenty Twenty 1.0261 *262 * @param array $args {263 * @type string 'author'264 * @type string 'post-date'265 * @type string 'comments'266 * @type string 'sticky'267 * }268 */259 * Filters post meta info visibility. 260 * 261 * Use this filter to hide post meta information like Author, Post date, Comments, Is sticky status. 262 * 263 * @since Twenty Twenty 1.0 264 * 265 * @param array $args { 266 * @type string 'author' 267 * @type string 'post-date' 268 * @type string 'comments' 269 * @type string 'sticky' 270 * } 271 */ 269 272 $post_meta = apply_filters( 270 273 'twentytwenty_post_meta_location_single_top', … … 282 285 283 286 /** 284 * Filters post tags visibility285 *286 * Use this filter to hide post tags287 *288 * @since Twenty Twenty 1.0289 *290 * @param array $args {291 * @type string 'tags'292 * }293 */287 * Filters post tags visibility. 288 * 289 * Use this filter to hide post tags. 290 * 291 * @since Twenty Twenty 1.0 292 * 293 * @param array $args { 294 * @type string 'tags' 295 * } 296 */ 294 297 $post_meta = apply_filters( 295 298 'twentytwenty_post_meta_location_single_bottom', … … 490 493 * Menus 491 494 */ 492 /** 493 * Filter Classes of wp_list_pages items to match menu items. 495 496 /** 497 * Filters classes of wp_list_pages items to match menu items. 498 * 494 499 * Filter the class applied to wp_list_pages() items with children to match the menu class, to simplify. 495 500 * styling of sub levels in the fallback. Only applied if the match_menu_classes argument is set. … … 500 505 * @param array $args An array of arguments. 501 506 * @param string $current_page Whether or not the item is the current item. 502 *503 507 * @return array $css_class CSS Class names. 504 508 */ … … 529 533 530 534 /** 531 * Add a Sub Nav Toggle to the Expanded Menu and Mobile Menu.535 * Adds a Sub Nav Toggle to the Expanded Menu and Mobile Menu. 532 536 * 533 537 * @param stdClass $args An array of arguments. 534 538 * @param string $item Menu item. 535 539 * @param int $depth Depth of the current menu item. 536 *537 540 * @return stdClass $args An object of wp_nav_menu() arguments. 538 541 */ … … 576 579 577 580 /** 578 * Display SVG icons in social links menu.581 * Displays SVG icons in social links menu. 579 582 * 580 583 * @param string $item_output The menu item output. … … 602 605 * Classes 603 606 */ 604 /** 605 * Add No-JS Class. 606 * If we're missing JavaScript support, the HTML element will have a no-js class. 607 608 /** 609 * Adds 'no-js' class. 610 * 611 * If we're missing JavaScript support, the HTML element will have a 'no-js' class. 607 612 */ 608 613 function twentytwenty_no_js_class() { … … 617 622 618 623 /** 619 * Add conditional body classes.624 * Adds conditional body classes. 620 625 * 621 626 * @param array $classes Classes added to the body tag. 622 * 623 * @return array $classes Classes added to the body tag. 627 * @return array Classes added to the body tag. 624 628 */ 625 629 function twentytwenty_body_classes( $classes ) { … … 717 721 * Archives 718 722 */ 723 719 724 /** 720 725 * Filters the archive title and styles the word before the first colon. 721 726 * 722 727 * @param string $title Current archive title. 723 * 724 * @return string $title Current archive title. 728 * @return string Current archive title. 725 729 */ 726 730 function twentytwenty_get_the_archive_title( $title ) { … … 749 753 * Miscellaneous 750 754 */ 751 /** 752 * Toggle animation duration in milliseconds. 753 * 754 * @return integer Duration in milliseconds 755 756 /** 757 * Toggles animation duration in milliseconds. 758 * 759 * @return int Duration in milliseconds 755 760 */ 756 761 function twentytwenty_toggle_duration() { … … 760 765 * @since Twenty Twenty 1.0 761 766 * 762 * @param int eger$duration Duration in milliseconds.767 * @param int $duration Duration in milliseconds. 763 768 */ 764 769 $duration = apply_filters( 'twentytwenty_toggle_duration', 250 ); … … 768 773 769 774 /** 770 * Get unique ID.775 * Gets unique ID. 771 776 * 772 777 * This is a PHP implementation of Underscore's uniqueId method. A static variable -
trunk/src/wp-includes/blocks.php
r48067 r48102 590 590 * 591 591 * @param string $block_name Block type name including namespace. 592 * @param array $style_properties Array containing the properties of the style name, label, style (name of the stylesheet to be enqueued), inline_style (string containing the CSS to be added). 593 * 592 * @param array $style_properties Array containing the properties of the style name, 593 * label, style (name of the stylesheet to be enqueued), 594 * inline_style (string containing the CSS to be added). 594 595 * @return boolean True if the block style was registered with success and false otherwise. 595 596 */ … … 605 606 * @param string $block_name Block type name including namespace. 606 607 * @param array $block_style_name Block style name. 607 *608 608 * @return boolean True if the block style was unregistered with success and false otherwise. 609 609 */ -
trunk/src/wp-includes/class-http.php
r48067 r48102 512 512 * @param array $args Request arguments. 513 513 * @param string $url URL to Request. 514 *515 514 * @return string|false Class name for the first transport that claims to support the request. 516 515 * False if no transport claims to support the request. -
trunk/src/wp-includes/class-wp-date-query.php
r47851 r48102 178 178 * 179 179 * Ensures that each query-level clause has a 'relation' key, and that 180 * each first-order clause contains all the necessary keys from 181 * `$defaults`. 180 * each first-order clause contains all the necessary keys from `$defaults`. 182 181 * 183 182 * @since 4.1.0 … … 185 184 * @param array $queries 186 185 * @param array $parent_query 187 *188 186 * @return array Sanitized queries. 189 187 */ -
trunk/src/wp-includes/class-wp-image-editor-imagick.php
r47219 r48102 210 210 * @param int $width 211 211 * @param int $height 212 *213 212 * @return true|WP_Error 214 213 */ -
trunk/src/wp-includes/class-wp-network-query.php
r47808 r48102 510 510 * @param string $string Search string. 511 511 * @param string[] $columns Array of columns to search. 512 *513 512 * @return string Search SQL. 514 513 */ -
trunk/src/wp-includes/class-wp-paused-extensions-storage.php
r47122 r48102 81 81 * 82 82 * @param string $extension Plugin or theme directory name. 83 *84 83 * @return bool True on success, false on failure. 85 84 */ … … 122 121 * 123 122 * @param string $extension Plugin or theme directory name. 124 *125 123 * @return array|null Error that is stored, or null if the extension is not paused. 126 124 */ -
trunk/src/wp-includes/class-wp-recovery-mode-email-service.php
r47122 r48102 102 102 * @param array $error Error details from {@see error_get_last()} 103 103 * @param array $extension Extension that caused the error. 104 *105 104 * @return bool Whether the email was sent successfully. 106 105 */ -
trunk/src/wp-includes/class-wp-recovery-mode.php
r47122 r48102 341 341 * 342 342 * @param array $error Error that was triggered. 343 *344 343 * @return array|false { 345 344 * @type string $slug The extension slug. This is the plugin or theme's directory. -
trunk/src/wp-includes/compat.php
r47550 r48102 346 346 * 347 347 * @param mixed $var The value to check. 348 *349 348 * @return bool True if `$var` is countable, false otherwise. 350 349 */ … … 368 367 * 369 368 * @param mixed $var The value to check. 370 *371 369 * @return bool True if `$var` is iterable, false otherwise. 372 370 */ -
trunk/src/wp-includes/embed.php
r47947 r48102 58 58 * 59 59 * @param string $url Optional. The URL that should be embedded. Default empty. 60 *61 60 * @return array { 62 61 * Indexed array of the embed width and height in pixels. -
trunk/src/wp-includes/error-protection.php
r47122 r48102 43 43 * 44 44 * @param array $error Error details {@see error_get_last()} 45 *46 45 * @return string Formatted error description. 47 46 */ -
trunk/src/wp-includes/link-template.php
r48100 r48102 101 101 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 102 102 * @param bool $leavename Optional. Whether to keep post name or page name. Default false. 103 *104 103 * @return string|false The permalink URL or false if post does not exist. 105 104 */ … … 4438 4437 * @param string $before Optional. Display before privacy policy link. Default empty. 4439 4438 * @param string $after Optional. Display after privacy policy link. Default empty. 4440 *4441 4439 * @return string Markup for the link and surrounding elements. Empty string if it 4442 4440 * doesn't exist. -
trunk/src/wp-includes/rest-api.php
r47923 r48102 716 716 * Recursively computes the intersection of arrays using keys for comparison. 717 717 * 718 * @since 5.3.0 719 * 718 720 * @param array $array1 The array with master keys to check. 719 721 * @param array $array2 An array to compare keys against. 720 * 721 * @return array An associative array containing all the entries of array1 which have keysthat are present in all arguments.722 * @return array An associative array containing all the entries of array1 which have keys 723 * that are present in all arguments. 722 724 */ 723 725 function _rest_array_intersect_key_recursive( $array1, $array2 ) { … … 739 741 * @param WP_REST_Server $server ResponseHandler instance (usually WP_REST_Server). 740 742 * @param WP_REST_Request $request The request that was used to make current response. 741 *742 743 * @return WP_REST_Response Response to be served, trimmed down to contain a subset of fields. 743 744 */ -
trunk/src/wp-includes/rest-api/class-wp-rest-request.php
r47559 r48102 403 403 * 404 404 * @param string $key Parameter name. 405 *406 405 * @return bool True if a param exists for the given key. 407 406 */ -
trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php
r47850 r48102 400 400 * @param WP_Post $post Post revision object. 401 401 * @param WP_REST_Request $request Request object. 402 *403 402 * @return WP_REST_Response Response object. 404 403 */ -
trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php
r48100 r48102 162 162 * @param WP_REST_Request $request Full details about the request. 163 163 * @param string $param The parameter that is being sanitized. 164 *165 164 * @return int|bool|WP_Error 166 165 */
Note: See TracChangeset
for help on using the changeset viewer.