Docs: Update inline docs for various general template functions.
Reviewed By peterwilsoncc, jorbin. Merges [60120] and [60121] to the 6.8 branch. Props dilipbheda, mukesh27, SergeyBiryukov, audrasjb. Fixes #63215. See #63166. Built from https://develop.svn.wordpress.org/branches/6.8@60139 git-svn-id: http://core.svn.wordpress.org/branches/6.8@59475 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
@@ -19,9 +19,9 @@
|
||||
* @since 5.5.0 A return value was added.
|
||||
* @since 5.5.0 The `$args` parameter was added.
|
||||
*
|
||||
* @param string $name The name of the specialized header.
|
||||
* @param array $args Optional. Additional arguments passed to the header template.
|
||||
* Default empty array.
|
||||
* @param string|null $name The name of the specialized header. Default null.
|
||||
* @param array $args Optional. Additional arguments passed to the header template.
|
||||
* Default empty array.
|
||||
* @return void|false Void on success, false if the template does not exist.
|
||||
*/
|
||||
function get_header( $name = null, $args = array() ) {
|
||||
@@ -63,9 +63,9 @@ function get_header( $name = null, $args = array() ) {
|
||||
* @since 5.5.0 A return value was added.
|
||||
* @since 5.5.0 The `$args` parameter was added.
|
||||
*
|
||||
* @param string $name The name of the specialized footer.
|
||||
* @param array $args Optional. Additional arguments passed to the footer template.
|
||||
* Default empty array.
|
||||
* @param string|null $name The name of the specialized footer. Default null.
|
||||
* @param array $args Optional. Additional arguments passed to the footer template.
|
||||
* Default empty array.
|
||||
* @return void|false Void on success, false if the template does not exist.
|
||||
*/
|
||||
function get_footer( $name = null, $args = array() ) {
|
||||
@@ -107,9 +107,9 @@ function get_footer( $name = null, $args = array() ) {
|
||||
* @since 5.5.0 A return value was added.
|
||||
* @since 5.5.0 The `$args` parameter was added.
|
||||
*
|
||||
* @param string $name The name of the specialized sidebar.
|
||||
* @param array $args Optional. Additional arguments passed to the sidebar template.
|
||||
* Default empty array.
|
||||
* @param string|null $name The name of the specialized sidebar. Default null.
|
||||
* @param array $args Optional. Additional arguments passed to the sidebar template.
|
||||
* Default empty array.
|
||||
* @return void|false Void on success, false if the template does not exist.
|
||||
*/
|
||||
function get_sidebar( $name = null, $args = array() ) {
|
||||
@@ -159,7 +159,7 @@ function get_sidebar( $name = null, $args = array() ) {
|
||||
* @since 5.5.0 The `$args` parameter was added.
|
||||
*
|
||||
* @param string $slug The slug name for the generic template.
|
||||
* @param string|null $name Optional. The name of the specialized template.
|
||||
* @param string|null $name Optional. The name of the specialized template. Default null.
|
||||
* @param array $args Optional. Additional arguments passed to the template.
|
||||
* Default empty array.
|
||||
* @return void|false Void on success, false if the template does not exist.
|
||||
@@ -175,8 +175,8 @@ function get_template_part( $slug, $name = null, $args = array() ) {
|
||||
* @since 5.5.0 The `$args` parameter was added.
|
||||
*
|
||||
* @param string $slug The slug name for the generic template.
|
||||
* @param string|null $name The name of the specialized template or null if
|
||||
* there is none.
|
||||
* @param string|null $name The name of the specialized template
|
||||
* or null if there is none.
|
||||
* @param array $args Additional arguments passed to the template.
|
||||
*/
|
||||
do_action( "get_template_part_{$slug}", $slug, $name, $args );
|
||||
@@ -196,8 +196,8 @@ function get_template_part( $slug, $name = null, $args = array() ) {
|
||||
* @since 5.5.0 The `$args` parameter was added.
|
||||
*
|
||||
* @param string $slug The slug name for the generic template.
|
||||
* @param string $name The name of the specialized template or an empty
|
||||
* string if there is none.
|
||||
* @param string $name The name of the specialized template
|
||||
* or an empty string if there is none.
|
||||
* @param string[] $templates Array of template files to search for, in order.
|
||||
* @param array $args Additional arguments passed to the template.
|
||||
*/
|
||||
@@ -1916,7 +1916,7 @@ function get_the_post_type_description() {
|
||||
* @param string $format Optional. Can be 'link', 'option', 'html', or custom. Default 'html'.
|
||||
* @param string $before Optional. Content to prepend to the description. Default empty.
|
||||
* @param string $after Optional. Content to append to the description. Default empty.
|
||||
* @param bool $selected Optional. Set to true if the current page is the selected archive page.
|
||||
* @param bool $selected Optional. Set to true if the current page is the selected archive page. Default false.
|
||||
* @return string HTML link content for archive.
|
||||
*/
|
||||
function get_archives_link( $url, $text, $format = 'html', $before = '', $after = '', $selected = false ) {
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '6.8-RC2-60138';
|
||||
$wp_version = '6.8-RC2-60139';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
||||
Reference in New Issue
Block a user