[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-admin/js/ -> common.js (summary)

(no description)

File Size: 2597 lines (70 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 25 functions

  deprecatedProperty()
  deprecateL10nObject()
  changeStructureTagButtonState()
  adjustSubmenu()
  makeNoticesDismissible()
  marryControls()
  updateTopSelector()
  updateBottomSelector()
  triggerSubmitClick()
  toggleUploadButton()
  pinMenu()
  resetHeights()
  unpinMenu()
  setPinMenu()
  aria_button_if_js()
  getViewportWidth()
  setMenuState()
  triggerEvent()
  fireOnce()
  hasNoSelectedUser()
  getDecisionLabel()
  getIncompleteDecisions()
  renderErrorSummary()
  clearErrorState()
  updateSummary()

Functions
Functions that are not part of a class:

deprecatedProperty( propName, version, replacement )   X-Ref
Throws an error for a deprecated property.

param: {string} propName    The property that was used.
param: {string} version     The version of WordPress that deprecated the property.
param: {string} replacement The property that should have been used.

deprecateL10nObject( name, l10nObject, version )   X-Ref
Deprecate all properties on an object.

return: {object} The object with all its properties deprecated.
param: {string} name       The name of the object, i.e. commonL10n.
param: {object} l10nObject The object to deprecate the properties on.
param: {string} version    The version of WordPress that deprecated the property.

changeStructureTagButtonState( button )   X-Ref
No description

adjustSubmenu( $menuItem )   X-Ref
Ensures an admin submenu is within the visual viewport.

return: {void}
param: {jQuery} $menuItem The parent menu item containing the submenu.

makeNoticesDismissible()   X-Ref
Makes notices dismissible.

return: {void}

marryControls( topSelector, topSubmit, bottomSelector, bottomSubmit )   X-Ref
Marries a secondary control to its primary control.

return: {void}
param: {jQuery} topSelector    The top selector element.
param: {jQuery} topSubmit      The top submit element.
param: {jQuery} bottomSelector The bottom selector element.
param: {jQuery} bottomSubmit   The bottom submit element.

updateTopSelector()   X-Ref
Updates the primary selector when the secondary selector is changed.

return: {void}

updateBottomSelector()   X-Ref
Updates the secondary selector when the primary selector is changed.

return: {void}

triggerSubmitClick(e)   X-Ref
Triggers the primary submit when then secondary submit is clicked.

return: {void}

toggleUploadButton()   X-Ref
Determines if any data is entered in any file upload input.

return: {void}

pinMenu( event )   X-Ref
Pins the menu while distraction-free writing is enabled.

return: {void}
param: {Event} event Event data.

resetHeights()   X-Ref
Determines the height of certain elements.

return: {void}

unpinMenu()   X-Ref
Unpins the menu.

return: {void}

setPinMenu()   X-Ref
Pins and unpins the menu when applicable.

return: {void}

aria_button_if_js()   X-Ref
Add an ARIA role `button` to elements that behave like UI controls when JavaScript is on.

return: {void}

getViewportWidth()   X-Ref
Get the viewport width.

return: {number|boolean} The current viewport width or false if the

setMenuState()   X-Ref
Sets the admin menu collapsed/expanded state.

Sets the global variable `menuState` and triggers a custom event passing
the current menu state.

return: {void}

triggerEvent()   X-Ref
No description

fireOnce()   X-Ref
Fires the trigger event again after 200 ms.

return: {void}

hasNoSelectedUser( select )   X-Ref
Whether a reassign dropdown has no user selected.

The "Select a user" placeholder value differs between the forms: the
single-site dropdown uses an empty string, the multisite one uses the
wp_dropdown_users() default of '-1'.

return: {boolean} True when no real user is selected.
param: {HTMLSelectElement} select The reassign dropdown.

getDecisionLabel( group )   X-Ref
Builds a human-readable label for a radio group's decision.

Combines the fieldset legend (the user) with the site context that
precedes the group on multisite, so each summary entry is identifiable.

return: {string} The composed label.
param: {HTMLElement} group The radio group (<ul>) element.

getIncompleteDecisions()   X-Ref
Returns the radio groups whose content decision is still incomplete.

A decision unit is a single radio group (<ul>), which maps to one user on
single site and one site-per-user on multisite.

return: {Array} Objects describing each incomplete decision.

renderErrorSummary( incomplete )   X-Ref
Builds or refreshes the error summary markup.

return: {string} The summary title, for announcing to assistive technology.
param: {Array} incomplete Incomplete decisions from getIncompleteDecisions().

clearErrorState()   X-Ref
Removes the error summary and clears invalid states.


updateSummary( moveFocus )   X-Ref
Refreshes the error summary to match the current form state.

return: {number} The number of incomplete decisions.
param: {boolean} moveFocus Whether to move focus to the summary and



Generated : Mon Jul 27 08:20:18 2026 Cross-referenced by PHPXref