WPSEO_Customizer{} │ Yoast 1.0

Class with functionality to support WP SEO settings in WordPress Customizer.

Хуков нет.

Использование

$WPSEO_Customizer = new WPSEO_Customizer();
// use class methods

Методы

1. public __construct()
2. private add_setting_and_control( $index, $control_args, $id = null, $custom_settings = [] )
3. private breadcrumbs_404_setting()
4. public breadcrumbs_active_callback()
5. private breadcrumbs_archiveprefix_setting()
6. public breadcrumbs_blog_show_active_cb()
7. private breadcrumbs_blog_show_setting()
8. private breadcrumbs_home_setting()
9. private breadcrumbs_prefix_setting()
10. private breadcrumbs_searchprefix_setting()
11. private breadcrumbs_section()
12. private breadcrumbs_separator_setting()
13. public wpseo_customize_register( $wp_customize )

Код WPSEO_Customizer{} WPSEO Customizer{} ^{Yoast 22.4}

class WPSEO_Customizer {

	/**
	 * Holds the customize manager.
	 *
	 * @var WP_Customize_Manager
	 */
	protected $wp_customize;

	/**
	 * Template for the setting IDs used for the customizer.
	 *
	 * @var string
	 */
	private $setting_template = 'wpseo_titles[%s]';

	/**
	 * Default arguments for the breadcrumbs customizer settings object.
	 *
	 * @var array
	 */
	private $default_setting_args = [
		'default'   => '',
		'type'      => 'option',
		'transport' => 'refresh',
	];

	/**
	 * Default arguments for the breadcrumbs customizer control object.
	 *
	 * @var array
	 */
	private $default_control_args = [
		'label'    => '',
		'type'     => 'text',
		'section'  => 'wpseo_breadcrumbs_customizer_section',
		'settings' => '',
		'context'  => '',
	];

	/**
	 * Construct Method.
	 */
	public function __construct() {
		add_action( 'customize_register', [ $this, 'wpseo_customize_register' ] );
	}

	/**
	 * Function to support WordPress Customizer.
	 *
	 * @param WP_Customize_Manager $wp_customize Manager class instance.
	 *
	 * @return void
	 */
	public function wpseo_customize_register( $wp_customize ) {
		if ( ! WPSEO_Capability_Utils::current_user_can( 'wpseo_manage_options' ) ) {
			return;
		}

		$this->wp_customize = $wp_customize;

		$this->breadcrumbs_section();
		$this->breadcrumbs_blog_show_setting();
		$this->breadcrumbs_separator_setting();
		$this->breadcrumbs_home_setting();
		$this->breadcrumbs_prefix_setting();
		$this->breadcrumbs_archiveprefix_setting();
		$this->breadcrumbs_searchprefix_setting();
		$this->breadcrumbs_404_setting();
	}

	/**
	 * Add the breadcrumbs section to the customizer.
	 *
	 * @return void
	 */
	private function breadcrumbs_section() {
		$section_args = [
			/* translators: %s is the name of the plugin */
			'title'           => sprintf( __( '%s Breadcrumbs', 'wordpress-seo' ), 'Yoast SEO' ),
			'priority'        => 999,
			'active_callback' => [ $this, 'breadcrumbs_active_callback' ],
		];

		$this->wp_customize->add_section( 'wpseo_breadcrumbs_customizer_section', $section_args );
	}

	/**
	 * Returns whether or not the breadcrumbs are active.
	 *
	 * @return bool
	 */
	public function breadcrumbs_active_callback() {
		return current_theme_supports( 'yoast-seo-breadcrumbs' ) || WPSEO_Options::get( 'breadcrumbs-enable' );
	}

	/**
	 * Adds the breadcrumbs show blog checkbox.
	 *
	 * @return void
	 */
	private function breadcrumbs_blog_show_setting() {
		$index        = 'breadcrumbs-display-blog-page';
		$control_args = [
			'label'           => __( 'Show blog page in breadcrumbs', 'wordpress-seo' ),
			'type'            => 'checkbox',
			'active_callback' => [ $this, 'breadcrumbs_blog_show_active_cb' ],
		];

		$this->add_setting_and_control( $index, $control_args );
	}

	/**
	 * Returns whether or not to show the breadcrumbs blog show option.
	 *
	 * @return bool
	 */
	public function breadcrumbs_blog_show_active_cb() {
		return get_option( 'show_on_front' ) === 'page';
	}

	/**
	 * Adds the breadcrumbs separator text field.
	 *
	 * @return void
	 */
	private function breadcrumbs_separator_setting() {
		$index        = 'breadcrumbs-sep';
		$control_args = [
			'label' => __( 'Breadcrumbs separator:', 'wordpress-seo' ),
		];
		$id           = 'wpseo-breadcrumbs-separator';

		$this->add_setting_and_control( $index, $control_args, $id );
	}

	/**
	 * Adds the breadcrumbs home anchor text field.
	 *
	 * @return void
	 */
	private function breadcrumbs_home_setting() {
		$index        = 'breadcrumbs-home';
		$control_args = [
			'label' => __( 'Anchor text for the homepage:', 'wordpress-seo' ),
		];

		$this->add_setting_and_control( $index, $control_args );
	}

	/**
	 * Adds the breadcrumbs prefix text field.
	 *
	 * @return void
	 */
	private function breadcrumbs_prefix_setting() {
		$index        = 'breadcrumbs-prefix';
		$control_args = [
			'label' => __( 'Prefix for breadcrumbs:', 'wordpress-seo' ),
		];

		$this->add_setting_and_control( $index, $control_args );
	}

	/**
	 * Adds the breadcrumbs archive prefix text field.
	 *
	 * @return void
	 */
	private function breadcrumbs_archiveprefix_setting() {
		$index        = 'breadcrumbs-archiveprefix';
		$control_args = [
			'label' => __( 'Prefix for archive pages:', 'wordpress-seo' ),
		];

		$this->add_setting_and_control( $index, $control_args );
	}

	/**
	 * Adds the breadcrumbs search prefix text field.
	 *
	 * @return void
	 */
	private function breadcrumbs_searchprefix_setting() {
		$index        = 'breadcrumbs-searchprefix';
		$control_args = [
			'label' => __( 'Prefix for search result pages:', 'wordpress-seo' ),
		];

		$this->add_setting_and_control( $index, $control_args );
	}

	/**
	 * Adds the breadcrumb 404 prefix text field.
	 *
	 * @return void
	 */
	private function breadcrumbs_404_setting() {
		$index        = 'breadcrumbs-404crumb';
		$control_args = [
			'label' => __( 'Breadcrumb for 404 pages:', 'wordpress-seo' ),
		];

		$this->add_setting_and_control( $index, $control_args );
	}

	/**
	 * Adds the customizer setting and control.
	 *
	 * @param string      $index           Array key index to use for the customizer setting.
	 * @param array       $control_args    Customizer control object arguments.
	 *                                     Only those different from the default need to be passed.
	 * @param string|null $id              Optional. Customizer control object ID.
	 *                                     Will default to 'wpseo-' . $index.
	 * @param array       $custom_settings Optional. Customizer setting arguments.
	 *                                     Only those different from the default need to be passed.
	 *
	 * @return void
	 */
	private function add_setting_and_control( $index, $control_args, $id = null, $custom_settings = [] ) {
		$setting                  = sprintf( $this->setting_template, $index );
		$control_args             = array_merge( $this->default_control_args, $control_args );
		$control_args['settings'] = $setting;

		$settings_args = $this->default_setting_args;
		if ( ! empty( $custom_settings ) ) {
			$settings_args = array_merge( $settings_args, $custom_settings );
		}

		if ( ! isset( $id ) ) {
			$id = 'wpseo-' . $index;
		}

		$this->wp_customize->add_setting( $setting, $settings_args );

		$control = new WP_Customize_Control( $this->wp_customize, $id, $control_args );
		$this->wp_customize->add_control( $control );
	}
}