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
This commit is contained in:
parent
f270cd90c5
commit
d174df13ae
@ -61,12 +61,24 @@ class WP_Scripts extends WP_Dependencies {
|
|||||||
return $this->do_items( $handles, $group );
|
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 ) {
|
public function print_scripts_l10n( $handle, $echo = true ) {
|
||||||
_deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
|
_deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
|
||||||
return $this->print_extra_script( $handle, $echo );
|
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 ) {
|
public function print_extra_script( $handle, $echo = true ) {
|
||||||
if ( !$output = $this->get_data( $handle, 'data' ) )
|
if ( !$output = $this->get_data( $handle, 'data' ) )
|
||||||
return;
|
return;
|
||||||
@ -83,6 +95,11 @@ class WP_Scripts extends WP_Dependencies {
|
|||||||
return true;
|
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 ) {
|
public function do_item( $handle, $group = false ) {
|
||||||
if ( !parent::do_item($handle) )
|
if ( !parent::do_item($handle) )
|
||||||
return false;
|
return false;
|
||||||
@ -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 ) {
|
public function localize( $handle, $object_name, $l10n ) {
|
||||||
if ( $handle === 'jquery' )
|
if ( $handle === 'jquery' )
|
||||||
@ -217,8 +237,13 @@ class WP_Scripts extends WP_Dependencies {
|
|||||||
return $this->add_data( $handle, 'data', $script );
|
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 ) {
|
public function set_group( $handle, $recursion, $group = false ) {
|
||||||
|
|
||||||
if ( $this->registered[$handle]->args === 1 )
|
if ( $this->registered[$handle]->args === 1 )
|
||||||
$grp = 1;
|
$grp = 1;
|
||||||
else
|
else
|
||||||
@ -230,6 +255,12 @@ class WP_Scripts extends WP_Dependencies {
|
|||||||
return parent::set_group( $handle, $recursion, $grp );
|
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 ) {
|
public function all_deps( $handles, $recursion = false, $group = false ) {
|
||||||
$r = parent::all_deps( $handles, $recursion );
|
$r = parent::all_deps( $handles, $recursion );
|
||||||
if ( ! $recursion ) {
|
if ( ! $recursion ) {
|
||||||
@ -245,16 +276,26 @@ class WP_Scripts extends WP_Dependencies {
|
|||||||
return $r;
|
return $r;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function do_head_items() {
|
public function do_head_items() {
|
||||||
$this->do_items(false, 0);
|
$this->do_items(false, 0);
|
||||||
return $this->done;
|
return $this->done;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function do_footer_items() {
|
public function do_footer_items() {
|
||||||
$this->do_items(false, 1);
|
$this->do_items(false, 1);
|
||||||
return $this->done;
|
return $this->done;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $src
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
public function in_default_dir( $src ) {
|
public function in_default_dir( $src ) {
|
||||||
if ( ! $this->default_dirs ) {
|
if ( ! $this->default_dirs ) {
|
||||||
return true;
|
return true;
|
||||||
|
@ -234,6 +234,9 @@ class WP_Styles extends WP_Dependencies {
|
|||||||
return false;
|
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.
|
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);
|
$this->do_items(false, 1);
|
||||||
return $this->done;
|
return $this->done;
|
||||||
|
Loading…
Reference in New Issue
Block a user