add_setting_section( $section ); } // since PPF04 $this->maybe_register_setting(); } /** * add a single setting section * * @since PPF04 * @param array $sections setting section to add * @access public * @see add_settings() */ public function add_setting_section( $section ) { // as of PPF04 add sections to _sections array one by one $this->_sections[] = $section; if ( array_key_exists( 'fields', $section ) ) { $this->add_settings( $section ); } $this->maybe_register_setting(); } /** * register the setting * * @since PPF04 * @access private * * was part of add_setting_sections() before PPF04 */ public function maybe_register_setting() { if ( ! $this->_settings_registered ) { // Register the options // since PPF03 only if there is a settings class // so we can use the same function also if we don't need any settings if ( false !== $this->settings() ) { register_setting( $this->core()->get_plugin_slug(), $this->settings()->get_option_name(), array( 'sanitize_callback' => array( $this, 'sanitize_callback' ) ) ); } $this->_settings_registered = true; } } /** * helper function to add a complete setting section * * @since PPF01 * @param array $settings array of settings to add * string $section => ID of the section * int $order => sort order * this was added in PPF04, so we check if it exists for backwards compatibility * string $title => title for section (used by print_setting_sections()) * string $icon => icon for tab * since PPF05 * string $html => HTML code to add to this section * array $fields => multidimensional array of fields to add * string $key => key of the option array * string $callback => function to call * as of PPF04 this can be an array to enable external callbacks * array $callbackargs => array of arguments to pass to callback function * introduced in PPF08 * bool $nosubmit => this section should not show the submit button * @access private */ private function add_settings( $settings ) { $section_id = $this->core()->get_plugin_slug() . '-' . $settings['section']; add_settings_section( $section_id, '', null, $this->core()->get_plugin_slug() ); foreach ( $settings['fields'] as $field ) { $field_id = $this->core()->get_plugin_slug() . '-' . $field['key']; // since PPF04 if ( is_array( $field['callback'] ) ) { $callback = $field['callback']; } else { $callback = array( $this, $field['callback'] ); } $callbackargs = false; if ( isset( $field['callbackargs'] ) && is_array( $field['callbackargs'] ) ) { $callbackargs = $field['callbackargs']; } add_settings_field( $field_id, '' , $callback, $this->core()->get_plugin_slug(), $section_id, $callbackargs ); } return; } /** * helper function to print out a slider styled checkbox * * @since PPF01 * @param string $key option key name * @param string $title title * @param string $help anchor to link to in manual * @param string $video YouTube video ID * @param string $note second line * @param bool $disabled true/false (optional) * @access public */ public function print_slider_check( $key, $title, $help, $video, $note, $disabled = false ) { $dis = ''; if ( $disabled ) { $dis = ' disabled="disabled"'; } $hlp = ''; if ( ! empty( $help ) ) { $hlp = $this->add_manual_link( $help ); } $vid = ''; if ( ! empty( $video ) ) { $vid = $this->add_video_link( $video ); } $add = ''; if ( ! empty( $note ) ) { $add = '
' . $note; } echo '

settings()->get( $key ), false ) . $dis . ' />' . $title . $hlp . $vid . $add . '

'; } /** * helper function to add a plugin manual link * * @since PPF01 * @param string $anchor name of the anchor to link to * @return string * @access private */ private function add_manual_link( $anchor = '' ) { return ' '; } /** * helper function to add a video link * * @since PPF01 * @param string $youtubeid ID of the YouTube video * @return string * @access private */ private function add_video_link( $youtubeid = '' ) { return ' '; } /** * print out setting sections * it is not possible to use do_settings_sections() because we are not able to create a tabbed interface * * @since PPF01 * @access public * @see add_settings() */ public function print_setting_sections() { $currentclass = ' current'; foreach( $this->_sections as $section ) { $section_id = $this->core()->get_plugin_slug() . '-' . $section['section']; $extraclass = ''; if ( array_key_exists( 'nosubmit', $section ) && true === $section['nosubmit'] ) { $extraclass = ' nosubmit'; } echo '
'; if ( array_key_exists( 'html', $section ) ) { echo '
'; echo $section['html']; echo '
'; } if ( array_key_exists( 'fields', $section ) ) { echo ''; do_settings_fields( $this->core()->get_plugin_slug(), $section_id ); echo '
'; } echo '
'; $currentclass = ''; } } /** * print out setting sections navigation * * @since PPF01 * @access public * @see add_settings() */ public function print_setting_sections_nav() { $currentclass = ' current'; echo ''; } /** * sanitize the posted values * * @since PPF01 * @param array $settings array of settings to save * @access public */ public function sanitize_callback( $settings ) { // since PPF06 // if wen don't get anything we need to create an empty array if ( empty( $settings ) ) { $settings = array(); } foreach ( $this->settings()->get_defaults() as $key => $value ) { if ( true === is_bool( $value ) ) { if ( ! array_key_exists( $key, $settings ) ) { // we have to add the missing keys // HTML forms only send data if a checkbox is checked // missing keys would be overwritten with their default on next load // this concerns only boolean values // if key does not exist the checkbox was not checked // so we have to handle it as false $settings[$key] = false; } else { // also we check if a given value is boolean // otherwise we reset it to false // this is for security // so it is not possible to pass non boolean values // if a checkbox was checked we get 1 // so we only have to check for 1 if ( 1 != $settings[$key] ) { $settings[$key] = false; } } } } // it is not possible to do other sanitation because we do not know what to do // more sanitation has to be done by the plugin itself return $this->sanitize_settings( $settings ); } /** * sanitize the settings * called by sanitize_callback() * this can be used to sanitize the settings after missing keys have been added * * @since PPF01 * @param array $settings array of settings to save * @access public */ public function sanitize_settings( $settings ) { return $settings; } /** * add toolbar icons * * @since PPF01 * @param array $icons array of icons to show in toolbar * string $link => URL to link to * string $title => title to show * string $icon => icon to use from dashicons * @access public */ public function add_toolbar_icons( $icons ) { $this->_toolbar = ''; } /** * show the admin page * * @since PPF01 * @param string $capability minimum required capability to show page (optional) * @access public */ public function show( $capability = 'read' ) { if ( !current_user_can( $capability ) ) { wp_die( esc_html__( 'You do not have sufficient permissions to access this page.' ) ); } // sort the sections // see add_settings() $sort = false; foreach( $this->_sections as $section ) { if ( array_key_exists( 'order', $section ) ) { $sort = true; break; } } if ( $sort ) { usort( $this->_sections, function( $a, $b ) { return $a['order'] - $b['order']; } ); } // end of sort if ( get_current_screen()->parent_base != 'options-general' ) { // On Option Screens settings_errors() is called automatically settings_errors(); } echo '
'; echo '
'; echo $this->_toolbar; echo '

' . $this->core()->get_plugin_shortname() . '

'; echo '
'; $this->print_setting_sections_nav(); echo '
'; echo '
'; echo '
'; settings_fields( $this->core()->get_plugin_slug() ); $this->print_setting_sections(); submit_button(); echo '
'; echo '

Need help? Get Support.

'; echo '

⭐ Love 404 Page? Please rate it 5-stars on WordPress.org. Thank you!

'; echo '

Maintained with ❤️ and ☕ by NerdPress.

'; echo ''; wp_enqueue_style( $this->core()->get_plugin_slug() . '-ppf03', $this->get_foundation_asset_url( 'css', 'pp-admin-page.css' ) ); wp_enqueue_script( $this->core()->get_plugin_slug() . '-ppf03-cookie', $this->get_foundation_asset_url( 'js', 'jquery.cookie.js' ), array( 'jquery' ), false, true ); wp_enqueue_script( $this->core()->get_plugin_slug() . '-ppf03', $this->get_foundation_asset_url( 'js', 'pp-admin-page.js' ), array( 'jquery', $this->core()->get_plugin_slug() . '-ppf03-cookie' ), false, true ); } /** * set screen id * * @since PPF01 * @param string $id id of screen * @access public */ public function set_screen_id( $id ) { $this->_my_screen_id = $id; } /** * get screen id * * @since PPF01 * @return string * @access public */ public function get_screen_id() { return $this->_my_screen_id; } /** * show admin notice to ask for rating * this function does not show the notice immediately * this function just needs to be called and it takes care of everything * * @since PPF01 * @param array $content array of texts to show * string $title => e.g. 'Are you happy with the example plugin?' * string $subtitle => e.g. 'You've been using this plugin for a while now. Would be great to get some feedback!' * string $button_yes => e.g. 'Yes, I'm happy with it' * string $button_no => e.g. 'Not really' * string $button_later => e.g. 'Ask me later' * string $button_close => e.g. 'Never show again' * string $like => e.g. 'I'm really glad you like it. I do not ask for a donation. All I'm asking you for is to give it a good rating. Thank you very much. * string $button_rate => e.g. 'Yes, I'd like to rate it' * string $dislike => e.g. 'I'm really sorry you don't like it. Would you please do me a favor and drop me line, why you are not happy with it? Maybe I can do better...' * string $button_contact => e.g. 'Yes sure' * @param array $links array of links * string $rate => e.g. https://wordpress.org/support/plugin/example/reviews/ * string $contact => e.g. https://petersplugins.com/contact/ * @access public */ public function init_rating_notice( $content, $links ) { // quit immediately if message has already been closed if ( 'YES' == $this->core()->data_get( 'ask_rating_closed' ) ) { return; } $show_notice_start = $this->core()->data_get( 'ask_rating_start' ); // if start date is not set, set it and quit immediately if ( false === $show_notice_start ) { $this->core()->data_set( 'ask_rating_start', time() + 30 * DAY_IN_SECONDS ); $this->core()->data_save(); return; } // quit immediately if start date is not reached yet if ( time() < $show_notice_start ) { return; } // quit immediately if current user is not an admin if ( ! current_user_can( 'manage_options' ) ) { return; } $prefix = 'pp-' . $this->core()->get_plugin_slug(); $nonce = wp_create_nonce( $prefix ); // prepare to show notice add_action( 'admin_notices', function() use( $content, $links, $prefix, $nonce ) { // show notice only on certain pages // it's not possible to check this earlier, because we need the id of the current screen for that if ( ! in_array( get_current_screen()->id, array( 'dashboard', 'themes', 'plugins', 'options-general' , $this->get_screen_id() ) ) ) { return; } ?>

id, array( 'dashboard', 'themes', 'plugins', 'options-general' , $this->get_screen_id() ) ) ) { return; } echo ' '; } ); // prepare for ajax add_action( 'wp_ajax_' . $prefix . '-review-action', function() use( $prefix ) { check_ajax_referer( $prefix, 'securekey' ); // dies if check fails if ( isset( $_POST['command'] ) ) { if ( $prefix . '-review-later' == $_POST['command'] ) { // move start date 14 days into future $this->core()->data_set( 'ask_rating_start', time() + 14 * DAY_IN_SECONDS ); $this->core()->data_save(); } if ( $prefix . '-review-close' == $_POST['command'] ) { // do not show notice again $this->core()->data_set( 'ask_rating_closed', 'YES' ); $this->core()->data_save(); } } wp_die(); } ); } } }