From d174df13ae9eb2aec8fb85e39465bfb2704e9fa6 Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Sun, 24 May 2015 05:04:39 +0000 Subject: [PATCH] Add missing doc blocks to `class.wp-(scripts|styles).php`. See #32444. git-svn-id: https://develop.svn.wordpress.org/trunk@32566 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class.wp-scripts.php | 51 +++++++++++++++++++++++++--- src/wp-includes/class.wp-styles.php | 3 ++ 2 files changed, 49 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/class.wp-scripts.php b/src/wp-includes/class.wp-scripts.php index b7c7dedad5..d03e7aad77 100644 --- a/src/wp-includes/class.wp-scripts.php +++ b/src/wp-includes/class.wp-scripts.php @@ -61,12 +61,24 @@ class WP_Scripts extends WP_Dependencies { return $this->do_items( $handles, $group ); } - // Deprecated since 3.3, see print_extra_script() + /** + * @deprecated 3.3 + * @see print_extra_script() + * + * @param string $handle + * @param bool $echo + * @return bool|string|null + */ public function print_scripts_l10n( $handle, $echo = true ) { _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' ); return $this->print_extra_script( $handle, $echo ); } + /** + * @param string $handle + * @param bool $echo + * @return bool|string|null + */ public function print_extra_script( $handle, $echo = true ) { if ( !$output = $this->get_data( $handle, 'data' ) ) return; @@ -83,6 +95,11 @@ class WP_Scripts extends WP_Dependencies { return true; } + /** + * @param string $handle Name of the item. Should be unique. + * @param int|bool $group + * @return bool True on success, false if not set. + */ public function do_item( $handle, $group = false ) { if ( !parent::do_item($handle) ) return false; @@ -163,7 +180,7 @@ class WP_Scripts extends WP_Dependencies { $tag = "{$cond_before}\n{$cond_after}"; - /** + /** * Filter the HTML script tag of an enqueued script. * * @since 4.1.0 @@ -184,9 +201,12 @@ class WP_Scripts extends WP_Dependencies { } /** - * Localizes a script + * Localizes a script, only if the script has already been added * - * Localizes only if the script has already been added + * @param string $handle + * @param string $object_name + * @param array $l10n + * @return bool */ public function localize( $handle, $object_name, $l10n ) { if ( $handle === 'jquery' ) @@ -217,8 +237,13 @@ class WP_Scripts extends WP_Dependencies { return $this->add_data( $handle, 'data', $script ); } + /** + * @param string $handle Name of the item. Should be unique. + * @param bool $recursion Internal flag that calling function was called recursively. + * @param mixed $group Group level. + * @return bool Not already in the group or a lower group + */ public function set_group( $handle, $recursion, $group = false ) { - if ( $this->registered[$handle]->args === 1 ) $grp = 1; else @@ -230,6 +255,12 @@ class WP_Scripts extends WP_Dependencies { return parent::set_group( $handle, $recursion, $grp ); } + /** + * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings). + * @param bool $recursion Internal flag that function is calling itself. + * @param mixed $group Group level: (int) level, (false) no groups. + * @return bool True on success, false on failure. + */ public function all_deps( $handles, $recursion = false, $group = false ) { $r = parent::all_deps( $handles, $recursion ); if ( ! $recursion ) { @@ -245,16 +276,26 @@ class WP_Scripts extends WP_Dependencies { return $r; } + /** + * @return array + */ public function do_head_items() { $this->do_items(false, 0); return $this->done; } + /** + * @return array + */ public function do_footer_items() { $this->do_items(false, 1); return $this->done; } + /** + * @param string $src + * @return bool + */ public function in_default_dir( $src ) { if ( ! $this->default_dirs ) { return true; diff --git a/src/wp-includes/class.wp-styles.php b/src/wp-includes/class.wp-styles.php index 46cb913bd3..9cb4491332 100644 --- a/src/wp-includes/class.wp-styles.php +++ b/src/wp-includes/class.wp-styles.php @@ -234,6 +234,9 @@ class WP_Styles extends WP_Dependencies { return false; } + /** + * @return array + */ public function do_footer_items() { // HTML 5 allows styles in the body, grab late enqueued items and output them in the footer. $this->do_items(false, 1); return $this->done;