Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.

Commit

Permalink
Flesh out param phpdoc for Customize_Snapshot::set()
Browse files Browse the repository at this point in the history
  • Loading branch information
westonruter committed Aug 31, 2016
1 parent 2b77775 commit c0b4539
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion php/class-customize-snapshot-manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -1299,7 +1299,7 @@ public function replace_customize_link( $wp_admin_bar ) {
return;
}

// Remove customize_snapshot_uuuid query param from url param to be previewed in Customizer.
// Remove customize_snapshot_uuid query param from url param to be previewed in Customizer.
$preview_url_query_params = array();
$preview_url_parsed = wp_parse_url( $customize_node->href );
parse_str( $preview_url_parsed['query'], $preview_url_query_params );
Expand Down
10 changes: 7 additions & 3 deletions php/class-customize-snapshot.php
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,11 @@ public function status() {
* @throws Exception When $settings_data is not an array of arrays.
*
* @param array $settings_data Settings data, mapping setting IDs to arrays containing `value` and optionally additional params.
* @param array $args extra optional param to tweak.
* @param array $options {
* Additional options.
*
* @type bool $skip_validation Whether to skip validation. Optional, defaults to false.
* }
* @return array {
* Result.
*
Expand All @@ -150,7 +154,7 @@ public function status() {
* @type array $validities Setting validities.
* }
*/
public function set( array $settings_data, array $args = array() ) {
public function set( array $settings_data, array $options = array() ) {
$error = new \WP_Error();
$result = array(
'errors' => null,
Expand Down Expand Up @@ -190,7 +194,7 @@ public function set( array $settings_data, array $args = array() ) {
);

$invalid_setting_ids = array();
if ( empty( $args['skip_validation'] ) ) {
if ( empty( $options['skip_validation'] ) ) {
// Validate.
if ( method_exists( $customize_manager, 'validate_setting_values' ) ) {
$result['validities'] = $customize_manager->validate_setting_values( $unsanitized_values );
Expand Down

0 comments on commit c0b4539

Please sign in to comment.