diff --git a/wp-admin/js/custom-background.js b/wp-admin/js/custom-background.js index c3f4e294f1..9e96015e75 100644 --- a/wp-admin/js/custom-background.js +++ b/wp-admin/js/custom-background.js @@ -1,9 +1,24 @@ /* global ajaxurl */ + +/** + * @summary Registers all events for customizing the background. + * + * @since 3.0.0 + * + * @requires jQuery + */ (function($) { $(document).ready(function() { var frame, bgImage = $( '#custom-background-image' ); + /** + * @summary Instantiates the WordPress color picker and binds the change and clear events. + * + * @since 3.5.0 + * + * @returns {void} + */ $('#background-color').wpColorPicker({ change: function( event, ui ) { bgImage.css('background-color', ui.color.toString()); @@ -13,22 +28,57 @@ } }); + /** + * @summary Alters the background size CSS property whenever the background size input has changed. + * + * @since 4.7.0 + * + * @returns {void} + */ $( 'select[name="background-size"]' ).change( function() { bgImage.css( 'background-size', $( this ).val() ); }); + /** + * @summary Alters the background position CSS property whenever the background position input has changed. + * + * @since 4.7.0 + * + * @returns {void} + */ $( 'input[name="background-position"]' ).change( function() { bgImage.css( 'background-position', $( this ).val() ); }); + /** + * @summary Alters the background repeat CSS property whenever the background repeat input has changed. + * + * @since 3.0.0 + * + * @returns {void} + */ $( 'input[name="background-repeat"]' ).change( function() { bgImage.css( 'background-repeat', $( this ).is( ':checked' ) ? 'repeat' : 'no-repeat' ); }); + /** + * @summary Alters the background attachment CSS property whenever the background attachment input has changed. + * + * @since 4.7.0 + * + * @returns {void} + */ $( 'input[name="background-attachment"]' ).change( function() { bgImage.css( 'background-attachment', $( this ).is( ':checked' ) ? 'scroll' : 'fixed' ); }); + /** + * @summary Binds the event for opening the WP Media dialog. + * + * @since 3.5.0 + * + * @returns {void} + */ $('#choose-from-library-link').click( function( event ) { var $el = $(this); @@ -54,13 +104,21 @@ button: { // Set the text of the button. text: $el.data('update'), - // Tell the button not to close the modal, since we're - // going to refresh the page when the image is selected. + /* + * Tell the button not to close the modal, since we're + * going to refresh the page when the image is selected. + */ close: false } }); - // When an image is selected, run a callback. + /** + * @summary When an image is selected, run a callback. + * + * @since 3.5.0 + * + * @returns {void} + */ frame.on( 'select', function() { // Grab the selected attachment. var attachment = frame.state().get('selection').first(); diff --git a/wp-includes/version.php b/wp-includes/version.php index adeb056f12..fcd14f1f4c 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.9-alpha-40913'; +$wp_version = '4.9-alpha-40914'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.