-" . esc_html( $template ) . "";
+ echo "\n\t';
}
}
@@ -805,24 +868,25 @@
* @param int $level Optional. Page depth level. Default 0.
* @param int|WP_Post $post Post ID or WP_Post object.
*
- * @return null|false Boolean False if page has no children, otherwise print out html elements
+ * @return null|false Boolean False if page has no children, otherwise print out html elements.
*/
function parent_dropdown( $default = 0, $parent = 0, $level = 0, $post = null ) {
global $wpdb;
- $post = get_post( $post );
- $items = $wpdb->get_results( $wpdb->prepare("SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' ORDER BY menu_order", $parent) );
+ $post = get_post( $post );
+ $items = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' ORDER BY menu_order", $parent ) );
if ( $items ) {
foreach ( $items as $item ) {
// A page cannot be its own parent.
- if ( $post && $post->ID && $item->ID == $post->ID )
+ if ( $post && $post->ID && $item->ID == $post->ID ) {
continue;
+ }
- $pad = str_repeat( ' ', $level * 3 );
+ $pad = str_repeat( ' ', $level * 3 );
$selected = selected( $default, $item->ID, false );
- echo "\n\t";
- parent_dropdown( $default, $item->ID, $level +1 );
+ echo "\n\t';
+ parent_dropdown( $default, $item->ID, $level + 1 );
}
} else {
return false;
@@ -842,7 +906,7 @@
$editable_roles = array_reverse( get_editable_roles() );
foreach ( $editable_roles as $role => $details ) {
- $name = translate_user_role($details['name'] );
+ $name = translate_user_role( $details['name'] );
// preselect specified role
if ( $selected == $role ) {
$r .= "\n\t";
@@ -872,24 +936,26 @@
*
* @param int $max_upload_size Allowed upload size. Default 1 MB.
*/
- $bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() );
- $size = size_format( $bytes );
+ $bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() );
+ $size = size_format( $bytes );
$upload_dir = wp_upload_dir();
if ( ! empty( $upload_dir['error'] ) ) :
- ?>
-
+
+
+
+ ?>
-id;
- if ( !isset($wp_meta_boxes) )
+ if ( ! isset( $wp_meta_boxes ) ) {
$wp_meta_boxes = array();
- if ( !isset($wp_meta_boxes[$page]) )
- $wp_meta_boxes[$page] = array();
- if ( !isset($wp_meta_boxes[$page][$context]) )
- $wp_meta_boxes[$page][$context] = array();
+ }
+ if ( ! isset( $wp_meta_boxes[ $page ] ) ) {
+ $wp_meta_boxes[ $page ] = array();
+ }
+ if ( ! isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
+ $wp_meta_boxes[ $page ][ $context ] = array();
+ }
- foreach ( array_keys($wp_meta_boxes[$page]) as $a_context ) {
- foreach ( array('high', 'core', 'default', 'low') as $a_priority ) {
- if ( !isset($wp_meta_boxes[$page][$a_context][$a_priority][$id]) )
+ foreach ( array_keys( $wp_meta_boxes[ $page ] ) as $a_context ) {
+ foreach ( array( 'high', 'core', 'default', 'low' ) as $a_priority ) {
+ if ( ! isset( $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] ) ) {
continue;
+ }
// If a core box was previously added or removed by a plugin, don't add.
if ( 'core' == $priority ) {
// If core box previously deleted, don't add
- if ( false === $wp_meta_boxes[$page][$a_context][$a_priority][$id] )
+ if ( false === $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] ) {
return;
+ }
/*
* If box was added with default priority, give it core priority to
* maintain sort order.
*/
if ( 'default' == $a_priority ) {
- $wp_meta_boxes[$page][$a_context]['core'][$id] = $wp_meta_boxes[$page][$a_context]['default'][$id];
- unset($wp_meta_boxes[$page][$a_context]['default'][$id]);
+ $wp_meta_boxes[ $page ][ $a_context ]['core'][ $id ] = $wp_meta_boxes[ $page ][ $a_context ]['default'][ $id ];
+ unset( $wp_meta_boxes[ $page ][ $a_context ]['default'][ $id ] );
}
return;
}
// If no priority given and id already present, use existing priority.
- if ( empty($priority) ) {
+ if ( empty( $priority ) ) {
$priority = $a_priority;
- /*
- * Else, if we're adding to the sorted priority, we don't know the title
- * or callback. Grab them from the previously added context/priority.
- */
+ /*
+ * Else, if we're adding to the sorted priority, we don't know the title
+ * or callback. Grab them from the previously added context/priority.
+ */
} elseif ( 'sorted' == $priority ) {
- $title = $wp_meta_boxes[$page][$a_context][$a_priority][$id]['title'];
- $callback = $wp_meta_boxes[$page][$a_context][$a_priority][$id]['callback'];
- $callback_args = $wp_meta_boxes[$page][$a_context][$a_priority][$id]['args'];
+ $title = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['title'];
+ $callback = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['callback'];
+ $callback_args = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['args'];
}
// An id can be in only one priority and one context.
- if ( $priority != $a_priority || $context != $a_context )
- unset($wp_meta_boxes[$page][$a_context][$a_priority][$id]);
+ if ( $priority != $a_priority || $context != $a_context ) {
+ unset( $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] );
+ }
}
}
- if ( empty($priority) )
+ if ( empty( $priority ) ) {
$priority = 'low';
+ }
+
+ if ( ! isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) {
+ $wp_meta_boxes[ $page ][ $context ][ $priority ] = array();
+ }
+
+ $wp_meta_boxes[ $page ][ $context ][ $priority ][ $id ] = array(
+ 'id' => $id,
+ 'title' => $title,
+ 'callback' => $callback,
+ 'args' => $callback_args,
+ );
+}
+
- if ( !isset($wp_meta_boxes[$page][$context][$priority]) )
- $wp_meta_boxes[$page][$context][$priority] = array();
+/**
+ * Function that renders a "fake" meta box with an information message,
+ * shown on the block editor, when an incompatible meta box is found.
+ *
+ * @since 5.0.0
+ *
+ * @param mixed $object The data object being rendered on this screen.
+ * @param array $box {
+ * Custom formats meta box arguments.
+ *
+ * @type string $id Meta box 'id' attribute.
+ * @type string $title Meta box title.
+ * @type callable $old_callback The original callback for this meta box.
+ * @type array $args Extra meta box arguments.
+ * }
+ */
+function do_block_editor_incompatible_meta_box( $object, $box ) {
+ $plugin = _get_plugin_from_callback( $box['old_callback'] );
+ $plugins = get_plugins();
+ echo '
';
+ if ( $plugin ) {
+ /* translators: %s: the name of the plugin that generated this meta box. */
+ printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "{$plugin['Name']}" );
+ } else {
+ _e( "This meta box isn't compatible with the block editor." );
+ }
+ echo '
';
+ /* translators: %s: A link to install the Classic Editor plugin. */
+ printf( __( 'Please install the Classic Editor plugin to use this meta box.' ), esc_url( self_admin_url( 'plugin-install.php?tab=featured' ) ) );
+ echo '
';
+ /* translators: %s: A link to activate the Classic Editor plugin. */
+ printf( __( 'Please activate the Classic Editor plugin to use this meta box.' ), esc_url( $activate_url ) );
+ echo '
';
+ /* translators: %s: A link to use the Classic Editor plugin. */
+ printf( __( 'Please open the classic editor to use this meta box.' ), esc_url( $edit_url ) );
+ echo '
';
+ }
}
/**
- * Meta-Box template function
+ * Internal helper function to find the plugin from a meta box callback.
+ *
+ * @since 5.0.0
+ *
+ * @access private
+ *
+ * @param callable $callback The callback function to check.
+ * @return array|null The plugin that the callback belongs to, or null if it doesn't belong to a plugin.
+ */
+function _get_plugin_from_callback( $callback ) {
+ try {
+ if ( is_array( $callback ) ) {
+ $reflection = new ReflectionMethod( $callback[0], $callback[1] );
+ } elseif ( is_string( $callback ) && false !== strpos( $callback, '::' ) ) {
+ $reflection = new ReflectionMethod( $callback );
+ } else {
+ $reflection = new ReflectionFunction( $callback );
+ }
+ } catch ( ReflectionException $exception ) {
+ // We could not properly reflect on the callable, so we abort here.
+ return null;
+ }
+
+ // Don't show an error if it's an internal PHP function.
+ if ( ! $reflection->isInternal() ) {
+
+ // Only show errors if the meta box was registered by a plugin.
+ $filename = wp_normalize_path( $reflection->getFileName() );
+ $plugin_dir = wp_normalize_path( WP_PLUGIN_DIR );
+ if ( strpos( $filename, $plugin_dir ) === 0 ) {
+ $filename = str_replace( $plugin_dir, '', $filename );
+ $filename = preg_replace( '|^/([^/]*/).*$|', '\\1', $filename );
+
+ $plugins = get_plugins();
+ foreach ( $plugins as $name => $plugin ) {
+ if ( strpos( $name, $filename ) === 0 ) {
+ return $plugin;
+ }
+ }
+ }
+ }
+
+ return null;
+}
+
+/**
+ * Meta-Box template function.
*
* @since 2.5.0
*
@@ -1011,18 +1195,21 @@
* add_submenu_page() to create a new screen (and hence screen_id)
* make sure your menu slug conforms to the limits of sanitize_key()
* otherwise the 'screen' menu may not correctly render on your page.
- * @param string $context box context
- * @param mixed $object gets passed to the box callback function as first parameter
+ * @param string $context The screen context for which to display meta boxes.
+ * @param mixed $object Gets passed to the first parameter of the meta box callback function.
+ * Often this is the object that's the focus of the current screen, for
+ * example a `WP_Post` or `WP_Comment` object.
* @return int number of meta_boxes
*/
function do_meta_boxes( $screen, $context, $object ) {
global $wp_meta_boxes;
static $already_sorted = false;
- if ( empty( $screen ) )
+ if ( empty( $screen ) ) {
$screen = get_current_screen();
- elseif ( is_string( $screen ) )
+ } elseif ( is_string( $screen ) ) {
$screen = convert_to_screen( $screen );
+ }
$page = $screen->id;
@@ -1047,20 +1234,47 @@
if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
foreach ( array( 'high', 'sorted', 'core', 'default', 'low' ) as $priority ) {
- if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ]) ) {
+ if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) {
foreach ( (array) $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) {
- if ( false == $box || ! $box['title'] )
+ if ( false == $box || ! $box['title'] ) {
continue;
+ }
+
+ $block_compatible = true;
+ if ( is_array( $box['args'] ) ) {
+ // If a meta box is just here for back compat, don't show it in the block editor.
+ if ( $screen->is_block_editor() && isset( $box['args']['__back_compat_meta_box'] ) && $box['args']['__back_compat_meta_box'] ) {
+ continue;
+ }
+
+ if ( isset( $box['args']['__block_editor_compatible_meta_box'] ) ) {
+ $block_compatible = (bool) $box['args']['__block_editor_compatible_meta_box'];
+ unset( $box['args']['__block_editor_compatible_meta_box'] );
+ }
+
+ // If the meta box is declared as incompatible with the block editor, override the callback function.
+ if ( ! $block_compatible && $screen->is_block_editor() ) {
+ $box['old_callback'] = $box['callback'];
+ $box['callback'] = 'do_block_editor_incompatible_meta_box';
+ }
+
+ if ( isset( $box['args']['__back_compat_meta_box'] ) ) {
+ $block_compatible = $block_compatible || (bool) $box['args']['__back_compat_meta_box'];
+ unset( $box['args']['__back_compat_meta_box'] );
+ }
+ }
+
$i++;
- $hidden_class = in_array($box['id'], $hidden) ? ' hide-if-js' : '';
- echo '
';
return $i;
@@ -1121,19 +1358,23 @@
$page = $screen->id;
- if ( !isset($wp_meta_boxes) )
+ if ( ! isset( $wp_meta_boxes ) ) {
$wp_meta_boxes = array();
- if ( !isset($wp_meta_boxes[$page]) )
- $wp_meta_boxes[$page] = array();
- if ( !isset($wp_meta_boxes[$page][$context]) )
- $wp_meta_boxes[$page][$context] = array();
+ }
+ if ( ! isset( $wp_meta_boxes[ $page ] ) ) {
+ $wp_meta_boxes[ $page ] = array();
+ }
+ if ( ! isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
+ $wp_meta_boxes[ $page ][ $context ] = array();
+ }
- foreach ( array('high', 'core', 'default', 'low') as $priority )
- $wp_meta_boxes[$page][$context][$priority][$id] = false;
+ foreach ( array( 'high', 'core', 'default', 'low' ) as $priority ) {
+ $wp_meta_boxes[ $page ][ $context ][ $priority ][ $id ] = false;
+ }
}
/**
- * Meta Box Accordion Template Function
+ * Meta Box Accordion Template Function.
*
* Largely made up of abstracted code from do_meta_boxes(), this
* function serves to build meta boxes as list items for display as
@@ -1153,10 +1394,11 @@
wp_enqueue_script( 'accordion' );
- if ( empty( $screen ) )
+ if ( empty( $screen ) ) {
$screen = get_current_screen();
- elseif ( is_string( $screen ) )
+ } elseif ( is_string( $screen ) ) {
$screen = convert_to_screen( $screen );
+ }
$page = $screen->id;
@@ -1165,15 +1407,16 @@
$id, 'title' => $title, 'callback' => $callback);
+ $wp_settings_sections[ $page ][ $id ] = array(
+ 'id' => $id,
+ 'title' => $title,
+ 'callback' => $callback,
+ );
}
/**
- * Add a new field to a section of a settings page
+ * Add a new field to a section of a settings page.
*
* Part of the Settings API. Use this to define a settings field that will show
* as part of a settings section inside a settings page. The fields are shown using
@@ -1268,7 +1521,7 @@
* @since 2.7.0
* @since 4.2.0 The `$class` argument was added.
*
- * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
+ * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections.
*
* @param string $id Slug-name to identify the field. Used in the 'id' attribute of tags.
* @param string $title Formatted title of the field. Shown as the label for the field
@@ -1289,13 +1542,16 @@
* field is output.
* }
*/
-function add_settings_field($id, $title, $callback, $page, $section = 'default', $args = array()) {
+function add_settings_field( $id, $title, $callback, $page, $section = 'default', $args = array() ) {
global $wp_settings_fields;
if ( 'misc' == $page ) {
- _deprecated_argument( __FUNCTION__, '3.0.0',
+ _deprecated_argument(
+ __FUNCTION__,
+ '3.0.0',
/* translators: %s: misc */
- sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ),
+ sprintf(
+ __( 'The "%s" options group has been removed. Use another settings group.' ),
'misc'
)
);
@@ -1303,16 +1559,24 @@
}
if ( 'privacy' == $page ) {
- _deprecated_argument( __FUNCTION__, '3.5.0',
+ _deprecated_argument(
+ __FUNCTION__,
+ '3.5.0',
/* translators: %s: privacy */
- sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ),
+ sprintf(
+ __( 'The "%s" options group has been removed. Use another settings group.' ),
'privacy'
)
);
$page = 'reading';
}
- $wp_settings_fields[$page][$section][$id] = array('id' => $id, 'title' => $title, 'callback' => $callback, 'args' => $args);
+ $wp_settings_fields[ $page ][ $section ][ $id ] = array(
+ 'id' => $id,
+ 'title' => $title,
+ 'callback' => $callback,
+ 'args' => $args,
+ );
}
/**
@@ -1322,54 +1586,59 @@
* to output all the sections and fields that were added to that $page with
* add_settings_section() and add_settings_field()
*
- * @global $wp_settings_sections Storage array of all settings sections added to admin pages
- * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
+ * @global $wp_settings_sections Storage array of all settings sections added to admin pages.
+ * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections.
* @since 2.7.0
*
- * @param string $page The slug name of the page whose settings sections you want to output
+ * @param string $page The slug name of the page whose settings sections you want to output.
*/
function do_settings_sections( $page ) {
global $wp_settings_sections, $wp_settings_fields;
- if ( ! isset( $wp_settings_sections[$page] ) )
+ if ( ! isset( $wp_settings_sections[ $page ] ) ) {
return;
+ }
- foreach ( (array) $wp_settings_sections[$page] as $section ) {
- if ( $section['title'] )
+ foreach ( (array) $wp_settings_sections[ $page ] as $section ) {
+ if ( $section['title'] ) {
echo "
';
}
}
/**
- * Print out the settings fields for a particular settings section
+ * Print out the settings fields for a particular settings section.
*
* Part of the Settings API. Use this in a settings page to output
* a specific section. Should normally be called by do_settings_sections()
* rather than directly.
*
- * @global $wp_settings_fields Storage array of settings fields and their pages/sections
+ * @global $wp_settings_fields Storage array of settings fields and their pages/sections.
*
* @since 2.7.0
*
- * @param string $page Slug title of the admin page who's settings fields you want to show.
- * @param string $section Slug title of the settings section who's fields you want to show.
+ * @param string $page Slug title of the admin page whose settings fields you want to show.
+ * @param string $section Slug title of the settings section whose fields you want to show.
*/
-function do_settings_fields($page, $section) {
+function do_settings_fields( $page, $section ) {
global $wp_settings_fields;
- if ( ! isset( $wp_settings_fields[$page][$section] ) )
+ if ( ! isset( $wp_settings_fields[ $page ][ $section ] ) ) {
return;
+ }
- foreach ( (array) $wp_settings_fields[$page][$section] as $field ) {
+ foreach ( (array) $wp_settings_fields[ $page ][ $section ] as $field ) {
$class = '';
if ( ! empty( $field['args']['class'] ) ) {
@@ -1385,14 +1654,14 @@
}
echo '
';
echo '';
}
}
/**
- * Register a settings error to be displayed to the user
+ * Register a settings error to be displayed to the user.
*
* Part of the Settings API. Use this to show messages to users about settings validation
* problems, missing settings or anything else.
@@ -1408,7 +1677,7 @@
*
* @global array $wp_settings_errors Storage array of errors registered during this pageload
*
- * @param string $setting Slug title of the setting to which this error applies
+ * @param string $setting Slug title of the setting to which this error applies.
* @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
* @param string $message The formatted message text to display to the user (will be shown inside styled
* `
` and `
` tags).
@@ -1422,12 +1691,12 @@
'setting' => $setting,
'code' => $code,
'message' => $message,
- 'type' => $type
+ 'type' => $type,
);
}
/**
- * Fetch settings errors registered by add_settings_error()
+ * Fetch settings errors registered by add_settings_error().
*
* Checks the $wp_settings_errors array for any errors declared during the current
* pageload and returns them.
@@ -1445,9 +1714,9 @@
*
* @global array $wp_settings_errors Storage array of errors registered during this pageload
*
- * @param string $setting Optional slug title of a specific setting who's errors you want.
+ * @param string $setting Optional slug title of a specific setting whose errors you want.
* @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
- * @return array Array of settings errors
+ * @return array Array of settings errors.
*/
function get_settings_errors( $setting = '', $sanitize = false ) {
global $wp_settings_errors;
@@ -1457,8 +1726,9 @@
* This allows the $sanitize_callback from register_setting() to run, adding
* any settings errors you want to show by default.
*/
- if ( $sanitize )
+ if ( $sanitize ) {
sanitize_option( $setting, get_option( $setting ) );
+ }
// If settings were passed back from options.php then use them.
if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] && get_transient( 'settings_errors' ) ) {
@@ -1475,8 +1745,9 @@
if ( $setting ) {
$setting_errors = array();
foreach ( (array) $wp_settings_errors as $key => $details ) {
- if ( $setting == $details['setting'] )
- $setting_errors[] = $wp_settings_errors[$key];
+ if ( $setting == $details['setting'] ) {
+ $setting_errors[] = $wp_settings_errors[ $key ];
+ }
}
return $setting_errors;
}
@@ -1506,28 +1777,30 @@
*
* @since 3.0.0
*
- * @param string $setting Optional slug title of a specific setting who's errors you want.
+ * @param string $setting Optional slug title of a specific setting whose errors you want.
* @param bool $sanitize Whether to re-sanitize the setting value before returning errors.
* @param bool $hide_on_update If set to true errors will not be shown if the settings page has
* already been submitted.
*/
function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) {
- if ( $hide_on_update && ! empty( $_GET['settings-updated'] ) )
+ if ( $hide_on_update && ! empty( $_GET['settings-updated'] ) ) {
return;
+ }
$settings_errors = get_settings_errors( $setting, $sanitize );
- if ( empty( $settings_errors ) )
+ if ( empty( $settings_errors ) ) {
return;
+ }
$output = '';
foreach ( $settings_errors as $key => $details ) {
- $css_id = 'setting-error-' . $details['code'];
+ $css_id = 'setting-error-' . $details['code'];
$css_class = $details['type'] . ' settings-error notice is-dismissible';
- $output .= "