Changeset 45422

Timestamp:

05/25/2019 11:40:06 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation for variadic functions relating to post type support and theme support.

See #37402

Location:

trunk/src/wp-includes

Files:

• post.php (modified) (3 diffs)
• theme.php (modified) (5 diffs)

trunk/src/wp-includes/post.php

@@ -1743 +1743 @@
 
 /**
- * Register support of certain features for a post type.
+ * Registers support of certain features for a post type.
  *
  * All core features are directly associated with a functional area of the edit
@@ -1754 +1754 @@
  * count will show on the edit screen.
  *
+ * Example usage:
+ *
+ *     add_post_type_support( 'my_post_type', 'comments' );
+ *     add_post_type_support( 'my_post_type', array(
+ *         'author', 'excerpt',
+ *     ) );
+ *     add_post_type_support( 'my_post_type', 'my_feature', array(
+ *         'field' => 'value',
+ *     ) );
+ *
  * @since 3.0.0
  *
@@ -1761 +1771 @@
  * @param string|array $feature   The feature being added, accepts an array of
  *                                feature strings or a single string.
+ * @param mixed        ...$args   Optional extra arguments to pass along with certain features.
  */
 function add_post_type_support( $post_type, $feature ) {

trunk/src/wp-includes/theme.php

@@ -2319 +2319 @@
  * The {@see 'init'} hook may be too late for some features.
  *
+ * Example usage:
+ *
+ *     add_theme_support( 'title-tag' );
+ *     add_theme_support( 'custom-logo', array(
+ *         'height' => 480,
+ *         'width'  => 720,
+ *     ) );
+ *
  * @since 2.9.0
  * @since 3.6.0 The `html5` feature was added
@@ -2637 +2645 @@
  * Gets the theme support arguments passed when registering that support
  *
+ * Example usage:
+ *
+ *     get_theme_support( 'custom-logo' );
+ *     get_theme_support( 'custom-header', 'width' );
+ *
  * @since 3.1.0
  *
@@ -2642 +2655 @@
  *
  * @param string $feature The feature to check.
+ * @param mixed  ...$args Optional extra arguments to be checked against certain features.
  * @return mixed The array of extra arguments or the value for the registered feature.
  */
@@ -2752 +2766 @@
  * Checks a theme's support for a given feature.
  *
+ * Example usage:
+ *
+ *     current_theme_supports( 'custom-logo' );
+ *     current_theme_supports( 'html5', 'comment-form' );
+ *
  * @since 2.9.0
  *
@@ -2757 +2776 @@
  *
  * @param string $feature The feature being checked.
+ * @param mixed  ...$args Optional extra arguments to be checked against certain features.
  * @return bool True if the current theme supports the feature, false otherwise.
  */