WPSEO_Taxonomy_Metabox

This class generates the metabox on the edit term page.

Defined (1)

The class is defined in the following location(s).

/admin/taxonomy/class-taxonomy-metabox.php  
  1. class WPSEO_Taxonomy_Metabox { 
  2.  
  3.     /** 
  4.      * @var stdClass 
  5.      */ 
  6.     private $term; 
  7.  
  8.     /** 
  9.      * @var string 
  10.      */ 
  11.     private $taxonomy; 
  12.  
  13.     /** 
  14.      * @var WPSEO_Taxonomy_Fields_Presenter 
  15.      */ 
  16.     private $taxonomy_tab_content; 
  17.  
  18.     /** 
  19.      * The constructor. 
  20.      * 
  21.      * @param string   $taxonomy The taxonomy. 
  22.      * @param stdClass $term     The term. 
  23.      */ 
  24.     public function __construct( $taxonomy, $term ) { 
  25.         $this->term = $term; 
  26.         $this->taxonomy = $taxonomy; 
  27.         $this->taxonomy_tab_content = new WPSEO_Taxonomy_Fields_Presenter( $this->term ); 
  28.  
  29.         add_action( 'admin_footer', array( $this, 'template_generic_tab' ) ); 
  30.         add_action( 'admin_footer', array( $this, 'template_keyword_tab' ) ); 
  31.     } 
  32.  
  33.     /** 
  34.      * Shows the Yoast SEO metabox for the term. 
  35.      */ 
  36.     public function display() { 
  37.  
  38.         $content_sections = $this->get_content_sections(); 
  39.  
  40.         $product_title = 'Yoast SEO'; 
  41.         if ( file_exists( WPSEO_PATH . 'premium/' ) ) { 
  42.             $product_title .= ' Premium'; 
  43.         } 
  44.  
  45.         printf( '<div id="wpseo_meta" class="postbox yoast wpseo-taxonomy-metabox-postbox"><h2><span>%1$s</span></h2>', $product_title ); 
  46.  
  47.         echo '<div class="inside">'; 
  48.  
  49.         $helpcenter_tab = new WPSEO_Option_Tab( 'tax-metabox', 'Meta box',  
  50.             array( 'video_url' => 'https://yoa.st/metabox-taxonomy-screencast' ) ); 
  51.  
  52.         $helpcenter = new WPSEO_Help_Center( 'tax-metabox', $helpcenter_tab ); 
  53.         $helpcenter->output_help_center(); 
  54.  
  55.         echo '<div id="taxonomy_overall"></div>'; 
  56.  
  57.         if ( ! defined( 'WPSEO_PREMIUM_FILE' ) ) { 
  58.             echo $this->get_buy_premium_link(); 
  59.         } 
  60.  
  61.         echo '<div class="wpseo-metabox-sidebar"><ul>'; 
  62.  
  63.         foreach ( $content_sections as $content_section ) { 
  64.             if ( $content_section->name === 'premium' ) { 
  65.                 continue; 
  66.             } 
  67.  
  68.             $content_section->display_link(); 
  69.         } 
  70.  
  71.         echo '</ul></div>'; 
  72.  
  73.         foreach ( $content_sections as $content_section ) { 
  74.             $content_section->display_content(); 
  75.         } 
  76.         echo '</div></div>'; 
  77.     } 
  78.  
  79.     /** 
  80.      * Returns the relevant metabox sections for the current view. 
  81.      * 
  82.      * @return WPSEO_Metabox_Section[] 
  83.      */ 
  84.     private function get_content_sections() { 
  85.         $content_sections = array( 
  86.             $this->get_content_meta_section(),  
  87.             $this->get_social_meta_section(),  
  88.             $this->get_settings_meta_section(),  
  89.  ); 
  90.  
  91.         if ( ! defined( 'WPSEO_PREMIUM_FILE' ) ) { 
  92.             $content_sections[] = $this->get_buy_premium_section(); 
  93.         } 
  94.  
  95.         return $content_sections; 
  96.     } 
  97.  
  98.     /** 
  99.      * Returns the metabox section for the content analysis. 
  100.      * 
  101.      * @return WPSEO_Metabox_Section 
  102.      */ 
  103.     private function get_content_meta_section() { 
  104.         $taxonomy_content_fields = new WPSEO_Taxonomy_Content_Fields( $this->term ); 
  105.         $content = $this->taxonomy_tab_content->html( $taxonomy_content_fields->get() ); 
  106.  
  107.         $tab = new WPSEO_Metabox_Form_Tab( 
  108.             'content',  
  109.             $content,  
  110.             '',  
  111.             array( 
  112.                 'tab_class' => 'yoast-seo__remove-tab',  
  113.  ) 
  114.  ); 
  115.  
  116.         return new WPSEO_Metabox_Tab_Section( 
  117.             'content',  
  118.             '<span class="screen-reader-text">' . __( 'Content optimization', 'wordpress-seo' ) . '</span><span class="yst-traffic-light-container">' . $this->traffic_light_svg() . '</span>',  
  119.             array( $tab ),  
  120.             array( 
  121.                 'link_aria_label' => __( 'Content optimization', 'wordpress-seo' ),  
  122.                 'link_class' => 'yoast-tooltip yoast-tooltip-e',  
  123.  ) 
  124.  ); 
  125.     } 
  126.  
  127.     /** 
  128.      * Returns the metabox section for the settings. 
  129.      * 
  130.      * @return WPSEO_Metabox_Section 
  131.      */ 
  132.     private function get_settings_meta_section() { 
  133.         $taxonomy_settings_fields = new WPSEO_Taxonomy_Settings_Fields( $this->term ); 
  134.         $content = $this->taxonomy_tab_content->html( $taxonomy_settings_fields->get() ); 
  135.  
  136.         $tab = new WPSEO_Metabox_Form_Tab( 
  137.             'settings',  
  138.             $content,  
  139.             __( 'Settings', 'wordpress-seo' ),  
  140.             array( 
  141.                 'single' => true,  
  142.  ) 
  143.  ); 
  144.  
  145.         return new WPSEO_Metabox_Tab_Section( 
  146.             'settings',  
  147.             '<span class="screen-reader-text">' . __( 'Settings', 'wordpress-seo' ) . '</span><span class="dashicons dashicons-admin-generic"></span>',  
  148.             array( $tab ),  
  149.             array( 
  150.                 'link_aria_label' => __( 'Settings', 'wordpress-seo' ),  
  151.                 'link_class' => 'yoast-tooltip yoast-tooltip-e',  
  152.  ) 
  153.  ); 
  154.     } 
  155.  
  156.     /** 
  157.      * Returns the metabox section for the social settings. 
  158.      * 
  159.      * @return WPSEO_Metabox_Section 
  160.      */ 
  161.     private function get_social_meta_section() { 
  162.         $options = WPSEO_Options::get_option( 'wpseo_social' ); 
  163.         $taxonomy_social_fields = new WPSEO_Taxonomy_Social_Fields( $this->term ); 
  164.  
  165.         $tabs = array(); 
  166.         $single = true; 
  167.  
  168.         if ( $options['opengraph'] === true && $options['twitter'] === true ) { 
  169.             $single = null; 
  170.         } 
  171.  
  172.         if ( $options['opengraph'] === true ) { 
  173.             $facebook_meta_fields = $taxonomy_social_fields->get_by_network( 'opengraph' ); 
  174.  
  175.             $tabs[] = new WPSEO_Metabox_Form_Tab( 
  176.                 'facebook',  
  177.                 $this->taxonomy_tab_content->html( $facebook_meta_fields ),  
  178.                 '<span class="screen-reader-text">' . __( 'Facebook / Open Graph metadata', 'wordpress-seo' ) . '</span><span class="dashicons dashicons-facebook-alt"></span>',  
  179.                 array( 
  180.                     'link_aria_label' => __( 'Facebook / Open Graph metadata', 'wordpress-seo' ),  
  181.                     'link_class' => 'yoast-tooltip yoast-tooltip-se',  
  182.                     'single' => $single,  
  183.  ) 
  184.  ); 
  185.         } 
  186.  
  187.         if ( $options['twitter'] === true ) { 
  188.             $twitter_meta_fields = $taxonomy_social_fields->get_by_network( 'twitter' ); 
  189.  
  190.             $tabs[] = new WPSEO_Metabox_Form_Tab( 
  191.                 'twitter',  
  192.                 $this->taxonomy_tab_content->html( $twitter_meta_fields ),  
  193.                 '<span class="screen-reader-text">' . __( 'Twitter metadata', 'wordpress-seo' ) . '</span><span class="dashicons dashicons-twitter"></span>',  
  194.                 array( 
  195.                     'link_aria_label' => __( 'Twitter metadata', 'wordpress-seo' ),  
  196.                     'link_class' => 'yoast-tooltip yoast-tooltip-se',  
  197.                     'single' => $single,  
  198.  ) 
  199.  ); 
  200.         } 
  201.  
  202.         return new WPSEO_Metabox_Tab_Section( 
  203.             'social',  
  204.             '<span class="screen-reader-text">' . __( 'Social', 'wordpress-seo' ) . '</span><span class="dashicons dashicons-share"></span>',  
  205.             $tabs,  
  206.             array( 
  207.                 'link_aria_label' => __( 'Social', 'wordpress-seo' ),  
  208.                 'link_class' => 'yoast-tooltip yoast-tooltip-e',  
  209.  ) 
  210.  ); 
  211.     } 
  212.  
  213.     /** 
  214.      * Returns a link to activate the Buy Premium tab. 
  215.      * 
  216.      * @return string 
  217.      */ 
  218.     private function get_buy_premium_link() { 
  219.         return sprintf( "<div class='%s'><a href='#wpseo-meta-section-premium' class='wpseo-meta-section-link'><span class='dashicons dashicons-star-filled wpseo-buy-premium'></span>%s</a></div>",  
  220.             'wpseo-metabox-buy-premium',  
  221.             __( 'Go Premium', 'wordpress-seo' ) 
  222.  ); 
  223.     } 
  224.  
  225.     /** 
  226.      * Returns the metabox section for the Premium section.. 
  227.      * 
  228.      * @return WPSEO_Metabox_Section 
  229.      */ 
  230.     private function get_buy_premium_section() { 
  231.         $content = sprintf( "<div class='wpseo-metabox-premium-description'> 
  232.             %s 
  233.             <ul class='wpseo-metabox-premium-advantages'> 
  234.                 <li> 
  235.                     <strong>%s</strong> - %s 
  236.                 </li> 
  237.                 <li> 
  238.                     <strong>%s</strong> - %s 
  239.                 </li> 
  240.                 <li> 
  241.                     <strong>%s</strong> - %s 
  242.                 </li> 
  243.                 <li> 
  244.                     <strong>%s</strong> - %s 
  245.                 </li> 
  246.             </ul> 
  247.  
  248.             <a target='_blank' id='wpseo-buy-premium-popup-button' class='button button-buy-premium wpseo-metabox-go-to' href='%s'> 
  249.                 %s 
  250.             </a> 
  251.  
  252.             <p><a target='_blank' class='wpseo-metabox-go-to' href='%s'>%s</a></p> 
  253.         </div>",  
  254.             /** translators: %1$s expands to Yoast SEO Premium. */ 
  255.             sprintf( __( 'You\'re not getting the benefits of %1$s yet. If you had %1$s, you could use its awesome features:', 'wordpress-seo' ), 'Yoast SEO Premium' ),  
  256.             __( 'Redirect manager', 'wordpress-seo' ),  
  257.             __( 'Create and manage redirects within your WordPress install.', 'wordpress-seo' ),  
  258.             __( 'Multiple focus keywords', 'wordpress-seo' ),  
  259.             __( 'Optimize a single post for up to 5 keywords.', 'wordpress-seo' ),  
  260.             __( 'Social Previews', 'wordpress-seo' ),  
  261.             __( 'Check what your Facebook or Twitter post will look like.', 'wordpress-seo' ),  
  262.             __( 'Premium support', 'wordpress-seo' ),  
  263.             __( 'Gain access to our 24/7 support team.', 'wordpress-seo' ),  
  264.             WPSEO_Shortlinker::get( 'https://yoa.st/pe-buy-premium' ),  
  265.             /** translators: %s expands to Yoast SEO Premium. */ 
  266.             sprintf( __( 'Get %s now!', 'wordpress-seo' ), 'Yoast SEO Premium' ),  
  267.             WPSEO_Shortlinker::get( 'https://yoa.st/pe-premium-page' ),  
  268.             __( 'More info', 'wordpress-seo' ) 
  269.  ); 
  270.  
  271.         $tab = new WPSEO_Metabox_Form_Tab( 
  272.             'premium',  
  273.             $content,  
  274.             'Yoast SEO Premium',  
  275.             array( 
  276.                 'single' => true,  
  277.  ) 
  278.  ); 
  279.  
  280.         return new WPSEO_Metabox_Tab_Section( 
  281.             'premium',  
  282.             '<span class="dashicons dashicons-star-filled wpseo-buy-premium"></span>',  
  283.             array( $tab ),  
  284.             array( 
  285.                 'link_aria_label' => 'Yoast SEO Premium',  
  286.                 'link_class' => 'yoast-tooltip yoast-tooltip-e',  
  287.  ) 
  288.  ); 
  289.     } 
  290.  
  291.     /** 
  292.      * Test whether we are on a public taxonomy - no metabox actions needed if we are not 
  293.      * Unfortunately we have to hook most everything in before the point where all taxonomies are registered and 
  294.      * we know which taxonomy is being requested, so we need to use this check in nearly every hooked in function. 
  295.      * 
  296.      * @since 1.5.0 
  297.      */ 
  298.     private function tax_is_public() { 
  299.         // Don't make static as taxonomies may still be added during the run. 
  300.         $taxonomy = get_taxonomy( $this->taxonomy ); 
  301.  
  302.         return $taxonomy->public; 
  303.     } 
  304.  
  305.     /** 
  306.      * Return the SVG for the traffic light in the metabox. 
  307.      */ 
  308.     public function traffic_light_svg() { 
  309.         return <<<SVG 
  310. <svg class="yst-traffic-light init" version="1.1" xmlns:x="&ns_extend;" xmlns:i="&ns_ai;" xmlns:graph="&ns_graphs;" 
  311.      xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:a="http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/" 
  312.      x="0px" y="0px" viewBox="0 0 30 47" enable-background="new 0 0 30 47" xml:space="preserve"> 
  313. <g id="BG_1_"> 
  314. </g> 
  315. <g id="traffic_light"> 
  316.     <g> 
  317.         <g> 
  318.             <g> 
  319.                 <path fill="#5B2942" d="M22, 0H8C3.6, 0, 0, 3.6, 0, 7.9v31.1C0, 43.4, 3.6, 47, 8, 47h14c4.4, 0, 8-3.6, 8-7.9V7.9C30, 3.6, 26.4, 0, 22, 0z 
  320.                      M27.5, 38.8c0, 3.1-2.6, 5.7-5.8, 5.7H8.3c-3.2, 0-5.8-2.5-5.8-5.7V8.3c0-1.5, 0.6-2.9, 1.7-4c1.1-1, 2.5-1.6, 4.1-1.6h13.4 
  321.                     c1.5, 0, 3, 0.6, 4.1, 1.6c1.1, 1.1, 1.7, 2.5, 1.7, 4V38.8z"/> 
  322.             </g> 
  323.             <g class="traffic-light-color traffic-light-red"> 
  324.                 <ellipse fill="#C8C8C8" cx="15" cy="23.5" rx="5.7" ry="5.6"/> 
  325.                 <ellipse fill="#DC3232" cx="15" cy="10.9" rx="5.7" ry="5.6"/> 
  326.                 <ellipse fill="#C8C8C8" cx="15" cy="36.1" rx="5.7" ry="5.6"/> 
  327.             </g> 
  328.             <g class="traffic-light-color traffic-light-orange"> 
  329.                 <ellipse fill="#F49A00" cx="15" cy="23.5" rx="5.7" ry="5.6"/> 
  330.                 <ellipse fill="#C8C8C8" cx="15" cy="10.9" rx="5.7" ry="5.6"/> 
  331.                 <ellipse fill="#C8C8C8" cx="15" cy="36.1" rx="5.7" ry="5.6"/> 
  332.             </g> 
  333.             <g class="traffic-light-color traffic-light-green"> 
  334.                 <ellipse fill="#C8C8C8" cx="15" cy="23.5" rx="5.7" ry="5.6"/> 
  335.                 <ellipse fill="#C8C8C8" cx="15" cy="10.9" rx="5.7" ry="5.6"/> 
  336.                 <ellipse fill="#63B22B" cx="15" cy="36.1" rx="5.7" ry="5.6"/> 
  337.             </g> 
  338.             <g class="traffic-light-color traffic-light-empty"> 
  339.                 <ellipse fill="#C8C8C8" cx="15" cy="23.5" rx="5.7" ry="5.6"/> 
  340.                 <ellipse fill="#C8C8C8" cx="15" cy="10.9" rx="5.7" ry="5.6"/> 
  341.                 <ellipse fill="#C8C8C8" cx="15" cy="36.1" rx="5.7" ry="5.6"/> 
  342.             </g> 
  343.             <g class="traffic-light-color traffic-light-init"> 
  344.                 <ellipse fill="#5B2942" cx="15" cy="23.5" rx="5.7" ry="5.6"/> 
  345.                 <ellipse fill="#5B2942" cx="15" cy="10.9" rx="5.7" ry="5.6"/> 
  346.                 <ellipse fill="#5B2942" cx="15" cy="36.1" rx="5.7" ry="5.6"/> 
  347.             </g> 
  348.         </g> 
  349.     </g> 
  350. </g> 
  351. </svg> 
  352. SVG; 
  353.     } 
  354.  
  355.     /** 
  356.      * Generic tab. 
  357.      */ 
  358.     public function template_generic_tab() { 
  359.         // This template belongs to the post scraper so don't echo it if it isn't enqueued. 
  360.         if ( ! wp_script_is( WPSEO_Admin_Asset_Manager::PREFIX . 'term-scraper' ) ) { 
  361.             return; 
  362.         } 
  363.  
  364.         echo '<script type="text/html" id="tmpl-generic_tab"> 
  365.                 <li class="<# if ( data.classes ) { #>{{data.classes}}<# } #><# if ( data.active ) { #> active<# } #>"> 
  366.                     <a class="wpseo_tablink" href="#wpseo_generic" data-score="{{data.score}}"> 
  367.                         <span class="wpseo-score-icon {{data.score}}"></span> 
  368.                         <span class="wpseo-tab-prefix">{{data.prefix}}</span> 
  369.                         <span class="wpseo-tab-label">{{data.label}}</span> 
  370.                         <span class="screen-reader-text wpseo-generic-tab-textual-score">{{data.scoreText}}</span> 
  371.                     </a> 
  372.                     <# if ( data.hideable ) { #> 
  373.                         <button type="button" class="remove-tab" aria-label="{{data.removeLabel}}"><span>x</span></button> 
  374.                     <# } #> 
  375.                 </li> 
  376.             </script>'; 
  377.     } 
  378.  
  379.     /** 
  380.      * Keyword tab for enabling analysis of multiple keywords. 
  381.      */ 
  382.     public function template_keyword_tab() { 
  383.         // This template belongs to the term scraper so don't echo it if it isn't enqueued. 
  384.         if ( ! wp_script_is( WPSEO_Admin_Asset_Manager::PREFIX . 'term-scraper' ) ) { 
  385.             return; 
  386.         } 
  387.  
  388.         echo '<script type="text/html" id="tmpl-keyword_tab"> 
  389.                 <li class="<# if ( data.classes ) { #>{{data.classes}}<# } #><# if ( data.active ) { #> active<# } #>"> 
  390.                     <a class="wpseo_tablink" href="#wpseo_content" data-keyword="{{data.keyword}}" data-score="{{data.score}}"> 
  391.                         <span class="wpseo-score-icon {{data.score}}"></span> 
  392.                         <span class="wpseo-tab-prefix">{{data.prefix}}</span> 
  393.                         <em class="wpseo-keyword">{{data.label}}</em> 
  394.                         <span class="screen-reader-text wpseo-keyword-tab-textual-score">{{data.scoreText}}</span> 
  395.                     </a> 
  396.                     <# if ( data.hideable ) { #> 
  397.                         <button type="button" class="remove-keyword" aria-label="{{data.removeLabel}}"><span>x</span></button> 
  398.                     <# } #> 
  399.                 </li> 
  400.             </script>'; 
  401.     } 
  402. }